此文注重梳理官方文档和整合实际开发的业务场景进行分析,巩固基础。
首先,Flutter中是否有GSON / Jackson / Moshi?官方文档明确表明--没有!且是禁用的,因为这些工具使用了反射机制,反射会默认使用Dark所有代码,让tree shaking会很难工作,运用文档所说的:
使用 dart:convert手动序列化JSON
使用工具:Flutter有一个内置dart:convert库
关键代码:
- User.fromJson 构造函数, 用于从一个map构造出一个 User实例 map structure
- toJson 方法, 将 User 实例转化为一个map.
解析代码:
import 'dart:convert';
import 'package:flutter_test/flutter_test.dart';
class User {
final String name;
final String password;
User(this.name, this.password);
User.fromJson(Map<String, dynamic> json)
: name = json['name'],
password = json['password'];
Map<String, dynamic> toJson() => {
'name': name,
'password': password,
};
}
String jsonStr = "{\"name\": \"Hank\",\"password\": \"123456\"}";//解析数据
void main() {
test('json test', () {
Map userMap = json.decode(jsonStr);
var user = new User.fromJson(userMap);
print('name, ${user.name}!');
print('password, ${user.password}.');
print('user json, ${user.toJson()}.');
});
}
使用代码生成库序列化JSON
使用了json_serializable package包,它是一个自动化的源代码生成器。
pubspec.yaml
dependencies:
# Your other regular dependencies here
json_annotation: ^2.0.0
dev_dependencies:
# Your other dev_dependencies here
build_runner: ^1.0.0
json_serializable: ^2.0.0
注意,yaml配置文件对于缩进要求十分严格,下面的build_runner和json_serializable应该
是dev_dependencies的一级子项,json_serializable千万不要写在build_runner缩进后,这样它会认为是build_runner的子集目录!
在项目根文件夹中运行 flutter packages get (或者在编辑器中点击 “Packages Get”) 以在项目中使用这些新的依赖项。
解析代码:
import 'dart:convert';
import 'package:flutter_test/flutter_test.dart';
import 'package:json_annotation/json_annotation.dart';
// user.g.dart 将在我们运行生成命令后自动生成
part 'user.g.dart';
@JsonSerializable()
class User {
String name;
String password;
User(this.name, this.password);
factory User.fromJson(Map<String, dynamic> json) => _$UserFromJson(json);
Map<String, dynamic> toJson() => _$UserToJson(this);
}
String jsonStr = "{\"name\": \"Hank\",\"password\": \"123456\"}";
void main() {
test('json test', () {
Map userMap = json.decode(jsonStr);
var user = new User.fromJson(userMap);
print('name, ${user.name}!');
print('password, ${user.password}.');
print('user json, ${user.toJson()}.');
});
}
复制以上代码使用json_serializable第一次创建类时,您会看到与下图类似的错误。
这些错误是完全正常的,这是因为model类的生成代码还不存在。为了解决这个问题,我们必须运行代码生成器来为我们生成序列化模板。这就让我想起和Dagger一样需要预编译才可以调用生成类。
有两种运行代码生成器的方法:
一次性生成
通过在我们的项目根目录下运行flutter packages pub run build_runner build,我们可以在需要时为我们的model生成json序列化代码。 这触发了一次性构建,它通过我们的源文件,挑选相关的并为它们生成必要的序列化代码。
虽然这非常方便,但如果我们不需要每次在model类中进行更改时都要手动运行构建命令的话会更好。
持续生成
使用watcher可以使我们的源代码生成的过程更加方便。它会监视我们项目中文件的变化,并在需要时自动构建必要的文件。我们可以通过flutter packages pub run build_runner watch在项目根目录下运行来启动watcher。
只需启动一次观察器,然后并让它在后台运行,这是安全的。
但是如果你运行了以上命令行均没有生成user.g.dart那可能你没有做到以下规范:
dart代码中User首字母可以大写,但是文件名字建议全部为小写,如user.dart,与User类名同名,生成代码的时候会匹配文件名和类名是否一致,否则无法生成user.g.dart。
当然如果已经有User类名能匹配到文件名后,在该文件再编写其他不同名的@JsonSerializable class也是能正常编译出来。
@JsonKey标注:
如果我们正在使用的API返回带有registration_date_millis字段,但我们想在我们的模型中使用registrationDateMillis
@JsonKey(name: 'registration_date_millis')
final int registrationDateMillis;