JSON 和序列化

很难想象一个移动应用在某些时候不需要与 Web 服务器通信或轻松存储结构化数据。在创建网络连接的应用时，迟早都需要使用一些传统的 JSON。

本指南介绍了在 Flutter 中使用 JSON 的方法。它涵盖了在不同场景下使用哪个 JSON 解决方案以及原因。

本文介绍了两种处理 JSON 的通用策略

• 手动序列化
• 使用代码生成进行自动序列化

不同的项目具有不同的复杂性和用例。对于较小的概念验证项目或快速原型，使用代码生成器可能有点过头。对于具有多个更复杂 JSON 模型的应用，手动编码很快就会变得乏味、重复且容易出现许多小错误。

手动 JSON 解码是指使用 dart:convert 中内置的 JSON 解码器。它涉及将原始 JSON 字符串传递给 jsonDecode() 函数，然后在生成的 Map<String, dynamic> 中查找所需的 值。它没有外部依赖项或特定的设置过程，非常适合快速概念验证。

当项目变得更大时，手动解码的性能不佳。手动编写解码逻辑可能难以管理且容易出错。如果在访问不存在的 JSON 字段时出现错别字，则代码在运行时会抛出错误。

如果您的项目中没有太多 JSON 模型，并且希望快速测试某个概念，则手动序列化可能是您想要开始的方式。有关手动编码的示例，请参阅 使用 dart:convert 手动序列化 JSON。

使用代码生成进行 JSON 序列化意味着让外部库为您生成编码样板。在进行一些初始设置后，您可以运行一个文件监视器，该监视器根据您的模型类生成代码。例如，json_serializable 和 built_value 就是此类库。

这种方法可以很好地扩展到更大的项目。不需要手动编写的样板，并且在访问 JSON 字段时出现的错别字会在编译时被捕获。代码生成的一个缺点是需要一些初始设置。此外，生成的源文件可能会在您的项目导航器中产生视觉混乱。

当您拥有中型或大型项目时，您可能希望使用生成的代码进行 JSON 序列化。要查看基于代码生成的 JSON 编码示例，请参阅 使用代码生成库序列化 JSON。

简单的答案是不。

这样的库需要使用运行时 反射，这在 Flutter 中是被禁用的。运行时反射会干扰 Dart 很长时间以来一直支持的 tree shaking。使用 tree shaking，您可以从发布版本中“剔除”未使用的代码。这显著优化了应用的大小。

由于反射默认使所有代码都隐式使用，因此它使 tree shaking 变得困难。工具无法知道哪些部分在运行时未使用，因此很难去除冗余代码。使用反射时，应用大小无法轻松优化。

虽然您无法在 Flutter 中使用运行时反射，但一些库为您提供了类似易于使用的 API，但它们基于代码生成。本节 代码生成库 中将更详细地介绍这种方法。

Flutter 中的基本 JSON 序列化非常简单。Flutter 有一个内置的 dart:convert 库，其中包含一个简单的 JSON 编码器和解码器。

以下示例 JSON 实现了一个简单的用户模型。

{
  "name": "John Smith",
  "email": "[email protected]"
}

使用 dart:convert，您可以通过两种方式序列化此 JSON 模型。

查看 dart:convert 文档，您会发现可以通过调用 jsonDecode() 函数（以 JSON 字符串作为方法参数）来解码 JSON。

final user = jsonDecode(jsonString) as Map<String, dynamic>;

print('Howdy, ${user['name']}!');
print('We sent the verification link to ${user['email']}.');

不幸的是，jsonDecode() 返回一个 dynamic，这意味着您在运行时之前不知道值的类型。使用这种方法，您会失去大多数静态类型语言特性：类型安全、自动完成以及最重要的是编译时异常。您的代码将立即变得更容易出错。

例如，每当您访问 name 或 email 字段时，都可能很快引入错别字。编译器不知道的错别字，因为 JSON 位于映射结构中。

通过引入一个普通的模型类（在此示例中称为 User）来解决前面提到的问题。在 User 类中，您会发现

• 一个 User.fromJson() 构造函数，用于根据映射结构构建新的 User 实例。
• 一个 toJson() 方法，它将 User 实例转换为映射。

