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 已經支援很長時間了。透過搖樹最佳化，您可以從釋出版本中“搖掉”未使用的程式碼。這顯著優化了應用程式的大小。

由於反射預設使所有程式碼都隱式使用，因此它使搖樹最佳化變得困難。工具無法知道哪些部分在執行時未使用，因此冗餘程式碼很難剝離。使用反射時，應用程式大小無法輕易最佳化。

雖然您無法在 Flutter 中使用執行時反射，但有些庫為您提供了同樣易於使用的 API，但它們基於程式碼生成。此方法在程式碼生成庫部分有更詳細的介紹。

Flutter 中的基本 JSON 序列化非常簡單。Flutter 有一個內建的 dart:convert 庫，其中包含一個簡單的 JSON 編碼器和解碼器。

以下示例 JSON 實現了一個簡單的使用者模型。

{
  "name": "John Smith",
  "email": "john@example.com"
}

使用 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，則可以使用帶有 name 引數的 @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>')。

有時伺服器資料不確定，因此需要在客戶端驗證和保護資料。
其他常用的 @JsonKey 註解包括

/// 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 類時，您會遇到類似於以下內容的錯誤

Target of URI hasn't been generated: 'user.g.dart'.

這些錯誤完全正常，僅僅是因為模型類尚未生成程式碼。要解決此問題，請執行程式碼生成器，它會生成序列化樣板程式碼。

有兩種執行程式碼生成器的方法。

透過在專案根目錄中執行 dart run build_runner build --delete-conflicting-outputs，您可以在需要時為模型生成 JSON 序列化程式碼。這將觸發一次性構建，該構建會遍歷原始檔，選擇相關檔案，併為它們生成必要的序列化程式碼。

雖然這很方便，但如果您不必每次更改模型類時都手動執行構建，那就更好了。

一個 watcher 使我們的原始碼生成過程更加方便。它會監視專案檔案中的更改，並在需要時自動構建必要的檔案。透過在專案根目錄中執行 dart run build_runner watch --delete-conflicting-outputs 來啟動 watcher。

啟動一次監視器並讓它在後臺執行是安全的。

要以 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,
};

現在一切看起來都很好，但是如果你對 user 物件進行 print() 操作

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
• 關於 如何在 Dart/Flutter 中解析 JSON 的終極指南