Flutter SQLite代码生成插件brick_sqlite_generators的使用

Brick Sqlite Build

brick_sqlite_generators 是一个用于为使用 SqliteProvider 的 Brick 适配器提供（反）序列化函数的代码生成器。该包本身不生成代码，而是可以导入到其他 Brick 构建域中。

该包不应直接导入到最终的应用程序中，因为它不会生成代码。

使用方法

要使用 SqliteSerdes，你需要在自己的 AnnotationSuperGenerator 中应用它：

import 'package:brick_rest_generators/rest_serdes.dart';

class MyDomainGenerator extends AnnotationSuperGenerator<ConnectOfflineFirst> {
  final String superAdapterName;
  final String repositoryName;

  const OfflineFirstGenerator({
    this.superAdapterName = 'OfflineFirst',
    this.repositoryName = 'OfflineFirst',
  });

  /// 给定一个[element]和[annotation]，构建生成器列表
  List<SerdesGenerator> buildGenerators(Element element, ConstantReader annotation) {
    // 创建 SqliteSerdes 实例
    final sqlite = SqliteSerdes(element, annotation, repositoryName: repositoryName);
    
    // 创建 OtherProviderSerdes 实例
    final otherProvider = OtherProviderSerdes(element, annotation, repositoryName: repositoryName);

    // 初始化生成器列表
    final generators = <SerdesGenerator>[];
    
    // 将 SqliteSerdes 生成器添加到列表中
    generators.addAll(sqlite.generators);
    
    // 将 OtherProviderSerdes 生成器添加到列表中
    generators.addAll(otherProvider.generators);
    
    // 返回生成器列表
    return generators;
  }
}

完整示例Demo

以下是一个完整的示例，展示了如何设置和使用 brick_sqlite_generators 插件来生成序列化和反序列化代码。

1. 添加依赖

首先，在 pubspec.yaml 文件中添加必要的依赖项：

dependencies:
  brick_sqlite_generators: ^x.x.x
  brick_offline_first: ^x.x.x
  # 其他依赖

2. 创建自定义生成器

创建一个自定义的生成器类，例如 MyDomainGenerator，并继承 AnnotationSuperGenerator：

import 'package:brick_rest_generators/rest_serdes.dart';

class MyDomainGenerator extends AnnotationSuperGenerator<ConnectOfflineFirst> {
  final String superAdapterName;
  final String repositoryName;

  const MyDomainGenerator({
    this.superAdapterName = 'OfflineFirst',
    this.repositoryName = 'OfflineFirst',
  });

  /// 给定一个[element]和[annotation]，构建生成器列表
  @override
  List<SerdesGenerator> buildGenerators(Element element, ConstantReader annotation) {
    // 创建 SqliteSerdes 实例
    final sqlite = SqliteSerdes(element, annotation, repositoryName: repositoryName);
    
    // 创建 OtherProviderSerdes 实例
    final otherProvider = OtherProviderSerdes(element, annotation, repositoryName: repositoryName);

    // 初始化生成器列表
    final generators = <SerdesGenerator>[];
    
    // 将 SqliteSerdes 生成器添加到列表中
    generators.addAll(sqlite.generators);
    
    // 将 OtherProviderSerdes 生成器添加到列表中
    generators.addAll(otherProvider.generators);
    
    // 返回生成器列表
    return generators;
  }
}

3. 配置构建脚本

确保在你的 build.yaml 文件中配置了正确的构建脚本，以便在构建时运行生成器：

targets:
  $default:
    builders:
      brick_sqlite_generators|sqlite_serdes:
        enabled: true
        generate_for:
          include:
            - lib/**/*.dart

4. 使用生成的代码

在你的应用程序中，你可以使用生成的序列化和反序列化函数来处理数据。例如：

import 'package:path/path.dart' as p;
import 'package:sqflite/sqflite.dart';
import 'package:brick_sqlite_generators/sqlite_serdes.dart';

class MyModel {
  int id;
  String name;

  MyModel({required this.id, required this.name});
}

void main() async {
  // 初始化数据库
  final databasePath = await getDatabasesPath();
  final db = await openDatabase(p.join(databasePath, 'my_database.db'));

  // 创建 SqliteSerdes 实例
  final sqlite = SqliteSerdes(MyModel, null, repositoryName: 'MyRepository');

  // 序列化对象
  final serialized = sqlite.serialize(MyModel(id: 1, name: 'John Doe'));
  
  print('Serialized: $serialized');
  
  // 反序列化对象
  final deserialized = sqlite.deserialize(serialized);
  
  print('Deserialized: ${deserialized.name}');
}