使用这种方法，调用代码可以具有类型安全、name 和 email 字段的自动完成以及编译时异常。如果您出现错别字或将字段视为 int 而不是 String，则应用将不会编译，而不是在运行时崩溃。

user.dart

class User {
  final String name;
  final String email;

  User(this.name, this.email);

  User.fromJson(Map<String, dynamic> json)
      : name = json['name'] as String,
        email = json['email'] as String;

  Map<String, dynamic> toJson() => {
        'name': name,
        'email': email,
      };
}

解码逻辑的责任现在转移到模型本身。使用这种新方法，您可以轻松解码用户。

final userMap = jsonDecode(jsonString) as Map<String, dynamic>;
final user = User.fromJson(userMap);

print('Howdy, ${user.name}!');
print('We sent the verification link to ${user.email}.');

要编码用户，请将 User 对象传递给 jsonEncode() 函数。您不需要调用 toJson() 方法，因为 jsonEncode() 已经为您完成了。

String json = jsonEncode(user);

使用这种方法，调用代码根本不必担心 JSON 序列化。但是，模型类绝对必须这样做。在生产应用中，您需要确保序列化正常工作。在实践中，User.fromJson() 和 User.toJson() 方法都需要有单元测试来验证正确的行为。

但是，现实场景并不总是那么简单。有时 JSON API 响应更复杂，例如，因为它们包含必须通过其自己的模型类解析的嵌套 JSON 对象。

如果有一些东西可以为您处理 JSON 编码和解码，那就太好了。幸运的是，有！

尽管还有其他库可用，但本指南使用 json_serializable，这是一个自动源代码生成器，可以为您生成 JSON 序列化样板。

由于序列化代码不再是手动编写或维护的，因此您可以最大程度地降低在运行时出现 JSON 序列化异常的风险。

要将 json_serializable 包含到您的项目中，您需要一个常规依赖项和两个开发依赖项。简而言之，开发依赖项是未包含在我们的应用源代码中的依赖项——它们仅在开发环境中使用。

要添加依赖项，请运行 flutter pub add

flutter pub add json_annotation dev:build_runner dev:json_serializable

在您的项目根文件夹中运行 flutter pub get（或在您的编辑器中点击Packages get）以使这些新依赖项在您的项目中可用。

以下显示了如何将 User 类转换为 json_serializable 类。为简单起见，此代码使用先前示例中的简化 JSON 模型。

user.dart

import 'package:json_annotation/json_annotation.dart';

/// This allows the `User` class to access private members in
/// the generated file. The value for this is *.g.dart, where
/// the star denotes the source file name.
part 'user.g.dart';

/// An annotation for the code generator to know that this class needs the
/// JSON serialization logic to be generated.
@JsonSerializable()
class User {
  User(this.name, this.email);

  String name;
  String email;

  /// A necessary factory constructor for creating a new User instance
  /// from a map. Pass the map to the generated `_$UserFromJson()` constructor.
  /// The constructor is named after the source class, in this case, User.
  factory User.fromJson(Map<String, dynamic> json) => _$UserFromJson(json);

  /// `toJson` is the convention for a class to declare support for serialization
  /// to JSON. The implementation simply calls the private, generated
  /// helper method `_$UserToJson`.
  Map<String, dynamic> toJson() => _$UserToJson(this);
}

通过此设置，源代码生成器会生成用于从 JSON 编码和解码 name 和 email 字段的代码。

如果需要，自定义命名策略也很容易。例如，如果 API 返回使用 snake_case 的对象，并且您希望在模型中使用 lowerCamelCase，则可以使用带有名称参数的 @JsonKey 注释

/// Tell json_serializable that "registration_date_millis" should be
/// mapped to this property.
@JsonKey(name: 'registration_date_millis')
final int registrationDateMillis;

最好是服务器和客户端都遵循相同的命名策略。
@JsonSerializable() 提供 fieldRename 枚举以将 dart 字段完全转换为 JSON 密钥。

修改 @JsonSerializable(fieldRename: FieldRename.snake) 等效于向每个字段添加 @JsonKey(name: '<snake_case>')。

有时服务器数据是不确定的，因此有必要在客户端验证和保护数据。

/// Tell json_serializable to use "defaultValue" if the JSON doesn't
/// contain this key or if the value is `null`.
@JsonKey(defaultValue: false)
final bool isAdult;

