Flutter数据库生成与操作插件sqfentity_gen的使用

sqfentity_gen 是一个用于Flutter的代码生成器插件，主要用于SQLite数据库的操作。它简化了数据库表的定义、查询和管理。以下是详细的使用指南。

开始使用

首先，你需要从GitHub获取更多信息：sqfEntity GitHub。

步骤 1: 导入必要的包

在你的Dart文件中导入以下包：

import 'package:sqfentity/sqfentity.dart';
import 'package:sqfentity_gen/sqfentity_gen.dart';

步骤 2: 定义表结构

定义你的表结构作为SqfEntityTable常量。例如：

const SqfEntityTable tableCategory = SqfEntityTable(
    tableName: 'category',
    primaryKeyName: 'id',
    primaryKeyType: PrimaryKeyType.integer_auto_incremental,
    useSoftDeleting: true,
    fields: [
      SqfEntityField('name', DbType.text),
      SqfEntityField('isActive', DbType.bool, defaultValue: true),
    ]);

步骤 3: 创建数据库模型

创建你的数据库模型实例，包含之前定义的所有表：

@SqfEntityBuilder(myDbModel)
const SqfEntityModel myDbModel = SqfEntityModel(
    modelName: null,
    databaseName: 'sampleORM.db',
    databaseTables: [tableCategory],
    sequences: [],
);

步骤 4: 运行代码生成器

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

flutter pub run build_runner build --delete-conflicting-outputs

检查 lib/model/model.g.dart 文件确保代码已正确生成。

示例代码

以下是一个完整的示例，展示了如何添加产品、打印类别列表以及执行各种查询操作：

import 'package:flutter/material.dart';
import 'package:sqfentity/sqfentity.dart';
import 'package:sqfentity_gen/sqfentity_gen.dart';

// 定义表结构
const SqfEntityTable tableProduct = SqfEntityTable(
    tableName: 'product',
    primaryKeyName: 'id',
    primaryKeyType: PrimaryKeyType.integer_auto_incremental,
    fields: [
      SqfEntityField('name', DbType.text),
      SqfEntityField('description', DbType.text),
      SqfEntityField('price', DbType.real, defaultValue: 0),
      SqfEntityField('isActive', DbType.bool, defaultValue: true),
    ]);

@SqfEntityBuilder(myDbModel)
const SqfEntityModel myDbModel = SqfEntityModel(
    modelName: null,
    databaseName: 'sampleORM.db',
    databaseTables: [tableProduct],
);

void main(List<String> args) async {
  WidgetsFlutterBinding.ensureInitialized();
  await runSamples();
}

Future<bool> runSamples() async {
  await addSomeProducts();
  printCategories(false);
  return true;
}

Future<void> addSomeProducts() async {
  // 添加一些产品到数据库
  await Product(
    name: 'Sample Product',
    description: 'This is a sample product',
    price: 99.99,
    isActive: true,
  ).save();
}

Future<void> printCategories(bool getIsDeleted) async {
  final categoryList = await Category().select(getIsDeleted: getIsDeleted).toList();
  print('LISTING CATEGORIES -> Category().select().toList()');
  print('${categoryList.length} matches found:');
  for (int i = 0; i < categoryList.length; i++) {
    print(categoryList[i].toMap());
  }
  print('---------------------------------------------------------------\n\n');
}

查询示例

这里有一些查询示例，展示如何使用sqfentity进行复杂查询：

示例 1.1: 获取所有产品

await printProducts();

Future<void> printProducts() async {
  final productList = await Product().select().toList();
  print('EXAMPLE 1.1: SELECT ALL ROWS WITHOUT FILTER ex: SELECT * FROM PRODUCTS \n -> Product().select().toList()');
  print('${productList.length} matches found:');
  for (int i = 0; i < productList.length; i++) {
    print(productList[i].toMap());
  }
  print('---------------------------------------------------------------\n\n');
}

示例 1.2: 排序查询结果

var productList = await Product()
    .select()
    .orderBy('name')
    .orderByDesc('price')
    .orderBy('id')
    .toList();
print('EXAMPLE 1.2: ORDER BY FIELDS ex: SELECT * FROM PRODUCTS ORDER BY name, price DESC, id \n-> Product().select().orderBy(\'name\').orderByDesc(\'price\').orderBy(\'id\').toList()');

示例 1.3: 选择特定字段

productList = await Product()
    .select(columnsToSelect: ['name', 'price'])
    .orderByDesc('price')
    .toList();
print('EXAMPLE 1.3: SELECT SPECIFIC FIELDS ex: SELECT name,price FROM PRODUCTS ORDER BY price DESC \n-> Product().select(columnsToSelect:[\'name\',\'price\']).orderByDesc(\'price\').toList()');