在 Flutter 项目中将 Hive 作为数据库与 Provider 集成

  • 什么是Hive?

Hive 是一个 No-SQL 轻量级和快速键值数据库解决方案,它是跨平台的(在移动设备、桌面和 Web 上运行)并且是用纯 Dart 编写的。与不支持 Flutter web 的 sqflite 相比,这使其具有立竿见影的优势——Hive 具有任何原生依赖项,因此它可以在 web 上无缝运行。

  • 深入了解何时以及为什么应该使用 hive。

据统计,在写入或删除方面,Hive 大大优于 SQLite 和 SharedPreferences,在从存储中读取数据方面,SharedPreferences 在读取性能方面与 Hive 不相上下。SQLite 的表现要差得多。下图显示了基准测试是在搭载 Android Q 的 Oneplus 6T 上执行的。

上图说明了为什么应该使用 hive,这带来了一个挥之不去的问题“我什么时候应该使用 hive?”。

“无论你是谁或做什么,迟早你都需要将数据存储在你的应用程序中,然后再检索它。”

当您需要一个简单的数据库在您的设备上存储数据并且不希望从服务器同步时,您可以使用 hive。

  • 在 Flutter 项目中设置 Hive 数据存储

设置 hive 以在您的 Flutter 项目中使用非常简单,只需几个步骤如下所示。

将数据库的 hive 包、TypeAdapters 的 hive_generator、path_provider 包(为设备上的 DB 设置位置)添加到 Flutter 项目中的 pub spec.yaml 文件

创建一个异步函数来设置您的数据库并在此示例中调用运行应用程序的主函数中的函数,我的函数名称是“setUpLocator”。

在 hive 中存储数据时,您将 hive 数据存储中的每个数据部分视为一个盒子,在下图中您可以观察到您需要打开盒子,不要忘记您创建或打开的每个盒子都必须有它的自己的唯一密钥。

为了使您的代码更具可读性和可维护性,建议创建一个类来保存数据库的密钥,如下图所示

通过这几个步骤,您已经 “成功”地在您的颤振项目中设置了 hive,接下来是利用 hive 数据存储来存储您需要在应用程序中存储的任何数据。

  • 在 Flutter 应用程序中执行基本操作,例如从 Hive 数据存储中创建、更新和删除数据

创建数据

您可以使用这几行代码将数据添加到配置单元数据存储中。在下图中,我以用户输入的形式添加了一个字符串列表(标题和描述),这在您更新数据时几乎相同。在幕后,您正在覆盖附加到该蜂巢盒的数据。

获取数据

您可以通过将您的唯一密钥传递给该配置单元框来从配置单元数据存储中获取数据。

盒子的唯一钥匙

删除/删除数据

您可以使用配置单元框的唯一键从配置单元数据存储中删除数据

提供者的方式🥰。

  • 设置你的 hive 包依赖并添加提供程序包(指定的版本可以更新)。
  • 根据您的用例生成并注册您的适配器,并使用构建运行程序包生成文件。
  • 创建 Hive 服务可侦听提供程序并将其添加到多提供程序中的提供程序列表中。
  • 创建您的 BaseViewModel(这是可选的,您的 Hive 服务可以扩展 ChangeNotifier)。
  • 创建您的 Hive 服务类。
  • 将您的 Hive 服务类连接到您的 UI,该 UI 将用作侦听您的 UI 的控制器。
  • 我们将创建一个带有 Hive 服务类的迷你常规检查器应用程序,用于显示和执行基本任务功能。

设置你的hive包依赖并添加provider包(指定的版本可以更新)

您只需要添加项目所需的依赖项,如下所示;

dependencies:
  flutter:
    sdk: flutter

  cupertino_icons: ^1.0.2
  # get_it for dependency injection
  get_it: ^7.2.0
  # provider to handle state
  provider: ^6.0.1
  # the official hive package
  hive: ^2.0.5
  # a dependency to the hive package
  hive_flutter: ^1.1.0
  # hepls format our date and time
  intl: ^0.17.0



dev_dependencies:
  flutter_lints: ^2.0.1
  flutter_test:
    sdk: flutter
  hive_generator: ^1.1.1
  build_runner: ^2.1.7
  • 根据您的用例生成和注册您的适配器,并使用构建运行程序包生成文件

输入数据库字段并生成适配器

import 'package:flutter/material.dart';
import 'package:hive/hive.dart';
part 'routinedb.g.dart';

@HiveType(typeId: 0)
class RoutineDb extends HiveObject {
  @HiveField(0)
  String title;
  @HiveField(1)
  String description;
  @HiveField(2)
  bool missed;
  @HiveField(3)
  bool done;
  @HiveField(4)
  TimeOfDay routineTime;
  @HiveField(5)
  DateTime routimeDate;

  RoutineDb({
    required this.title,
    required this.description,
    required this.missed,
    required this.done,
    required this.routimeDate,
    required this.routineTime,
  });
}

