Flutter本地数据存储插件Hive的使用

发布于 1周前 作者 eggper 来自 Flutter

Flutter本地数据存储插件Hive的使用

快速、愉悦且安全的NoSQL数据库

Hive是一个用纯Dart编写的轻量级和高性能的键值数据库。它受到Bitcask的启发，提供了跨平台（移动端、桌面端、浏览器）、高性能、简单直观的API、内置强加密等特性，并且不需要任何原生依赖。

功能特性

  • 🚀 跨平台：支持移动设备、桌面应用和浏览器
  • ⚡ 高性能：在读写操作上表现出色
  • ❤️ 简单易用：提供直观友好的API
  • 🔒 内置加密：确保数据安全性
  • 🎈 无原生依赖：完全基于Dart实现
  • 🔋 开箱即用：内置多种实用功能

使用示例

初始化与基本操作

import 'package:hive/hive.dart';
import 'package:hive_flutter/hive_flutter.dart';

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

  // 打开一个名为'myBox'的box
  var box = await Hive.openBox('myBox');

  // 存储数据
  box.put('name', 'David');

  // 获取数据
  var name = box.get('name');

  print('Name: $name'); // 输出: Name: David
}

存储自定义对象

为了存储自定义对象，我们需要为该类型注册适配器。下面是一个完整的例子，展示了如何创建一个Person类并将其保存到Hive中：

定义模型类

首先，在你的项目中添加hive_generator和build_runner作为dev_dependencies，并安装它们：

dev_dependencies:
  hive_generator: ^1.1.0
  build_runner: ^2.0.0

然后定义你的模型类，并使用@HiveType和@HiveField注解来指定字段信息：

part 'person.g.dart';

@HiveType(typeId: 0)
class Person extends HiveObject {
  @HiveField(0)
  String name;

  @HiveField(1)
  int age;

  @HiveField(2)
  List<String> friends;

  Person({required this.name, required this.age, required this.friends});
}

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

flutter packages pub run build_runner build

这将为你生成person.g.dart文件，其中包含了PersonAdapter。

在应用中使用

现在可以在应用程序中使用这个模型了：

import 'package:hive/hive.dart';
import 'package:hive_flutter/hive_flutter.dart';
import 'person.dart'; // 导入你定义的模型类

void main() async {
  await Hive.initFlutter();

  // 注册适配器
  Hive.registerAdapter(PersonAdapter());

  // 打开或创建一个新的box
  var box = await Hive.openBox<Person>('people');

  // 创建并保存一个新的人
  var person = Person(
    name: 'Dave',
    age: 22,
    friends: ['Linda', 'Marc', 'Anne'],
  );
  await box.add(person);

  // 修改属性并保存更改
  person.age = 30;
  await person.save();

  // 从box中获取所有条目
  for (var p in box.values) {
    print(p); // 输出修改后的人员信息
  }

  // 关闭box
  await box.close();
}

集成到Flutter界面

你可以利用ValueListenableBuilder来监听box的变化，并相应地更新UI。例如，实现一个简单的开关组件来切换主题模式：

import 'package:flutter/material.dart';
import 'package:hive/hive.dart';
import 'package:hive_flutter/hive_flutter.dart';

class SettingsPage extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return ValueListenableBuilder(
      valueListenable: Hive.box('settings').listenable(),
      builder: (context, box, widget) {
        return Switch(
          value: box.get('darkMode', defaultValue: false),
          onChanged: (val) async {
            await box.put('darkMode', val);
          },
        );
      },
    );
  }
}

以上就是关于Flutter中使用Hive进行本地数据存储的基本介绍和一些常见用法。更多详细内容可以参考官方文档https://docs.hivedb.dev/。


更多关于Flutter本地数据存储插件Hive的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

Harmonyos Next教程
1 回复

更多关于Flutter本地数据存储插件Hive的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


当然，下面是一个关于如何在Flutter应用中使用Hive进行本地数据存储的详细代码示例。Hive是一个轻量级、快速且易于使用的本地数据库，非常适合Flutter应用。

前提条件

  1. 确保你的Flutter环境已经设置好。
  2. 添加Hive依赖到你的pubspec.yaml文件中：
dependencies:
  flutter:
    sdk: flutter
  hive: ^2.0.4  # 请检查最新版本号
  hive_flutter: ^1.1.0  # 如果需要使用Hive的Flutter特定功能，如HiveBoxBuilder
  1. 运行flutter pub get来安装依赖。

步骤

1. 初始化Hive

在应用启动时初始化Hive。通常在main.dart文件中进行：

import 'package:flutter/material.dart';
import 'package:hive/hive.dart';
import 'package:hive_flutter/hive_flutter.dart';
import 'package:path_provider/path_provider.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  
  // 获取应用文档目录
  final appDocumentDirectory = await getApplicationDocumentsDirectory();
  Hive.init(appDocumentDirectory.path);

  // 打开一个Hive Box（如果不存在，则会创建）
  await Hive.openBox('myBox');

  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Hive Demo',
      home: Scaffold(
        appBar: AppBar(
          title: Text('Hive Demo'),
        ),
        body: Center(
          child: MyHomePage(),
        ),
      ),
    );
  }
}

2. 创建数据模型

Hive要求数据模型继承自HiveObject或使用@HiveType注解。这里我们使用@HiveType注解：

import 'package:hive/hive.dart';

part 'user_model.g.dart';

@HiveType(typeId: 0)
class User {
  @HiveField(0)
  String name;

  @HiveField(1)
  int age;

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

运行flutter pub run build_runner build来生成user_model.g.dart文件。

3. 使用Hive存储和读取数据

在UI组件中使用Hive存储和读取数据：

import 'package:flutter/material.dart';
import 'package:hive/hive.dart';
import 'user_model.dart';

class MyHomePage extends StatefulWidget {
  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  late Box<User> _box;

  @override
  void initState() {
    super.initState();
    _box = Hive.box<User>('myBox');
  }

  void _saveUser() {
    final user = User(name: 'Alice', age: 30);
    _box.put('user1', user);
    setState(() {});
  }

  void _readUser() {
    final user = _box.get('user1');
    print('Retrieved User: ${user?.name}, Age: ${user?.age}');
  }

  @override
  Widget build(BuildContext context) {
    return Column(
      mainAxisAlignment: MainAxisAlignment.center,
      children: <Widget>[
        ElevatedButton(
          onPressed: _saveUser,
          child: Text('Save User'),
        ),
        ElevatedButton(
          onPressed: _readUser,
          child: Text('Read User'),
        ),
      ],
    );
  }
}

总结

以上代码展示了如何在Flutter应用中使用Hive进行本地数据存储。从初始化Hive，定义数据模型，到存储和读取数据，这些步骤帮助你快速上手Hive。Hive是一个强大的本地存储解决方案，适用于各种Flutter应用。

请根据你的实际需求调整代码，例如错误处理、数据模型复杂度等。

回到顶部