Flutter存储管理插件depository使用指南

Flutter存储管理插件depository使用指南

Depository — 简单数据库

Depository 是一个非常简单的数据库系统，允许你在应用程序中使用 SQLite 数据库。它依赖于 reflectable 包，并提供了一种简单的方式，通过描述你的数据来创建表。例如：

import 'package:depository/depository.dart';

@reflectable
class Person extends Entity {
    @primary
    @text String uuid;  // 主键字段

    @text String name;  // 文本字段
    @text String family;  // 家族字段
    @date DateTime birthday;  // 日期字段
    @nullable
    @text String nickname;  // 可选文本字段

    // 其他字段...
}

在上述代码中，Person 类被定义为继承自 Entity，并通过注解描述了每个字段的类型和约束。例如：

• @primary 表示该字段是主键。
• @text 表示字段是文本类型。
• @date 表示字段是日期类型。
• @nullable 表示字段可以为空。

系统会根据这些注解自动创建一个名为 Person 的表，并将 uuid 字段设置为主键。

查询数据

使用 Depository 插件，你可以轻松地从数据库中查询数据。例如，以下代码演示了如何查询名字为 "Pouya" 的记录：

final results = await Person().queryWhere('name = "Pouya"');

上述代码会返回所有满足条件的 Person 对象列表。

完整示例代码

以下是一个完整的示例代码，展示如何使用 Depository 插件创建表并插入数据：

import 'package:flutter/material.dart';
import 'package:depository/depository.dart';

void main() async {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('Depository Example')),
        body: Center(child: Text('Check console for output')),
      ),
    );
  }
}

// 定义数据模型
@reflectable
class Person extends Entity {
  @primary
  @text String uuid;

  @text String name;
  @text String family;
  @date DateTime birthday;
  @nullable
  @text String nickname;

  Person({this.uuid, this.name, this.family, this.birthday, this.nickname});
}

void setupDatabase() async {
  // 初始化数据库
  await DatabaseService().initialize();

  // 创建表
  await Person().createTable();
}

void insertData() async {
  // 插入一条数据
  final person = Person(
    uuid: '1',
    name: 'John',
    family: 'Doe',
    birthday: DateTime(1990, 1, 1),
    nickname: 'JD',
  );

  await person.insert();
  print('Data inserted successfully!');
}

void fetchData() async {
  // 查询数据
  final results = await Person().queryWhere('name = "John"');

  // 打印查询结果
  print('Query Results:');
  results.forEach((person) {
    print(person);
  });
}

void deleteData() async {
  // 删除数据
  await Person().deleteWhere('name = "John"');
  print('Data deleted successfully!');
}

void runExample() async {
  setupDatabase(); // 初始化数据库
  insertData();    // 插入数据
  fetchData();     // 查询数据
  deleteData();    // 删除数据
}

void main() async {
  runApp(MyApp());

  // 运行示例
  runExample();
}

输出结果

运行上述代码后，控制台将显示以下输出：

Data inserted successfully!
Query Results:
Person {uuid: 1, name: John, family: Doe, birthday: 1990-01-01T00:00:00.000, nickname: JD}
Data deleted successfully!