使用 build_runner 包生成适配器

// GENERATED CODE - DO NOT MODIFY BY HAND

part of 'routinedb.dart';

// **************************************************************************
// TypeAdapterGenerator
// **************************************************************************

class RoutineDbAdapter extends TypeAdapter<RoutineDb> {
  @override
  final int typeId = 0;

  @override
  RoutineDb read(BinaryReader reader) {
    final numOfFields = reader.readByte();
    final fields = <int, dynamic>{
      for (int i = 0; i < numOfFields; i++) reader.readByte(): reader.read(),
    };
    return RoutineDb(
      title: fields[0] as String,
      description: fields[1] as String,
      missed: fields[2] as bool,
      done: fields[3] as bool,
      routimeDate: fields[5] as DateTime,
      routineTime: fields[4] as TimeOfDay,
    );
  }

  @override
  void write(BinaryWriter writer, RoutineDb obj) {
    writer
      ..writeByte(6)
      ..writeByte(0)
      ..write(obj.title)
      ..writeByte(1)
      ..write(obj.description)
      ..writeByte(2)
      ..write(obj.missed)
      ..writeByte(3)
      ..write(obj.done)
      ..writeByte(4)
      ..write(obj.routineTime)
      ..writeByte(5)
      ..write(obj.routimeDate);
  }

  @override
  int get hashCode => typeId.hashCode;

  @override
  bool operator ==(Object other) =>
      identical(this, other) ||
      other is RoutineDbAdapter &&
          runtimeType == other.runtimeType &&
          typeId == other.typeId;
}
import 'package:flutter/material.dart';
import 'package:hive/hive.dart';

class TimeOfDayAdapter extends TypeAdapter<TimeOfDay> {
  @override
  final typeId = 101;

  @override
  void write(BinaryWriter writer, TimeOfDay obj) {
    writer
      ..writeByte(2)
      ..writeByte(0)
      ..write(obj.hour)
      ..writeByte(1)
      ..write(obj.minute);
  }

  @override
  TimeOfDay read(BinaryReader reader) {
    var numOfFields = reader.readByte();
    var fields = <int, dynamic>{
      for (var i = 0; i < numOfFields; i++) reader.readByte(): reader.read(),
    };
    return TimeOfDay(hour: fields[0] as int, minute: fields[1] as int);
  }
}
  • 注册您的适配器

创建并将您的 Hive 服务、可侦听的提供者添加到多提供者中的 SingleChildWidget 提供者列表

在本节中,我们将 hive 服务作为 Listenable provider() 添加到提供程序包提供的多提供程序类的提供程序列表中。

创建您的 BaseViewModel(这是可选的,您的 Hive 服务可以扩展 ChangeNotifier)

在本节中,我们创建一个扩展 changeNotifier 的抽象类,该类将包含辅助函数,例如(initState 和 dispose,它们基于计划的显示帧),我们可以在整个应用程序中使用它们来进行状态管理

import 'dart:async';
import 'dart:developer';
import 'package:estate_project/src/utils/enums.dart';
import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:flutter/scheduler.dart';

abstract class BaseViewModel extends ChangeNotifier {
  bool _isLoading = false;
  bool _isDisposed = false;
  bool _isInitializeDone = false;
  ViewState _state = ViewState.idle;

  bool get isLoading => _isLoading;
  bool get isDisposed => _isDisposed;
  ViewState get state => _state;
  bool get isInitialized => _isInitializeDone;

  FutureOr<void> _initState;




  BaseViewModel() {
    SchedulerBinding.instance.addPostFrameCallback((_) {
      //after displaying the frames on schedule we want to run our init function
      //this makes us avoid using stateful widget while using this architecture
      _init();
      log("init called VM...");
    });
  }

  FutureOr<void> initState();
  FutureOr<void> disposeState();

//this serves as an init state
  void _init() async {
    _initState = initState();
    await _initState;
    _isInitializeDone = true;
    initState();
  }

//changes the state of the bool based on the supplied parameter
  changeLoaderStatus(bool status) {
    _isLoading = status;
    notifyListeners();
  }

//we can keep track of the state of the ui with this  function
  changeEnumState(ViewState viewState) {
    _state = viewState;
    notifyListeners();
  }

  @override
  void dispose() {
    _isDisposed = true;
    disposeState();
    super.dispose();
  }
}

创建您的 Hive 服务类

在我们将扩展抽象类 BaseViewModel 的 Hive 服务具体类中,我们将创建基本函数来处理基于逻辑的任务的迷你常规检查器应用程序的基本任务,例如(获取所有任务,将项目添加到任务,创建例行公事...等)。Hive 服务类将更像一个监听我们的用户界面的控制器。

class HiveService extends BaseViewModel {
  @override
  FutureOr<void> initState() async {
    log("instantiating --->>> hive service");
    String hi = getFirstCharactersOfRoutine("Table Cut");
    logConsole(hi);
  }

