Flutter本地存储插件hive_local_storage的使用

hive_local_storage简介

hive_local_storage 是一个用于在Flutter应用程序中存储用户会话和缓存值的工具包。它利用了Hive进行缓存，并使用flutter_secure_storage来存储加密密钥，以确保会话存储的安全性。

开始使用

添加依赖

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

dependencies:
  hive_local_storage: latest

dev_dependencies:
  build_runner: latest
  hive_generator: latest

导入包

在需要使用的Dart文件顶部导入hive_local_storage：

import 'package:hive_local_storage/hive_local_storage.dart';

注册自定义适配器

如果要使用自定义类，请注册相应的适配器。注意：避免为数据类使用typeId=0，因为该ID已被会话类占用。

final localStorage = await LocalStorage.getInstance(registerAdapters:(){
  Hive..registerAdapter(adapter1)..registerAdapter(adapter2);
});

会话管理

存储会话

final storage = await LocalStorage.getInstance();
await storage.saveToken('accessToken','refreshToken'); // refreshToken是可选的

获取会话

final storage = await LocalStorage.getInstance();
final accessToken = storage.accessToken;
final refreshToken = storage.refreshToken;
final bool hasSession = storage.hasSession;

StreamSubscription<bool> _subscription = storage.onSessionChange.listen((bool hasSession){
  // 执行相应操作
});
_subscription.cancel(); // 取消订阅

final isTokenExpired = localStorage.isTokenExpired;

移除会话

final storage = await LocalStorage.getInstance();
storage.clearSession();

自定义盒子

当您想直接存储Hive对象时，可以打开自定义盒子。为此，您需要在初始化时为Hive对象注册适配器。

/// typeId 必须在 1-223 之间
@HiveType(typeId:1,adapterName:'TestAdapter')
class TestModel extends HiveObject{
  @HiveField(0)
  late String firstName;
}

final localStorage = await LocalStorage.getInstance([TestAdapter()]);
await localStorage.openBox<TestModel>(boxName:'__TEST_BOX__',typeId:1)

从自定义盒子读取数据

final localStorage = await LocalStorage.getInstance();
List<TestModel> data = localStorage.values<TestModel>('__TEST_BOX__');

向自定义盒子写入数据

final localStorage = await LocalStorage.getInstance();
void storeData() async {
  final testModel = TestModel();
  await localStorage.add<TestModel>(boxName: '__TEST_BOX__',value:testModel);

  final listData = <TestModel>[TestModel(),TestModel()];
  await localStorage.addAll<TestModel>(boxName: '__TEST_BOX__',values:listData);
}

从自定义盒子删除数据

final localStorage = await LocalStorage.getInstance();
void deleteData(TestModel test) async {
  await localStorage.delete<TestModel>(boxName: '__TEST_BOX__',value:test);
}

更新自定义盒子中的数据

final localStorage = await LocalStorage.getInstance();
void updateData(TestModel test) async {
  await localStorage.update<TestModel>(boxName: '__TEST_BOX__',value:test);
}

使用Riverpod

/// 创建provider
final localStorageProvider = Provider<LocalStorage>((ref)=>throw UnImplementedError());

/// 在main函数中
void main() {
  runZonedGuarded(
    () async {
      final localStorage = await LocalStorage.getInstance();
      runApp(
        ProviderScope(
          overrides: [
            localStorageProvider.overrideWithValue(localStorage),
          ],
          child: App(),
        ),
      );
    },
    (e, _) => throw e,
  );
}

缓存操作

写入缓存

final localStorage = await LocalStorage.getInstance();

// 存储单个值
await localStorage.put<int>(key:'count',value:0);

// 存储多个值
await localStorage.putAll(Map<String, dynamic> entries);

// 存储列表数据
await localStorage.putList<Model>(key:'KeyName',value:<Model>[]);

读取缓存

final localStorage = await LocalStorage.getInstance();

// 获取单个值
final count = localStorage.get<int>(key:'count');

// 监听键值变化
localStorage.watchKey(key:'key').listen((value){
  // 执行相应操作
});

// 读取列表数据
final listData = localStorage.getList<Model>(key:'Your KeyName');

删除缓存

final localStorage = await LocalStorage.getInstance();

// 移除单个值
await localStorage.remove(key:'count');

// 清空所有缓存
await localStorage.clear();

// 清空会话和缓存
await localStorage.clearAll();

示例代码

下面是一个完整的示例代码，展示了如何在Flutter应用中使用hive_local_storage：

import 'dart:math';

import 'package:flutter/material.dart';
import 'package:hive_local_storage/hive_local_storage.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});
  final String title;

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

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;
  late LocalStorage _localStorage;

  void _incrementCounter() async {
    await _localStorage.put(key: 'counter', value: Random().nextInt(100));
  }

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

  void _init() async {
    _localStorage = await LocalStorage.getInstance();
    _counter = _localStorage.get<int>(key: 'counter', defaultValue: 0)!;

    _localStorage.watchKey<int>(key: 'counter').listen((event) {
      setState(() {
        _counter = event ?? 0;
      });
    });
  }

  void _remove() async {
    await _localStorage.clear();
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            const Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headlineMedium,
            ),
            ElevatedButton(onPressed: _remove, child: const Text('Remove')),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),
    );
  }
}

通过以上内容，您可以了解如何在Flutter项目中使用hive_local_storage插件来进行本地存储。希望这些信息对您有所帮助！