Flutter代码生成插件flamingo_generator的使用

flamingo_generator 是一个用于通过注解 Dart 类来自动生成代码的插件。它可以帮助开发者自动生成将数据从 Dart 对象转换为 JSON 格式的数据，反之亦然。

使用步骤

1. 添加依赖

首先，在你的 pubspec.yaml 文件中添加以下依赖：

dependencies:
  flutter:
    sdk: flutter
  flamingo: ^x.x.x
  flamingo_annotation: ^x.x.x

dev_dependencies:
  build_runner: ^x.x.x
  flamingo_generator: ^x.x.x

请确保替换 x.x.x 为你需要的具体版本号。

2. 创建模型类

接下来，创建一个 Dart 类并使用注解来定义字段。例如：

import 'package:flamingo/flamingo.dart';
import 'package:flamingo_annotation/flamingo_annotation.dart';

import 'cart.dart';
import 'item.dart';

part 'user.flamingo.dart';

class User extends Document<User> {
  User({
    String id,
    DocumentSnapshot snapshot,
    Map<String, dynamic> values,
  }) : super(id: id, snapshot: snapshot, values: values) {
    item = Collection(this, UserFieldValueKey.item.value);
  }

  @Field()
  String name;

  @Field(isWriteNotNull: false)
  String profile;

  @Field()
  Map<String, int> intMap;

  @Field()
  List<Map<String, int>> listIntMap;

  @Field()
  Increment<int> point = Increment('point');

  @Field()
  Increment<double> score = Increment('score');

  @ModelField()
  Cart cartA;

  @ModelField(isWriteNotNull: false)
  Cart cartB;

  @ModelField()
  List<Cart> carts;

  @StorageField()
  StorageFile fileA;

  @StorageField(isWriteNotNull: false, folderName: 'image')
  StorageFile fileB;

  @StorageField()
  List<StorageFile> filesA;

  @StorageField(isWriteNotNull: false)
  List<StorageFile> filesB;

  @SubCollection()
  Collection<Item> item;

  @override
  Map<String, dynamic> toData() => _$toData(this);

  @override
  void fromData(Map<String, dynamic> data) => _$fromData(this, data);
}

3. 生成代码

在终端中运行以下命令以生成代码：

flutter pub run build_runner build

这将会根据你在模型类中定义的注解生成相应的代码。

4. 使用生成的代码

现在你可以使用生成的代码来轻松地将对象转换为 JSON 数据，反之亦然。例如：

void main() {
  // 创建一个用户实例
  User user = User(
    id: '1',
    name: 'John Doe',
    profile: 'Developer',
    intMap: {'key': 1},
    listIntMap: [{'key': 1}, {'key': 2}],
    point: Increment(10),
    score: Increment(8.5),
    cartA: Cart(values: {'items': ['item1']}),
    cartB: null,
    carts: [Cart(values: {'items': ['item2']}), Cart(values: {'items': ['item3']})],
    fileA: StorageFile('path/to/fileA'),
    fileB: null,
    filesA: [StorageFile('path/to/fileA1'), StorageFile('path/to/fileA2')],
    filesB: [],
    item: Collection<User>(null, 'item'),
  );

  // 将用户对象转换为JSON数据
  Map<String, dynamic> jsonData = user.toData();
  print(jsonData);

  // 从JSON数据加载用户对象
  User loadedUser = User();
  loadedUser.fromData(jsonData);
  print(loadedUser.name); // 输出: John Doe
}