Flutter事件数据库管理插件event_db的使用

Flutter事件数据库管理插件event_db的使用

Event DB 是一个与 event_bloc 库配套使用的库。它包含了一个 GenericModel 类供模型扩展，并且提供了一个基础的数据库仓库类供这些模型使用。对于这个数据库仓库的一个默认实现，你可以参考以下插件之一：

• event_hive

开始使用

在开始之前，你需要确保已经将 event_db 添加到你的 pubspec.yaml 文件中。例如：

dependencies:
  event_db: ^1.0.0

然后运行 flutter pub get 来安装该依赖。

接下来，我们将创建一个简单的应用来演示如何使用 event_db 插件进行数据库管理。

1. 创建一个新的 Flutter 项目

首先，创建一个新的 Flutter 项目：

flutter create event_db_example
cd event_db_example

2. 配置 pubspec.yaml

在 pubspec.yaml 中添加 event_db 依赖：

dependencies:
  flutter:
    sdk: flutter
  event_db: ^1.0.0

保存文件后运行 flutter pub get 来获取依赖。

3. 创建一个模型类

我们将创建一个简单的模型类 Task，继承自 GenericModel。Task 类将用于表示任务数据。

import 'package:event_db/event_db.dart';

class Task extends GenericModel {
  final String title;
  final bool isCompleted;

  Task({required this.title, this.isCompleted = false});

  [@override](/user/override)
  Map<String, dynamic> toJson() {
    return {
      'title': title,
      'isCompleted': isCompleted,
    };
  }

  [@override](/user/override)
  Task fromJson(Map<String, dynamic> json) {
    return Task(
      title: json['title'],
      isCompleted: json['isCompleted'],
    );
  }
}

4. 创建数据库仓库

我们将创建一个 TaskRepository 类来管理 Task 模型的数据。这里我们使用 Hive 作为底层存储引擎。

import 'package:event_db/event_db.dart';
import 'package:hive/hive.dart';
import 'task.dart';

class TaskRepository extends BaseDatabaseRepository<Task> {
  Box<Task> _box;

  TaskRepository(String boxName) : _box = Hive.box<Task>(boxName);

  [@override](/user/override)
  Future<void> add(Task item) async {
    await _box.add(item);
  }

  [@override](/user/override)
  Future<void> delete(int index) async {
    await _box.deleteAt(index);
  }

  [@override](/user/override)
  Future<List<Task>> getAll() async {
    return _box.values.toList();
  }

  [@override](/user/override)
  Future<void> update(int index, Task item) async {
    await _box.putAt(index, item);
  }
}

5. 初始化 Hive 和 TaskRepository

在 main.dart 中初始化 Hive 并创建 TaskRepository 实例。

import 'package:flutter/material.dart';
import 'package:event_db/event_db.dart';
import 'package:hive/hive.dart';
import 'task.dart';
import 'task_repository.dart';

void main() async {
  // 初始化 Hive
  await Hive.initFlutter();
  Hive.registerAdapter(TaskAdapter());

  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('Event DB Example')),
        body: TaskScreen(),
      ),
    );
  }
}

class TaskScreen extends StatefulWidget {
  [@override](/user/override)
  _TaskScreenState createState() => _TaskScreenState();
}

class _TaskScreenState extends State<TaskScreen> {
  late TaskRepository _repository;

  [@override](/user/override)
  void initState() {
    super.initState();
    _repository = TaskRepository('tasks');
  }

  // 添加任务
  void _addTask() {
    // 添加逻辑
  }

  // 删除任务
  void _deleteTask(int index) {
    // 删除逻辑
  }

  // 更新任务
  void _updateTask(int index, Task task) {
    // 更新逻辑
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Center(
      child: Text('Task Screen'),
    );
  }
}

6. 实现添加、删除和更新任务的功能

在 _TaskScreenState 中实现添加、删除和更新任务的功能。

class _TaskScreenState extends State<TaskScreen> {
  late TaskRepository _repository;

  List<Task> _tasks = [];

  [@override](/user/override)
  void initState() {
    super.initState();
    _repository = TaskRepository('tasks');
    _loadTasks();
  }

  void _loadTasks() async {
    _tasks = await _repository.getAll();
    setState(() {});
  }

  void _addTask() async {
    Task newTask = Task(title: 'New Task');
    await _repository.add(newTask);
    _loadTasks();
  }

  void _deleteTask(int index) async {
    await _repository.delete(index);
    _loadTasks();
  }

  void _updateTask(int index, Task task) async {
    await _repository.update(index, task);
    _loadTasks();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Column(
      children: [
        ElevatedButton(onPressed: _addTask, child: Text('Add Task')),
        Expanded(
          child: ListView.builder(
            itemCount: _tasks.length,
            itemBuilder: (context, index) {
              return ListTile(
                title: Text(_tasks[index].title),
                trailing: Row(
                  mainAxisSize: MainAxisSize.min,
                  children: [
                    IconButton(
                      icon: Icon(Icons.edit),
                      onPressed: () => _updateTask(index, _tasks[index]),
                    ),
                    IconButton(
                      icon: Icon(Icons.delete),
                      onPressed: () => _deleteTask(index),
                    ),
                  ],
                ),
              );
            },
          ),
        ),
      ],
    );
  }
}