Flutter数据库代码生成插件hive_generator的使用

Flutter数据库代码生成插件hive_generator的使用

hive扩展

hive_generator 是一个用于Hive数据库的代码生成插件，它可以帮助您自动生成Hive对象的适配器代码。请参考 hive 的文档获取更多信息。

Hive示例

要查看使用Hive的示例，请访问 这里。

接下来，我们将提供一个完整的示例来演示如何在Flutter项目中使用 hive_generator 插件。

完整示例Demo

1. 添加依赖项

   在您的 pubspec.yaml 文件中添加以下依赖项：

   dependencies:
     flutter:
       sdk: flutter
     hive: ^2.0.4
     hive_flutter: ^1.1.0
   
   dev_dependencies:
     build_runner: ^2.0.4
     hive_generator: ^1.1.0
   

2. 创建实体类

   创建一个新的Dart文件（例如 user.dart），并定义一个简单的实体类：

   import 'package:hive/hive.dart';
   
   // 使用 [@HiveType](/user/HiveType) 注解标识这个类是一个Hive对象
   [@HiveType](/user/HiveType)(typeId: 0)
   class User extends HiveObject {
     // 使用 @HiveField 注解标识字段
     @HiveField(0)
     String name;
   
     @HiveField(1)
     int age;
   
     User({required this.name, required this.age});
   }
   

3. 生成适配器

   运行以下命令生成适配器代码：

   flutter packages pub run build_runner build
   

   这将生成一个名为 user.g.dart 的文件，其中包含 User 类的适配器代码。

4. 初始化Hive

   在您的 main.dart 文件中初始化Hive：

   import 'package:flutter/material.dart';
   import 'package:hive_flutter/hive_flutter.dart';
   import 'user.dart'; // 导入实体类
   
   void main() async {
     // 初始化Hive
     await Hive.initFlutter();
     
     // 注册适配器
     Hive.registerAdapter(UserAdapter());
     
     runApp(MyApp());
   }
   
   class MyApp extends StatelessWidget {
     @override
     Widget build(BuildContext context) {
       return MaterialApp(
         home: HomeScreen(),
       );
     }
   }
   

5. 使用Hive存储数据

   创建一个 HomeScreen 小部件来演示如何使用Hive存储和检索数据：

   class HomeScreen extends StatelessWidget {
     @override
     Widget build(BuildContext context) {
       return Scaffold(
         appBar: AppBar(title: Text('Hive Demo')),
         body: ValueListenableBuilder<Box<User>>(
           valueListenable: Hive.box<User>('users').listenable(),
           builder: (context, box, widget) {
             final users = box.values.toList();
             return ListView.builder(
               itemCount: users.length,
               itemBuilder: (context, index) {
                 final user = users[index];
                 return ListTile(
                   title: Text(user.name),
                   subtitle: Text('Age: ${user.age}'),
                 );
               },
             );
           },
         ),
         floatingActionButton: FloatingActionButton(
           onPressed: () async {
             // 打开或创建一个名为 'users' 的盒子
             final box = await Hive.openBox<User>('users');
             
             // 添加一个新的用户
             box.add(User(name: 'John Doe', age: 30));
           },
           child: Icon(Icons.add),
         ),
       );
     }
   }