Brick SQLite Abstract #

为SQLite提供程序添加类级和字段级配置。

常见问题 #

为什么这个包不包含在brick_sqlite中？#

brick_build 使用 dart:mirrors 来确定字段类型和类结构。Flutter不能使用 dart:mirrors。而 brick_sqlite 依赖于Flutter。因此，为了在生成的代码中使用SQLite注解（注解提供了序列化和反序列化的信息），这个包必须分离，以便 brick_build 不会导入 brick_sqlite。

使用方法 #

要使用 brick_sqlite_abstract 插件，你需要遵循以下步骤：

步骤1：将依赖项添加到你的项目中 #

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

dependencies:
  brick_sqlite_abstract: ^0.1.0

步骤2：创建你的模型类 #

接下来，创建一个模型类，并使用注解来定义字段及其属性。

import 'package:brick_sqlite_abstract/brick_sqlite_abstract.dart';

class User extends SqlEntity {
  @SqlSerializable()
  final String name;

  @SqlSerializable()
  final int age;

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

  factory User.fromJson(Map<String, dynamic> json) => _$UserFromJson(json);
  Map<String, dynamic> toJson() => _$UserToJson(this);
}

步骤3：创建数据库帮助类 #

然后，创建一个帮助类来管理数据库操作。

import 'package:sqflite/sqflite.dart';
import 'package:path/path.dart';
import 'user.dart'; // 导入你的模型类

class DatabaseHelper {
  static final DatabaseHelper instance = DatabaseHelper._instance();
  static Database? _database;

  DatabaseHelper._instance();

  Future<Database> get database async {
    if (_database != null) return _database!;
    _database = await _initDatabase();
    return _database!;
  }

  Future<Database> _initDatabase() async {
    String path = join(await getDatabasesPath(), 'user.db');
    return await openDatabase(
      path,
      version: 1,
      onCreate: _onCreate,
    );
  }

  void _onCreate(Database db, int version) async {
    await db.execute('''
      CREATE TABLE user (
        id INTEGER PRIMARY KEY AUTOINCREMENT,
        name TEXT NOT NULL,
        age INTEGER NOT NULL
      )
    ''');
  }

  Future<List<User>> getUsers() async {
    Database db = await instance.database;
    List<Map<String, dynamic>> maps = await db.query('user');
    return List.generate(maps.length, (i) {
      return User(
        name: maps[i]['name'],
        age: maps[i]['age'],
      );
    });
  }
}

步骤4：执行数据库操作 #

现在你可以使用数据库帮助类来进行各种数据库操作，例如插入数据、查询数据等。

Future<void> insertUser(User user) async {
  final Database db = await DatabaseHelper.instance.database;
  await db.insert(
    'user',
    user.toJson(),
    conflictAlgorithm: ConflictAlgorithm.replace,
  );
}

Future<List<User>> fetchUsers() async {
  final Database db = await DatabaseHelper.instance.database;
  List<Map<String, dynamic>> maps = await db.query('user');
  return List.generate(maps.length, (i) {
    return User(
      name: maps[i]['name'],
      age: maps[i]['age'],
    );
  });
}