dartx_serialization 是一个用于 Flutter 和 Dart 的序列化插件，它可以帮助你将 Dart 对象转换为 JSON 或其他格式，并且可以将 JSON 或其他格式的数据反序列化为 Dart 对象。以下是如何使用 dartx_serialization 的基本步骤：

1. 添加依赖

首先，你需要在 pubspec.yaml 文件中添加 dartx_serialization 的依赖：

dependencies:
  flutter:
    sdk: flutter
  dartx_serialization: ^1.0.0  # 请使用最新版本

然后运行 flutter pub get 来获取依赖。

2. 创建模型类

接下来，你需要创建一个 Dart 类，并使用 dartx_serialization 的注解来标记需要序列化的字段。

import 'package:dartx_serialization/dartx_serialization.dart';

[@Serializable](/user/Serializable)()
class User {
  [@SerializeField](/user/SerializeField)()
  String name;

  [@SerializeField](/user/SerializeField)()
  int age;

  User({required this.name, required this.age});
}

3. 序列化和反序列化

使用 dartx_serialization 进行序列化和反序列化非常简单。你可以使用 Serialization 类来完成这些操作。

序列化

将 Dart 对象转换为 JSON 字符串：

import 'package:dartx_serialization/dartx_serialization.dart';

void main() {
  var user = User(name: 'John Doe', age: 30);
  var serialization = Serialization();
  var jsonString = serialization.serialize(user);
  print(jsonString);  // 输出: {"name":"John Doe","age":30}
}

反序列化

将 JSON 字符串转换为 Dart 对象：

import 'package:dartx_serialization/dartx_serialization.dart';

void main() {
  var jsonString = '{"name":"John Doe","age":30}';
  var serialization = Serialization();
  var user = serialization.deserialize<User>(jsonString);
  print(user.name);  // 输出: John Doe
  print(user.age);   // 输出: 30
}

4. 处理嵌套对象

如果你的模型类中包含了其他对象，dartx_serialization 也可以自动处理嵌套对象的序列化和反序列化。

[@Serializable](/user/Serializable)()
class Address {
  [@SerializeField](/user/SerializeField)()
  String city;

  [@SerializeField](/user/SerializeField)()
  String zipCode;

  Address({required this.city, required this.zipCode});
}

[@Serializable](/user/Serializable)()
class User {
  [@SerializeField](/user/SerializeField)()
  String name;

  [@SerializeField](/user/SerializeField)()
  int age;

  [@SerializeField](/user/SerializeField)()
  Address address;

  User({required this.name, required this.age, required this.address});
}

void main() {
  var user = User(
    name: 'John Doe',
    age: 30,
    address: Address(city: 'New York', zipCode: '10001'),
  );

  var serialization = Serialization();
  var jsonString = serialization.serialize(user);
  print(jsonString);  // 输出: {"name":"John Doe","age":30,"address":{"city":"New York","zipCode":"10001"}}

  var deserializedUser = serialization.deserialize<User>(jsonString);
  print(deserializedUser.address.city);  // 输出: New York
}

5. 自定义序列化和反序列化

如果你需要对某些字段进行自定义的序列化或反序列化，你可以使用 @Serialize 和 @Deserialize 注解。

[@Serializable](/user/Serializable)()
class User {
  [@SerializeField](/user/SerializeField)()
  String name;

  [@SerializeField](/user/SerializeField)()
  int age;

  [@SerializeField](/user/SerializeField)()
  @Serialize(using: CustomDateSerializer())
  DateTime createdAt;

  User({required this.name, required this.age, required this.createdAt});
}

class CustomDateSerializer implements Serializer<DateTime> {
  @override
  dynamic serialize(DateTime value) {
    return value.toIso8601String();
  }

  @override
  DateTime deserialize(dynamic value) {
    return DateTime.parse(value);
  }
}

void main() {
  var user = User(
    name: 'John Doe',
    age: 30,
    createdAt: DateTime.now(),
  );

  var serialization = Serialization();
  var jsonString = serialization.serialize(user);
  print(jsonString);  // 输出: {"name":"John Doe","age":30,"createdAt":"2023-10-01T12:34:56.789Z"}

  var deserializedUser = serialization.deserialize<User>(jsonString);
  print(deserializedUser.createdAt);  // 输出: 2023-10-01 12:34:56.789
}

6. 处理集合

dartx_serialization 也支持列表和映射的序列化和反序列化。

[@Serializable](/user/Serializable)()
class User {
  [@SerializeField](/user/SerializeField)()
  String name;

  [@SerializeField](/user/SerializeField)()
  List<String> hobbies;

  [@SerializeField](/user/SerializeField)()
  Map<String, dynamic> metadata;

  User({required this.name, required this.hobbies, required this.metadata});
}

void main() {
  var user = User(
    name: 'John Doe',
    hobbies: ['Reading', 'Swimming'],
    metadata: {'key1': 'value1', 'key2': 123},
  );

  var serialization = Serialization();
  var jsonString = serialization.serialize(user);
  print(jsonString);  // 输出: {"name":"John Doe","hobbies":["Reading","Swimming"],"metadata":{"key1":"value1","key2":123}}

  var deserializedUser = serialization.deserialize<User>(jsonString);
  print(deserializedUser.hobbies);  // 输出: [Reading, Swimming]
  print(deserializedUser.metadata); // 输出: {key1: value1, key2: 123}
}