/// When `true` tell json_serializable that JSON must contain the key, 
/// If the key doesn't exist, an exception is thrown.
@JsonKey(required: true)
final String id;

/// When `true` tell json_serializable that generated code should 
/// ignore this field completely. 
@JsonKey(ignore: true)
final String verificationCode;

首次创建json_serializable类时，您会遇到类似于下图所示的错误。

这些错误完全正常，仅仅是因为模型类的生成代码尚不存在。要解决此问题，请运行生成序列化样板代码的代码生成器。

运行代码生成器有两种方法。

通过在项目根目录中运行dart run build_runner build --delete-conflicting-outputs，您可以在需要时为模型生成 JSON 序列化代码。这会触发一次性构建，遍历源文件，选择相关的文件，并为其生成必要的序列化代码。

虽然这很方便，但如果每次在模型类中进行更改时都不必手动运行构建，那就更好了。

一个观察器使我们的源代码生成过程更加方便。它监视项目文件中的更改，并在需要时自动构建必要的文件。通过在项目根目录中运行dart run build_runner watch --delete-conflicting-outputs启动观察器。

可以安全地启动观察器并将其保持在后台运行。

要以json_serializable的方式解码 JSON 字符串，实际上无需对我们之前的代码进行任何更改。

final userMap = jsonDecode(jsonString) as Map<String, dynamic>;
final user = User.fromJson(userMap);

编码也是如此。调用 API 与之前相同。

String json = jsonEncode(user);

使用json_serializable，您可以忘记User类中任何手动 JSON 序列化。源代码生成器会创建一个名为user.g.dart的文件，其中包含所有必要的序列化逻辑。您不再需要编写自动化测试来确保序列化工作——现在是库的责任来确保序列化正常工作。

您的代码可能在一个类中包含嵌套类。如果是这种情况，并且您尝试将该类以 JSON 格式作为参数传递给服务（例如 Firebase），则可能会遇到Invalid argument错误。

考虑以下Address类

import 'package:json_annotation/json_annotation.dart';
part 'address.g.dart';

@JsonSerializable()
class Address {
  String street;
  String city;

  Address(this.street, this.city);

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

Address类嵌套在User类中

import 'package:json_annotation/json_annotation.dart';

import 'address.dart';

part 'user.g.dart';

@JsonSerializable()
class User {
  User(this.name, this.address);

  String name;
  Address address;

  factory User.fromJson(Map<String, dynamic> json) => _$UserFromJson(json);
  Map<String, dynamic> toJson() => _$UserToJson(this);
}

在终端中运行dart run build_runner build --delete-conflicting-outputs会创建*.g.dart文件，但私有_$UserToJson()函数看起来类似于以下内容

Map<String, dynamic> _$UserToJson(User instance) => <String, dynamic>{
  'name': instance.name,
  'address': instance.address,
};

现在看起来一切正常，但如果您对用户对象进行打印操作

Address address = Address('My st.', 'New York');
User user = User('John', address);
print(user.toJson());

结果是

{name: John, address: Instance of 'address'}

而您可能希望得到如下输出

{name: John, address: {street: My st., city: New York}}

要使其工作，请在类声明上的@JsonSerializable()注解中传递explicitToJson: true。User类现在如下所示

import 'package:json_annotation/json_annotation.dart';

import 'address.dart';

part 'user.g.dart';

@JsonSerializable(explicitToJson: true)
class User {
  User(this.name, this.address);

  String name;
  Address address;

  factory User.fromJson(Map<String, dynamic> json) => _$UserFromJson(json);
  Map<String, dynamic> toJson() => _$UserToJson(this);
}

有关更多信息，请参阅JsonSerializable类中explicitToJson，该类属于json_annotation包。

有关更多信息，请参阅以下资源

• dart:convert和JsonCodec文档
• pub.dev 上的json_serializable包
• GitHub 上的json_serializable示例
• 深入了解 Dart 的模式和记录的 Codelab：Dive into Dart's patterns and records
• 关于如何在 Dart/Flutter 中解析 JSON的终极指南

除非另有说明，否则本网站上的文档反映了 Flutter 的最新稳定版本。页面上次更新于 2024-06-24。 查看源代码 或 报告问题.