Flutter数据库管理插件sqlite_wrapper的使用

sqlite_wrapper 是一个简单的 SQLite3 绑定包装库，基于 sqlite3 包。它旨在简化与 SQLite 数据库的工作，提供了一个易于使用的 API，并支持多平台（iOS、Android、MacOS、Windows、Web）。

主要特性

• 无样板代码
• 无需生成代码
• 提供响应式 API
• 简化模型对象的转换
• 完全支持 SQL 语言特性
• 全面测试的代码
• 多平台支持
• 没有复杂的魔法，API 简单易用

功能

• 连接到 SQLite 数据库
• 执行 SQL 语句
• 使用编码和解码映射或模型对象操作数据库
• 通过流实时更新特定查询结果
• 同时管理多个数据库
• 在数据库创建或迁移时执行回调

开始使用

安装依赖

1. 添加 sqlite_wrapper 包到 pubspec.yaml 文件中：

   dependencies:
     sqlite_wrapper: ^latest_version
   

2. 如果需要在 iOS 和 MacOS 上使用最新版本的 SQLite，请安装并配置 sqlite3_flutter_libs 包。

3. 如果要在 Flutter Web 中使用该库，请安装并配置 sqflite_common_ffi_web 包，并运行以下命令生成必要的文件：

   $ dart run sqflite_common_ffi_web:setup --force
   

使用示例

初始化数据库

首先，我们需要初始化数据库并创建表：

import 'package:path/path.dart' as p;
import 'package:path_provider/path_provider.dart';
import 'package:sqlite_wrapper/sqlite_wrapper.dart';

Future<void> initDB() async {
  final docDir = await getApplicationDocumentsDirectory();
  if (!await docDir.exists()) {
    await docDir.create(recursive: true);
  }
  await SQLiteWrapper().openDB(p.join(docDir.path, "todoDatabase.sqlite"));
  
  const String createTableSQL = """
    CREATE TABLE IF NOT EXISTS "todos" (
      "id" integer PRIMARY KEY AUTOINCREMENT NOT NULL,
      "title" varchar(255) NOT NULL,
      "done" int default 0
    );
  """;
  await SQLiteWrapper().execute(createTableSQL);
}

插入数据

Map<String, dynamic> todo = {"title": "New Todo", "done": 0};
int id = await SQLiteWrapper().insert(todo, "todos");
print('Inserted row with id: $id');

查询数据

单条记录查询

Map? todoMap = await SQLiteWrapper().query(
  "SELECT * FROM todos WHERE id = ?",
  params: [1],
  singleResult: true,
);
print(todoMap);

多条记录查询

List<Map> todos = await SQLiteWrapper().query("SELECT * FROM todos");
print(todos);

更新数据

Map<String, dynamic> updatedTodo = {"id": 1, "title": "Updated Todo", "done": 1};
int affectedRows = await SQLiteWrapper().update(updatedTodo, "todos", keys: ["id"]);
print('Updated $affectedRows rows');

删除数据

int deletedRows = await SQLiteWrapper().delete({"id": 1}, "todos", keys: ["id"]);
print('Deleted $deletedRows rows');

监听数据变化

Stream stream = SQLiteWrapper().watch(
  "SELECT COUNT(*) FROM todos",
  singleResult: true,
  tables: ["todos"],
);

stream.listen((event) {
  print('Count of todos: $event');
});

示例项目

下面是一个完整的 Flutter 应用示例，展示如何使用 sqlite_wrapper 插件来管理待办事项列表。

import 'package:flutter/material.dart';
import 'package:path/path.dart' as p;
import 'package:path_provider/path_provider.dart';
import 'package:sqlite_wrapper/sqlite_wrapper.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  // 初始化数据库
  await initDB();
  runApp(const MyApp());
}

Future<void> initDB() async {
  final docDir = await getApplicationDocumentsDirectory();
  if (!await docDir.exists()) {
    await docDir.create(recursive: true);
  }
  await SQLiteWrapper().openDB(p.join(docDir.path, "todoDatabase.sqlite"));
  
  const String createTableSQL = """
    CREATE TABLE IF NOT EXISTS "todos" (
      "id" integer PRIMARY KEY AUTOINCREMENT NOT NULL,
      "title" varchar(255) NOT NULL,
      "done" int default 0
    );
  """;
  await SQLiteWrapper().execute(createTableSQL);
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'SQLiteWrapper Sample',
      theme: ThemeData(
        primarySwatch: Colors.red,
      ),
      home: const HomePage(title: 'Todos'),
    );
  }
}

class HomePage extends StatefulWidget {
  final String title;

  const HomePage({super.key, required this.title});

  [@override](/user/override)
  _HomePageState createState() => _HomePageState();
}

class _HomePageState extends State<HomePage> {
  List<Map<String, dynamic>> todos = [];

  [@override](/user/override)
  void initState() {
    super.initState();
    loadTodos();
  }

  Future<void> loadTodos() async {
    List<Map> loadedTodos = await SQLiteWrapper().query("SELECT * FROM todos");
    setState(() {
      todos = loadedTodos.cast<Map<String, dynamic>>();
    });
  }

  void addTodo(String title) async {
    Map<String, dynamic> newTodo = {"title": title, "done": 0};
    await SQLiteWrapper().insert(newTodo, "todos");
    loadTodos();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: ListView.builder(
        itemCount: todos.length,
        itemBuilder: (context, index) {
          final todo = todos[index];
          return ListTile(
            title: Text(todo['title']),
            trailing: Checkbox(
              value: todo['done'] == 1,
              onChanged: (value) {
                todo['done'] = value! ? 1 : 0;
                SQLiteWrapper().update(todo, "todos", keys: ["id"]);
                loadTodos();
              },
            ),
          );
        },
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: () {
          addTodo("New Todo");
        },
        tooltip: 'Add new todo',
        child: const Icon(Icons.add),
      ),
    );
  }
}