发现 Flutter JSON 数据的极简自动转换为 Model 的方式

2023-10-12 14:01:13

前言

在 Flutter 开发中，通常需要将 JSON 数据解析为 Model 以进行数据传递和赋值。传统的方法需要定义 Model 类，并使用第三方库或自定义代码进行解析。本文将介绍一种更简洁、更有效的方式来实现 JSON 数据的自动转换为 Model。

JSON 数据到 Model 的传统转换

传统的方法涉及以下步骤：

定义一个与 JSON 数据结构相匹配的 Model 类。
使用第三方库（例如 json_serializable）或自定义解析函数将 JSON 数据解析为 Model 对象。

这种方法虽然可行，但对于复杂的 JSON 数据结构或大型项目来说，可能会变得繁琐和容易出错。

极简自动转换

Flutter 提供了一个极简的方式来自动将 JSON 数据转换为 Model，无需定义 Model 类或编写解析代码。只需使用 json_annotation 包，添加一些注释，即可实现自动转换。

具体步骤如下：

在 pubspec.yaml 中添加 json_annotation 依赖：

dependencies:
  json_annotation: ^4.7.0

在终端运行以下命令生成代码：

flutter packages pub run build_runner build

在 Model 类中使用以下注释：

@JsonSerializable(explicitToJson: true)
class MyModel {
  ...
}

在命令行中再次运行 flutter packages pub run build_runner build 以生成代码。

示例

假设我们有以下 JSON 数据：

{
  "name": "John Doe",
  "age": 30,
  "email": "johndoe@example.com"
}

我们可以创建一个名为 MyModel 的 Model 类并使用以下注释：

@JsonSerializable(explicitToJson: true)
class MyModel {
  String name;
  int age;
  String email;

  MyModel(this.name, this.age, this.email);

  factory MyModel.fromJson(Map<String, dynamic> json) => _$MyModelFromJson(json);

  Map<String, dynamic> toJson() => _$MyModelToJson(this);
}