Hive 在 Flutter 中的使用

前言

官方原话:Hive是为Flutter设计的。如果您需要一个轻量级的数据存储来支持您的应用,它非常合适。添加所需的依赖并初始化Hive后,您就可以在项目中使用Hive了

Hive 是一款用纯 Dart 编写的轻量级且极速的键值数据库,其灵感来源于 Bitcask。

其实简单的来说,上手简单

特点

  • 跨平台:移动、桌面、浏览器
  • ⚡ 性能卓越(参见基准测试)
  • ❤️ 简单、强大、直观的应用程序接口
  • 内置强大的加密功能
  • 无本地依赖性

使用

第一步,先引入库

dependencies: 
  hive: ^2.2.3
  hive_flutter: ^1.1.0

dev_dependencies: 
  hive_generator: 2.0.1
  build_runner: 2.4.8 

接下来在main 里初始化

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await Hive.initFlutter();
  Hive.registerAdapter(ContactAdapter());//实体方式保存
  await Hive.openBox(userBox);//直接键对值保存
  runApp(const MyApp());
}

疑问一:ContactAdapter 这个怎么来的呢? 先看图

在这里插入图片描述

我们在目录(这里为了测试,放在根目录了,建议是放置在数据目录)新建contact_page.dart

import 'package:hive/hive.dart';

part 'contact_page.g.dart';//一定要注意,跟实体名称一致

@HiveType(typeId: 0)
class Contact extends HiveObject {
  @HiveField(0)
  final String name;
  @HiveField(1)
  final int age;

  Contact({required this.name,required this.age});
}

接下来我们在命令窗口执行这串命令,会自动生成文件

flutter packages pub run build_runner build --delete-conflicting-outputs

在这里插入图片描述

下面为主页demo的完整代码

const String userBox = “user_box”; //临时键值存储表
const String contactBox = “contact_box”; //实体数据表
class MyHomePage extends StatefulWidget {
const MyHomePage({
super.key,
});

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

class _MyHomePageState extends State {
final _shoppingBox = Hive.box(userBox);

int _counter = 0;
List contractLis = [];

void _add() {
_counter++;
addData(_counter);
_shoppingBox.put(‘key’, ‘我是普通的键值’);
loadData();
}

@override
void initState() {
super.initState();
loadData();
}

Future addData(int index) async {
var box = await Hive.openBox(contactBox); // 存储数据
var user = Contact(name: ‘Johnny i n d e x ′ , a g e : i n d e x ) ; a w a i t b o x . p u t ( ′ index', age: index); await box.put(' index,age:index);awaitbox.put({DateTime.timestamp().millisecond}’, user);
}

Future loadData() async {
// 读取数据
var box = await Hive.openBox(contactBox); // 存储数据
contractLis = box.values.toList();
contractLis.sort((a, b) => b.age.compareTo(a.age));
setState(() {});
}

@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
backgroundColor: Theme.of(context).colorScheme.inversePrimary,
title: Text(“demo”),
),
body: Center(
child: Column(
mainAxisAlignment: MainAxisAlignment.center,
children: [
const Text(
‘简单存储’,
),
Text(
_shoppingBox.get(‘key’) ?? “暂无设置”,
),
const SizedBox(
height: 12,
),
const Text(
‘实体存储’,
),
…contractLis
.map((e) => Text(
e.name ?? “”,
))
.toList(),
],
),
),
floatingActionButton: FloatingActionButton(
onPressed: _add,
child: const Icon(Icons.add),
), // This trailing comma makes auto-formatting nicer for build methods.
);
}
}


说明
--

final \_shoppingBox = Hive.box(userBox); 可以不用在Future 调用,非常的舒服 但是要执行 openBox操作一定需要,切记

var box = await Hive.openBox(contactBox);


首次编译成功后,本地会增加俩文件 user\_box 和 contact\_box,这俩文件是存储咋们的内容的文件

```bash
在这里插入代码片

如果你看到了这里,觉得文章写得不错就给个赞呗?
更多Android进阶指南 可以扫码 解锁更多Android进阶资料


在这里插入图片描述
敲代码不易,关注一下吧。ღ( ´・ᴗ・` )

