OpenHarmony 对存储框架—MMKV

别说我什么都不会
249 阅读4分钟

介绍

一款小型键值对存储框架

  • 支持存储 number、boolean、string、Set类型数据存储
  • 支持继承组件中 SerializeBase.ets 的 class 类对象的序列化反序列化
  • 支持存储数据备份
  • 支持存储数据恢复

下载安装

ohpm install @ohos/mmkv

使用

1、初始化：设置 mmkv 保存文件根目录(rootPath)和缓存目录(cachePath)

MMKV.initialize(rootPath, cachePath)

2、实例化 mmkv：

let mmkv = MMKV.getBackedUpMMKVWithID(mmapID, MMKV.SINGLE_PROCESS_MODE, "Tencent MMKV", backupRootDir);

3、存取键值对数据:

3.1 常用数据类型：boolean、number、string、Set

存数据示例：
mmkv.encodeBool('boolData', false)
mmkv.encodeNumber('numberData', 3.0122)
mmkv.encodeString('stringData', 'dsfsg')
let set1 = new Set<string>()
set1.add('ass1')
mmkv.encodeSet('setData', set1)
取数据示例：
mmkv.decodeBool('boolData')
mmkv.decodeNumber('stringData')
mmkv.decodeString('numberData')
mmkv.decodeSet('setData')

3.2 类对象数据的序列化反序列化

类对象需要继承 SerializeBase类，需序列化属性需要标识注解@Serialize() 如：
class MyClass extends SerializeBase{
    @Serialize()
    public code: number = 0;
    public title: string = 'titles';
    @Serialize()
    public description: string = 'descs';
}
存数据：
let myClass1 = new MyClass(1, 't1', 'desc1')
kv.encodeSerialize('serialize111', myClass1)
取数据：
let myClass2 = kv.decodeSerialize('serialize111', new MyClass())

4、系统轻量级存储数据转存为mmkv存储

//name:context：上下文, preference文件名, callback：异步回调
preferencesToMMKV(name: string, callback: ICallBack, context: Context)

5、设置加密密钥

mmkv.reCryptKey('Key_seq_1') //Key_seq_1：加密密钥

6、数据备份

备份otherDir路径mmapID的mmkv存储数据到backupRootDir
MMKV.backupOneToDirectory(mmapID, backupRootDir, otherDir)//mmapID：需要备份的mmapID；backupRootDir：备份到目标路径；otherDir：待备份所在路径
备份全部mmkv存储数据到backupRootDir
MMKV.backupAllToDirectory(backupRootDir) //backupRootDir：备份到目标路径

7、数据恢复

从srcDir恢复mmkv存储数据
MMKV.restoreOneMMKVFromDirectory(mmapID, srcDir, otherDir)//mmapID：需要恢复的mmapID；srcDir：目标路径；otherDir：待备份所在路径
恢复srcDir路径下的全部mmkv存储数据
MMKV.restoreAllFromDirectory(srcDir) //srcDir： 目标路径

8、清除所有存储数据

mmkv.clearAll()

DD一下：鸿蒙开发各类文档，可关注公Z号<程序猿百晓生>霍取。

1.OpenHarmony开发基础
2.OpenHarmony北向开发环境搭建
3.鸿蒙南向开发环境的搭建
4.鸿蒙生态应用开发白皮书V2.0 & V3.0
5.鸿蒙开发面试真题（含参考答案） 
6.TypeScript入门学习手册
7.OpenHarmony 经典面试题(含参考答案)
8.OpenHarmony设备开发入门【最新版】
9.沉浸式剖析OpenHarmony源代码
10.系统定制指南
11.【OpenHarmony】Uboot 驱动加载流程
12.OpenHarmony构建系统--GN与子系统、部件、模块详解
13.ohos开机init启动流程
14.鸿蒙版性能优化指南
.......

接口说明

方法名入参接口描述
version无获取 native版本
getRootDir无获取存储路径
pageSize无获取设备内存页数量
getDefaultMMKVmode?: number, cryptKey?: string创建默认实例
totalSize无获取基础文件的大小
encodekey: string, value: number、Set、string、boolean存储数据
decodeStringkey: string, defaultValue?: string根据key获取字符串值
decodeBoolkey: string, defaultValue?: boolean根据key获取布尔值
decodeNumberhandle: string, key: string, defaultValue: number根据key获取number值
decodeSetkey: string, defaultValue?: Set根据key获取数组值
containsKeykey: string检查是否包含传入的key
getCryptKey无获取加密密钥
getMMapID无获取实例id
removeValueForKeykey: string按key移除值
removeValuesForKeysvalue: string[]批量移除值
clearAll无清除所有键值
count无获取key的数量
isFileValidmmapID: string检查MMKV文件是否有效
reCryptKeycryptKey: string重新设置密钥
backupOneToDirectorymmapID: string, dstDir: string, rootPath: string将一个MMKV实例备份到dstDir
backupAllToDirectorydstDir: string将所有MMKV实例备份到dstDir
restoreOneMMKVFromDirectorymmapID: string, srcDir: string, rootPath: string从srcDir恢复一个MMKV实例
restoreAllFromDirectorysrcDir: string从srcDir恢复所有MMKV实例
initializeroot: string, cachePath: string, logLevel?: MMKVLogLevel初始化MMKV
getBackedUpMMKVWithIDmmapID: string, mode: number, crpKey: string, rootPath: string获取备份MMKV实例
encodeSerializekey: string, value: SerializeBase存储序列化数据
decodeSerializekey: string, defaultValue: T按key获取序列化数据
encodeStringkey: string, value: string存储String数据
encodeSetkey: string, value: Set存储Set数据
encodeBoolkey: string, value: boolean存储Bool数据
encodeNumberkey: string, value: number存储Number数据
getAllKeys无获取所有key
clearMemoryCache无清除MMKV实例的内存缓存
actualSize无获取MMKV实例的实际使用大小
getHandle无获取MMKV 实例句柄
close无关闭mmkv实例
trim无清除MMKV实例中的所有键值
checkContentChangedByOuterProcess无手动检查进程间内容更改
setLogLevellevel: MMKVLogLevel设置日志级别
checkReSetCryptKeycryptKey: string重置加密密钥（不会加密或解密任何内容）
simpleLoglevel: MMKVLogLevel, message: string打印日志
preferencesToMMKVcontext: Context, name: string, callback: ICallBack系统轻量级存储数据转存为mmkv存储
LogUtil.dmessage: string打印debug类型日志
LogUtil.imessage: string打印info类型日志
LogUtil_emessage: string打印error类型日志
isEnd无获取文件读取是否结束
close无文件读取关闭

单元测试用例详情见TEST.md

约束与限制

在下述版本验证通过：

  • DevEco Studio: 4.0 (4.0.3.513), SDK: API10 (4.0.10.10)
  • DevEco Studio: 4.0 Canary2(4.0.3.312), SDK: API10 (4.0.9.3)
  • DevEco Studio: 3.1 Beta2(3.1.0.400), SDK: API9 Release(3.2.11.9)

目录结构

|----MMMKV
|     |---- entry  # 示例代码文件夹
|     |---- library  # MMMKV库文件夹
|           |---- index.ets  # 对外接口
|     |---- README.md  # 安装使用方法
avatar
文章
阅读
粉丝