@amazon-devices/react-native-mmkv库,可以通过快速直接的JS绑定到原生C++库在React Native应用程序中使用MMKV。有关更多信息,请参见Tencent/MMKV(仅提供英文版)。
安装
- 在
package.json文件中添加JavaScript库依赖项。选择适用于您的React Native版本的选项卡。
- React Native 0.72
- React Native 0.83
"dependencies": {
...
"@amazon-devices/react-native-mmkv": "~1.0.0",
...
}
"dependencies": {
...
"@amazon-devices/react-native-mmkv": "~1.0.11",
...
}
- 使用
npm install命令重新安装依赖项。
示例
为随机键值对创建简单存储的示例。import React, { useState } from 'react';
import { Button, StyleSheet, Text, View } from 'react-native';
import { MMKV, useMMKVString, useMMKVNumber, useMMKVBoolean } from '@amazon-devices/react-native-mmkv';
const storage = new MMKV();
export const App = () => {
const [hookUsername, setHookUsername] = useMMKVString('hookUsername');
const [hookAge, setHookAge] = useMMKVNumber('hookAge');
const [hookIsLoggedIn, setHookIsLoggedIn] = useMMKVBoolean('hookIsLoggedIn');
const [status, setStatus] = useState<string>("");
const handleSetData = () => {
storage.set('username', 'JohnDoe');
storage.set('isLoggedIn', true);
storage.set('age', 30);
setStatus('Stored username, isLoggedIn and age');
};
const handleGetStringData = () => {
const username = storage.getString('username');
setStatus(`Retrieved Data Username: ${username || 'None'}`);
};
const handleGetNumberData = () => {
const age = storage.getNumber('age');
setStatus(`Retrieved Data Age: ${age}`);
};
const handleGetBooleanData = () => {
const isLoggedIn = storage.getBoolean('isLoggedIn');
setStatus(`Retrieved Data Is Logged In: ${isLoggedIn}`);
};
const handleCheckKey = () => {
const hasUsernameKey = storage.contains('username');
setStatus(`Username key exists: ${hasUsernameKey}`);
};
const handleListKeys = () => {
const allKeys = storage.getAllKeys();
setStatus(`Keys: ${allKeys.join(', ')}`);
};
const handleDeleteKey = () => {
storage.delete('username');
setStatus('Deleted the "username" key.');
};
const handleClearAll = () => {
storage.clearAll();
setStatus('All data have been cleared from storage.');
};
const handleRecryptStorage = () => {
storage.recrypt('newEncryptionKey');
setStatus('Stored values have been recrypted with a new key.');
};
const handleDisplaySize = () => {
setStatus(`Stored size: ${storage.size} bytes`);
};
const handleHookSetData = () => {
setHookUsername('JaneDoe');
setHookIsLoggedIn(false);
setHookAge(25);
setStatus('Stored username, isLoggedIn and age');
};
const handleUseMMKVStringData = () => {
setStatus(`Retrieved Hook Username: ${hookUsername || 'None'}`);
};
const handleUseMMKVNumberData = () => {
setStatus(`Retrieved Hook Age: ${hookAge}`);
};
const handleUseMMKVBooleanData = () => {
setStatus(`Retrieved Hook Hook Is Logged In: ${hookIsLoggedIn}`);
};
return (
<View style={styles.container} testID="mmkv-app-container">
<Text style={styles.title}>React Native MMKV示例</Text>
<Text style={styles.title} testID="mmkv-status">状态:{status}</Text>
<Button title="Set Data" onPress={handleSetData} testID="mmkv-app-set-button" />
<Button title="Get String" onPress={handleGetStringData} testID="mmkv-app-get-string-button" />
<Button title="Get Number" onPress={handleGetNumberData} testID="mmkv-app-get-number-button" />
<Button title="Get Boolean" onPress={handleGetBooleanData} testID="mmkv-app-get-boolean-button"/>
<Button title="Check If Key Exists" onPress={handleCheckKey} testID="mmkv-app-contains-button"/>
<Button title="List All Keys" onPress={handleListKeys} testID="mmkv-app-get-all-keys-button"/>
<Button title="Delete 'Username' Key" onPress={handleDeleteKey} testID="mmkv-app-delete-key-button"/>
<Button title="Clear All Data" onPress={handleClearAll} testID="mmkv-app-clear-all-button"/>
<Button title="Recrypt Storage" onPress={handleRecryptStorage} testID="mmkv-app-recrypt-button"/>
<Button title="Display Storage Size" onPress={handleDisplaySize} testID="mmkv-app-size-button"/>
<Button title="Hook Set Data" onPress={handleHookSetData} testID="mmkv-app-hook-set-button"/>
<Button title="Hook Get String Data" onPress={handleUseMMKVStringData} testID="mmkv-app-hook-get-string-button"/>
<Button title="Hook Get Number Data" onPress={handleUseMMKVNumberData} testID="mmkv-app-hook-get-number-button"/>
<Button title="Hook Get Boolean Data" onPress={handleUseMMKVBooleanData} testID="mmkv-app-hook-get-boolean-button"/>
</View>
);
};
const styles = StyleSheet.create({
container: {
flexGrow: 1,
justifyContent: 'center',
alignItems: 'center',
padding: 20,
backgroundColor: '#fff',
},
title: {
fontSize: 20,
marginBottom: 20,
textAlign: 'center',
},
button: {
marginVertical: 10,
},
});
API参考
Vega上的MMKV库提供了Turbo模块,增加了对以下MMKV方法的支持。 请查看专门文档页面,了解有关此库和API参考的更多信息。原生MMKV
| 方法 | 描述 |
|---|---|
MMKV | 一个MMKV基本存储类。 |
size | 获取当前存储空间的总大小,以字节为单位。 |
set | 为给定key设置一个值。 |
getBoolean | 获取给定key的布尔值,如果不存在,则返回undefined。 |
getString | 获取给定key的字符串值,如果不存在,则返回undefined。 |
getNumber | 获取给定key的数字值,如果不存在,则返回undefined。 |
getBuffer | 获取无符号8位 (0-255) 数据的原始缓冲区。 |
contains | 检查给定key是否存储在此MMKV实例中。 |
delete | 删除给定的key。 |
getAllKeys | 获取所有键。 |
clearAll | 删除所有键。 |
recrypt | 设置(或更新)加密密钥以加密此MMKV实例中的所有数据。 |
trim | 缩减存储空间并清除内存缓存。 |
toString | 获取MMKV的字符串表示形式。 |
toJSON | 获取MMKV的JSON表示形式。 |
addOnValueChangedListener | 添加一个值已更改的侦听器。当存储实例中的任何值发生变化(设置或删除)时,应用都会调用该侦听器。 |
挂钩
| 方法 | 描述 |
|---|---|
useMMKV | 使用默认的共享MMKV实例。 |
useMMKVString | 使用给定MMKV存储实例中给定key的字符串值。 |
useMMKVNumber | 使用给定MMKV存储实例中给定key的数字值。 |
useMMKVBoolean | 使用给定MMKV存储实例中给定key的布尔值。 |
useMMKVObject | 使用给定MMKV存储实例中给定key的对象值。 |
useMMKVListener | 侦听给定MMKV存储实例中的变化。 |
配置
| 方法 | 描述 |
|---|---|
id | MMKV实例的ID。如果您想使用多个实例,请确保每个实例使用不同的ID。 |
path | MMKV实例的根路径。 |
encryptionKey | MMKV实例的加密/解密密钥。 |
mode | 配置MMKV的处理模式。 |
模式
| 方法 | 描述 |
|---|---|
SINGLE_PROCESS | 应用仅将MMKV实例用作单个进程。 |
MULTI_PROCESS | 应用可能使用MMKV实例作为多个进程,如应用片段、共享扩展或后台服务。 |
已知问题
- Vega虚拟设备不支持
recrypt方法。 - 不支持
useMMKVBuffer挂钩。