<think>嗯,用户想了解如何在Flutter中安装和使用Hive数据库。首先,我需要回忆一下Hive的相关知识,确保信息准确。记得Hive是一个轻量级的NoSQL数据库,适合在移动端使用,特别是因为它不需要native依赖,而且性能不错。 首先,安装部分。用户需要在pubspec.yaml文件中添加依赖项。根据引用[2],应该包括hivehive_flutter,还有dev_dependencies里的hive_generator和build_runner。需要确认版本号是否正确,但通常用户可以使用最新版本,所以可以提示他们查看最新版本号,或者直接用^符号让pub自动选择兼容版本。 然后,初始化Hive。引用[1]提到Hive.initFlutter(),这应该是初始化Flutter项目的步骤,通常在main函数里执行。可能需要先确保WidgetsFlutterBinding初始化,所以顺序应该是先调用WidgetsFlutterBinding.ensureInitialized(),然后再初始化Hive。 接下来是创建数据模型。Hive需要注册适配器,所以用户需要定义模型类并用Hive注解标记。比如@HiveType(typeId: 0)和@HiveField()。然后运行build_runner生成适配器代码,这部分需要提醒用户使用flutter pub run build_runner build命令,或者使用--watch参数自动监测变化。 之后是打开Box,进行数据操作。打开Box可能需要异步处理,所以示例代码应该用async/await。增删改查的操作相对简单,但需要展示基本的CRUD操作,比如add、get、put、delete等。 还要注意引用[1]提到的Box的listenable()方法,这可能用于监听数据变化,结合Flutter的StreamBuilder来更新UI。不过用户的问题主要是安装和使用,这部分可能属于进阶内容,可以稍微提及,但不需要深入。 用户可能需要常见问题解答,比如版本冲突、适配器未注册的错误,或者生成代码时的问题。需要提醒他们检查依赖版本是否兼容,确保适配器已经正确注册,并正确运行生成命令。 现在需要整理步骤,确保结构清晰,按照安装、初始化、模型创建、操作数据的顺序来写。示例代码要正确,特别是Hive.initFlutter()的位置,还有打开Box的方法。另外,引用标记要正确对应到用户提供的引用内容,比如引用[1]和引用[2]分别对应初始化和添加依赖的部分。 可能还需要检查是否有遗漏的步骤,比如是否需要在main函数里异步初始化,因为Hive的初始化可能是异步的。需要确保示例代码正确处理了这一点,比如在main函数前加async,然后在里面await Hive.initFlutter()。 最后,生成相关问题,要围绕Hive的安装使用展开,比如性能优化、数据迁移、与其他数据库对比等。这些问题应该帮助用户进一步深入学习Hive的相关知识。</think>### Flutter Hive 安装与使用教程 #### 一、安装依赖 1. **添加依赖项** 在 `pubspec.yaml` 文件的 `dependencies` 和 `dev_dependencies` 中添加以下内容[^2]: ```yaml dependencies: hive: ^[版本号] # 例如 2.2.3 hive_flutter: ^[版本号] dev_dependencies: hive_generator: ^[版本号] build_runner: ^[版本号] ``` 运行 `flutter pub get` 安装依赖。 2. **初始化 Hive** 在 `main.dart` 的 `main` 函数中初始化 Hive[^1]: ```dart void main() async { WidgetsFlutterBinding.ensureInitialized(); await Hive.initFlutter(); // 初始化 Hive runApp(MyApp()); } ``` --- #### 二、创建数据模型 1. **定义数据类** 使用 `@HiveType` 和 `@HiveField` 注解标记模型类: ```dart import 'package:hive/hive.dart'; @HiveType(typeId: 0) class User { @HiveField(0) String name; @HiveField(1) int age; User(this.name, this.age); } ``` 2. **生成适配器** 运行命令生成适配器代码: ```bash flutter pub run build_runner build ``` --- #### 三、使用 Hive 存储数据 1. **打开 Box(数据库表)** ```dart await Hive.openBox('userBox'); // 打开名为 "userBox" 的存储容器 final userBox = Hive.box('userBox'); ``` 2. **增删改查操作** ```dart // 写入数据 userBox.add(User('Alice', 25)); // 读取数据 final user = userBox.getAt(0) as User; print(user.name); // 输出: Alice // 更新数据 userBox.putAt(0, User('Bob', 30)); // 删除数据 userBox.deleteAt(0); ``` --- #### 四、高级功能 1. **监听数据变化** 使用 `listenable()` 监听 Box 变化: ```dart ValueListenableBuilder( valueListenable: Hive.box('userBox').listenable(), builder: (context, box, _) { return Text('数据已更新: ${box.length}'); }, ) ``` --- #### 常见问题 - **版本冲突**:确保所有 Hive 相关包版本一致。 - **适配器未注册**:在初始化后调用 `Hive.registerAdapter(UserAdapter())`。 - **生成代码失败**:检查注解语法,或运行 `flutter pub run build_runner build --delete-conflicting-outputs`。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值