代码拉取完成,页面将自动刷新
一款小型键值对存储框架
ohpm install @ohos/mmkv
OpenHarmony ohpm 环境配置等更多内容,请参考如何安装 OpenHarmony ohpm 包
MMKV.initialize(rootPath, cachePath)
let mmkv = MMKV.getBackedUpMMKVWithID(mmapID, MMKV.SINGLE_PROCESS_MODE, "Tencent MMKV", backupRootDir);
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')
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())
//name:context:上下文, preference文件名, callback:异步回调
preferencesToMMKV(name: string, callback: ICallBack, context: Context)
mmkv.reCryptKey('Key_seq_1') //Key_seq_1:加密密钥
MMKV.backupOneToDirectory(mmapID, backupRootDir, otherDir)//mmapID:需要备份的mmapID;backupRootDir:备份到目标路径;otherDir:待备份所在路径
MMKV.backupAllToDirectory(backupRootDir) //backupRootDir:备份到目标路径
MMKV.restoreOneMMKVFromDirectory(mmapID, srcDir, otherDir)//mmapID:需要恢复的mmapID;srcDir:目标路径;otherDir:待备份所在路径
MMKV.restoreAllFromDirectory(srcDir) //srcDir: 目标路径
mmkv.clearAll()
方法名 | 入参 | 接口描述 |
---|---|---|
version | 无 | 获取 native版本 |
getRootDir | 无 | 获取存储路径 |
pageSize | 无 | 获取设备内存页数量 |
getDefaultMMKV | mode?: number, cryptKey?: string | 创建默认实例 |
totalSize | 无 | 获取基础文件的大小 |
encode | key: string, value: number、Set、string、boolean | 存储数据 |
decodeString | key: string, defaultValue?: string | 根据key获取字符串值 |
decodeBool | key: string, defaultValue?: boolean | 根据key获取布尔值 |
decodeNumber | handle: string, key: string, defaultValue: number | 根据key获取number值 |
decodeSet | key: string, defaultValue?: Set | 根据key获取数组值 |
containsKey | key: string | 检查是否包含传入的key |
getCryptKey | 无 | 获取加密密钥 |
getMMapID | 无 | 获取实例id |
removeValueForKey | key: string | 按key移除值 |
removeValuesForKeys | value: string[] | 批量移除值 |
clearAll | 无 | 清除所有键值 |
count | 无 | 获取key的数量 |
isFileValid | mmapID: string | 检查MMKV文件是否有效 |
reCryptKey | cryptKey: string | 重新设置密钥 |
backupOneToDirectory | mmapID: string, dstDir: string, rootPath: string | 将一个MMKV实例备份到dstDir |
backupAllToDirectory | dstDir: string | 将所有MMKV实例备份到dstDir |
restoreOneMMKVFromDirectory | mmapID: string, srcDir: string, rootPath: string | 从srcDir恢复一个MMKV实例 |
restoreAllFromDirectory | srcDir: string | 从srcDir恢复所有MMKV实例 |
initialize | root: string, cachePath: string, logLevel?: MMKVLogLevel | 初始化MMKV |
getBackedUpMMKVWithID | mmapID: string, mode: number, crpKey: string, rootPath: string | 获取备份MMKV实例 |
encodeSerialize | key: string, value: SerializeBase | 存储序列化数据 |
decodeSerialize | key: string, defaultValue: T | 按key获取序列化数据 |
encodeString | key: string, value: string | 存储String数据 |
encodeSet | key: string, value: Set | 存储Set数据 |
encodeBool | key: string, value: boolean | 存储Bool数据 |
encodeNumber | key: string, value: number | 存储Number数据 |
getAllKeys | 无 | 获取所有key |
clearMemoryCache | 无 | 清除MMKV实例的内存缓存 |
actualSize | 无 | 获取MMKV实例的实际使用大小 |
getHandle | 无 | 获取MMKV 实例句柄 |
close | 无 | 关闭mmkv实例 |
trim | 无 | 清除MMKV实例中的所有键值 |
checkContentChangedByOuterProcess | 无 | 手动检查进程间内容更改 |
setLogLevel | level: MMKVLogLevel | 设置日志级别 |
checkReSetCryptKey | cryptKey: string | 重置加密密钥(不会加密或解密任何内容) |
simpleLog | level: MMKVLogLevel, message: string | 打印日志 |
preferencesToMMKV | context: Context, name: string, callback: ICallBack | 系统轻量级存储数据转存为mmkv存储 |
LogUtil.d | message: string | 打印debug类型日志 |
LogUtil.i | message: string | 打印info类型日志 |
LogUtil_e | message: string | 打印error类型日志 |
isEnd | 无 | 获取文件读取是否结束 |
close | 无 | 文件读取关闭 |
单元测试用例详情见TEST.md
在下述版本验证通过:
|----MMMKV
| |---- entry # 示例代码文件夹
| |---- library # MMMKV库文件夹
| |---- index.ets # 对外接口
| |---- README.md # 安装使用方法
使用过程中发现任何问题都可以提 Issue 给我们,当然,我们也非常欢迎你给我们发 PR 。
本项目基于 BSD 3-Clause License ,请自由地享受和参与开源。
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。