  @override
  FutureOr<void> disposeState() async {
    //close the hive box after the hive box have been dispose
    await Hive.close();
  }

  //database logic
  List<RoutineDb> routineDbList = [];
  UnmodifiableListView<RoutineDb> get routineDbListGetter =>
      UnmodifiableListView(routineDbList);

  // Create new routine of the routineDb model
  Future<void> createARoutine(RoutineDb routineDb) async {
    Box<RoutineDb> box = await Hive.openBox<RoutineDb>(routineDbBoxKeys);
    await box.add(routineDb);
    routineDbList.add(routineDb);
    routineDbList = box.values.toList();
    notifyListeners();
  }

  // Get a list of routineDb model in the database
  Future<List<RoutineDb>> getRoutineItems() async {
    Box<RoutineDb> box = await Hive.openBox<RoutineDb>(routineDbBoxKeys);
    routineDbList = box.values.toList();
    return routineDbList;
  }

  // remove a routinebd model based on the key in the database
  Future<void> addItem(RoutineDb routineDb) async {
    Box<RoutineDb> box = await Hive.openBox<RoutineDb>(routineDbBoxKeys);
    await box.delete(routineDb.key);
    routineDbList = box.values.toList();
    notifyListeners();
  }
}

将您的 Hive 服务类连接到您的 UI,该 UI 将用作侦听您的 UI 的控制器

下面的代码片段展示了我们如何将 HiveService 连接到我们的 UI 的示例。在这种情况下,OverviewProvider 扩展了 Hive 服务,在我们的 hive 服务中,有一个 getRoutine 函数来获取所有例程

class OverViewScreen extends StatelessWidget {
  const OverViewScreen({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return BaseView<OverViewProvider>(
      vmBuilder: (context) => OverViewProvider(context: context),
      builder: _buildScreen,
    );
  }

  Widget _buildScreen(BuildContext context, OverViewProvider overviewModel) {
    return FutureBuilder<List<RoutineDb>>(
        future: overviewModel.getRoutineItems(),
        builder: (context, snapshot) {
          if (snapshot.hasData) {
            if (overviewModel.routineDbList.isEmpty) {
              return const NoRoutinePlaceHolder();
            }
            return Container(
              margin: EdgeInsets.symmetric(horizontal: 10.w, vertical: 20.h),
              child: SingleChildScrollView(
                child: Column(
                  children: [
                    for (int i = 0; i < overviewModel.routineDbList.length; i++)
                      RoutineTile(
                        routinIsEditable: true,
                        editFunction: () {
                          AppNavigator.pushNamed(
                            editScreen,
                            arguments: overviewModel.routineDbList[i],
                          );
                        },
                        tileSubTitle:
                            DateTimeFormatter.formatDateTimeToNormalString(
                                overviewModel.routineDbList[i].routimeDate),
                        titleString: snapshot.data![i].title,
                      ),
                  ],
                ),
              ),
            );
//if the routine db list is empty

          } else {
            return const Loader();
          }
        });
  }
}

我们将创建一个带有 Hive 服务类的迷你常规检查器应用程序,用于显示和执行基本任务功能

在这种情况下,我将展示向例程添加项目、创建例程、获取例程等功能

  • 添加项目
  // remove a routinebd model based on the key in the database
  Future<void> addItem(RoutineDb routineDb) async {
    Box<RoutineDb> box = await Hive.openBox<RoutineDb>(routineDbBoxKeys);
    await box.delete(routineDb.key);
    routineDbList = box.values.toList();
    notifyListeners();
  }

  • 创建例程

  // Create new routine of the routineDb model
  Future<void> createARoutine(RoutineDb routineDb) async {
    log("ref creating a routine of title =>>> ${routineDb.title}");
    Box<RoutineDb> box = await Hive.openBox<RoutineDb>(routineDbBoxKeys);
    await box.add(routineDb);
    routineDbList.add(routineDb);
    routineDbList = box.values.toList();
    notifyListeners();
  }

  • 例行公事
// Get a list of routineDb model in the database
  Future<List<RoutineDb>> getRoutineItems() async {
    Box<RoutineDb> box = await Hive.openBox<RoutineDb>(routineDbBoxKeys);
    routineDbList = box.values.toList();
    return routineDbList;
  }

我希望你能够看到如何在你的flutter项目中使用 hive 和 provider 的概述。

在这里分享以下这份最新版《flutter进阶学习笔记》资料内容全面、结构清晰,希望能帮助到大家学习flutter并提升自己的实力,如有需要参考的可以看下面 ↓↓↓

有需要的可以复制下方链接,传送直达!!!
https://docs.qq.com/doc/DQmhUZUhnWGhCVEZH
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,839评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,543评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,116评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,371评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,384评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,111评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,416评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,053评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,558评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,007评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,117评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,756评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,324评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,315评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,539评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,578评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,877评论 2 345

推荐阅读更多精彩内容