Flutter JSON序列化与反序列化插件 json_class 的使用

json_class 是一个用于简化 JSON 序列化和反序列化的 Flutter 插件。通过扩展该类，您可以轻松地将对象编码为 JSON 兼容的 Map 或 List，并且可以方便地从 JSON 兼容的 Map 或 List 解码回数据模型。

使用库

添加依赖

首先，在您的 pubspec.yaml 文件中添加 json_class 依赖：

dependencies:
  json_class: ^<version>  # 请替换 <version> 为您需要的版本号

然后运行以下命令以获取包：

flutter packages get

示例代码

下面是一个完整的示例，展示如何使用 json_class 进行 JSON 序列化和反序列化。

定义数据模型

我们定义一个 Person 类，继承自 JsonClass，并实现序列化和反序列化方法。

import 'package:json_class/json_class.dart';
import 'package:meta/meta.dart';

@immutable
class Person extends JsonClass {
  Person({
    this.age,
    this.minor,
    this.firstName,
    this.lastName,
  });

  final int age;
  final bool minor;
  final String firstName;
  final String lastName;

  // 从动态类型（如Map）创建Person实例
  static Person fromDynamic(dynamic map) {
    Person result;

    if (map != null) {
      result = Person(
        age: JsonClass.parseInt(map['age']),
        minor: JsonClass.parseBool(map['minor']),
        firstName: map['firstName'],
        lastName: map['lastName'],
      );
    }

    return result;
  }

  // 从动态类型的列表创建Person列表
  static List<Person> fromDynamicList(Iterable<dynamic> list) {
    List<Person> results;

    if (list != null) {
      results = [];
      for (dynamic map in list) {
        results.add(fromDynamic(map));
      }
    }

    return results;
  }

  // 将Person实例转换为JSON兼容的Map
  @override
  Map<String, dynamic> toJson() => JsonClass.removeNull({
    'age': age,
    'minor': minor,
    'firstName': firstName,
    'lastName': lastName,
  });
}

使用示例

接下来，我们将展示如何使用上述定义的 Person 类进行序列化和反序列化。

void main() {
  // 创建一个Person实例
  var person = Person(
    age: 30,
    minor: false,
    firstName: 'John',
    lastName: 'Doe'
  );

  // 将Person实例转换为JSON字符串
  var jsonString = person.toJson();
  print('Serialized JSON: $jsonString');

  // 将JSON字符串转换回Person实例
  var deserializedPerson = Person.fromDynamic(jsonString);
  print('Deserialized Person: ${deserializedPerson.firstName} ${deserializedPerson.lastName}, Age: ${deserializedPerson.age}');
  
  // 处理列表的情况
  var persons = [
    Person(age: 30, minor: false, firstName: 'John', lastName: 'Doe'),
    Person(age: 25, minor: false, firstName: 'Jane', lastName: 'Smith')
  ];

  // 将列表转换为JSON
  var jsonPersons = persons.map((person) => person.toJson()).toList();
  print('Serialized List of Persons: $jsonPersons');

  // 将JSON转换回列表
  var deserializedPersons = Person.fromDynamicList(jsonPersons);
  print('Deserialized List of Persons:');
  for (var p in deserializedPersons) {
    print('${p.firstName} ${p.lastName}, Age: ${p.age}');
  }
}

输出结果

运行上述代码后，您将看到类似以下输出：

Serialized JSON: {age: 30, minor: false, firstName: John, lastName: Doe}
Deserialized Person: John Doe, Age: 30
Serialized List of Persons: [{age: 30, minor: false, firstName: John, lastName: Doe}, {age: 25, minor: false, firstName: Jane, lastName: Smith}]
Deserialized List of Persons:
John Doe, Age: 30
Jane Smith, Age: 25

通过这种方式，您可以轻松地在 Flutter 应用中处理 JSON 数据的序列化和反序列化。希望这个示例对您有所帮助！