Flutter对象数据库管理插件objectbox_generator的使用

ObjectBox generator for Dart/Flutter

此包为 ObjectBox Flutter Database 提供代码生成。ObjectBox 是一个高性能的Flutter数据库，用于快速本地Dart对象持久化，完全符合ACID，并且具有开箱即用的高效数据同步功能。

更多详情和使用信息，请参见 objectbox 包。

使用示例

1. 添加依赖

首先，在 pubspec.yaml 文件中添加 objectbox 和 objectbox_generator 依赖：

dependencies:
  flutter:
    sdk: flutter
  objectbox: ^1.0.0 # 检查最新版本

dev_dependencies:
  build_runner: ^2.0.0
  objectbox_generator: ^1.0.0 # 检查最新版本

然后运行以下命令来安装依赖：

flutter pub get

2. 定义实体类

创建一个新的Dart文件（例如 lib/model/todo.dart），定义您的实体类并使用 @Entity 注解：

import 'package:objectbox/objectbox.dart';

@Entity()
class Todo {
  int id;

  @Unique()
  String title;

  bool done = false;

  Todo({this.id = 0, required this.title, this.done = false});
}

3. 生成代码

确保您已经安装了 build_runner，然后运行以下命令以生成必要的代码：

flutter pub run build_runner build

这将在 lib/objectbox.g.dart 中生成代码，包含模式和存储实现。

4. 初始化ObjectBox

在应用程序入口点（例如 lib/main.dart）初始化ObjectBox：

import 'package:flutter/material.dart';
import 'package:objectbox/objectbox.dart';
import 'model/objectbox.g.dart'; // 引入生成的代码

late Store store;

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  store = await openStore();
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'ObjectBox Example',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(title: 'ObjectBox Example Home Page'),
    );
  }
}

5. 使用ObjectBox进行CRUD操作

现在可以在应用程序中使用 store 进行CRUD操作。下面是一个简单的例子，展示如何添加、查询和删除 Todo 实体：

import 'package:flutter/material.dart';
import 'package:objectbox/objectbox.dart';
import 'model/todo.dart';

class MyHomePage extends StatefulWidget {
  MyHomePage({Key? key, required this.title}) : super(key: key);

  final String title;

  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  final TextEditingController _controller = TextEditingController();
  final Box<Todo> _todoBox = store.box<Todo>();
  List<Todo> _todos = [];

  void _addTodo() {
    if (_controller.text.isNotEmpty) {
      final todo = Todo(title: _controller.text);
      _todoBox.put(todo);
      setState(() {
        _todos = _todoBox.getAll();
        _controller.clear();
      });
    }
  }

  void _deleteTodo(Todo todo) {
    _todoBox.remove(todo.id);
    setState(() {
      _todos = _todoBox.getAll();
    });
  }

  @override
  void initState() {
    super.initState();
    _todos = _todoBox.getAll();
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Column(
        children: <Widget>[
          Padding(
            padding: const EdgeInsets.all(8.0),
            child: Row(
              children: <Widget>[
                Expanded(
                  child: TextField(
                    controller: _controller,
                    decoration: InputDecoration(hintText: 'Enter a new task'),
                  ),
                ),
                ElevatedButton(
                  onPressed: _addTodo,
                  child: Text('Add'),
                ),
              ],
            ),
          ),
          Expanded(
            child: ListView.builder(
              itemCount: _todos.length,
              itemBuilder: (context, index) {
                final todo = _todos[index];
                return ListTile(
                  title: Text(todo.title),
                  trailing: IconButton(
                    icon: Icon(Icons.delete),
                    onPressed: () => _deleteTodo(todo),
                  ),
                );
              },
            ),
          ),
        ],
      ),
    );
  }
}

以上就是一个完整的示例，展示了如何在Flutter项目中使用 objectbox_generator 来管理和操作ObjectBox数据库。通过这个例子，您可以更好地理解如何设置、配置以及执行基本的CRUD操作。如果您需要更复杂的功能或遇到任何问题，请参考官方文档或示例项目。

希望上述内容对您有所帮助！如果有其他问题，欢迎继续提问。