Flutter JSON序列化辅助插件json_serializable_helper的使用

通过将此包添加到您的项目中，您可以直接使用 JSON 文件作为 json_serializable 包的输入。

功能

假设您已经从 API 调用中收到了以下响应：

{
  "name": "John Doe",
  "age": 30,
  "address": {
    "street": "123 Main St",
    "city": "New York",
    "country": "USA"
  },
  "job": {
    "title": "Software Engineer",
    "company": {
      "name": "TechCorp",
      "industry": "Technology"
    }
  }
}

如果您想解码和编码这个简单的 JSON，您可以使用 json_serializable 包。但在那之前，您需要创建一个由 json_serializable 所需的相应 person.dart 类：

import 'package:json_annotation/json_annotation.dart';

part 'person.g.dart';

@JsonSerializable()
class Person {
  @JsonKey(name: 'name', defaultValue: null)
  final String? name;

  @JsonKey(name: 'age', defaultValue: null)
  final int? age;

  @JsonKey(name: 'address', defaultValue: null)
  final Address? address;

  @JsonKey(name: 'job', defaultValue: null)
  final Job? job;

  Person({
    this.name,
    this.age,
    this.address,
    this.job,
  });

  factory Person.fromJson(Map<String, dynamic> json) => _$PersonFromJson(json);
  Map<String, dynamic> toJson() => _$PersonToJson(this);
}

@JsonSerializable()
class Address {
  @JsonKey(name: 'street', defaultValue: null)
  final String? street;

  @JsonKey(name: 'city', defaultValue: null)
  final String? city;

  @JsonKey(name: 'country', defaultValue: null)
  final String? country;

  Address({
    this.street,
    this.city,
    this.country,
  });

  factory Address.fromJson(Map<String, dynamic> json) => _$AddressFromJson(json);
  Map<String, dynamic> toJson() => _$AddressToJson(this);
}

@JsonSerializable()
class Job {
  @JsonKey(name: 'title', defaultValue: null)
  final String? title;

  @JsonKey(name: 'company', defaultValue: null)
  final Company? company;

  Job({
    this.title,
    this.company,
  });

  factory Job.fromJson(Map<String, dynamic> json) => _$JobFromJson(json);
  Map<String, dynamic> toJson() => _$JobToJson(this);
}

@JsonSerializable()
class Company {
  @JsonKey(name: 'name', defaultValue: null)
  final String? name;

  @JsonKey(name: 'industry', defaultValue: null)
  final String? industry;

  Company({
    this.name,
    this.industry,
  });

  factory Company.fromJson(Map<String, dynamic> json) => _$CompanyFromJson(json);
  Map<String, dynamic> toJson() => _$CompanyToJson(this);
}

然后运行以下命令：

dart run build_runner build --delete-conflicting-outputs

这将会为您生成 person.g.dart 文件，您就完成了！

正如您所见，编写 person.dart 类是一个繁琐且容易出错的过程，特别是当 JSON 较大且复杂时。该包旨在简化这一过程，通过允许您使用 JSON 文件作为 json_serializable 的输入。这意味着您只需在项目中包含 JSON 文件，然后运行上述相同的命令，相应的 Dart 类（如 person.dart 和 person.g.dart）就会为您自动生成。

使用方法

在 pubspec.yaml 文件中添加 json_serializable 和 json_serializable_helper 依赖项：

dev_dependencies:
  json_serializable: ^6.7.1
  json_serializable_helper: ^1.0.0

然后在项目的根目录下添加一个 build.yaml 文件。在这个文件中，您应该指定 JSON 文件所在的目录，例如：

global_options:
  json_serializable_helper:
    options:
      json_path: "lib/datamodels"

在上面的例子中，您的 JSON 文件可以放在 lib/datamodels 目录或其任何子目录下，例如 lib/datamodels/aws/person.json。

现在运行以下命令以生成 Dart 类：

dart run build_runner build --delete-conflicting-outputs