react native mmkv下載 - react native mmkv原始碼下載

react native mmkv

C/C++

Release 3.1.0

下載

MMKV

React Native 最快的鍵/值儲存。

MMKV是微信開發的一個高效率、小型的移動鍵值儲存框架。更多資訊請見騰訊/MMKV
react-native-mmkv是一個函式庫，可讓您透過快速直接的 JS 綁定到本機 C++ 函式庫，在 React Native 應用程式中輕鬆使用MMKV 。

特徵

取得和設定字串、布林值、數字和 ArrayBuffer
完全同步調用，沒有非同步/等待，沒有 Promises，沒有 Bridge。
加密支援（安全儲存）
多實例支援（將使用者資料與全域資料分開）
可自訂的儲存位置
高效能，因為一切都是用 C++ 寫的
比 AsyncStorage 快約 30 倍
使用JSI和C++ TurboModules而不是“舊”橋
iOS 、 Android和Web支援
易於使用的React Hooks API

反應本機 mmkv V3

重要的

react-native-mmkv V3 現在是純 C++ TurboModule，需要啟用新架構。（反應本機 0.75+）

如果您想使用react-native-mmkv 3.xx，您需要在應用程式中啟用新架構（請參閱「為應用程式啟用新架構」）
對於React-Native 0.74.x，請使用react-native-mmkv 3.0.1。對於 React-Native 0.75.x 及更高版本，請使用react-native-mmkv 3.0.2 或更高版本。
如果您還無法使用新架構，請暫時降級到react-native-mmkv 2.xx。

基準

StorageBenchmark 透過從儲存中讀取值 1000 次來比較流行的儲存庫：

MMKV 與其他儲存庫：從儲存中讀取值 1000 次。
在 iPhone 11 Pro 上以毫秒為單位，越低越好。

安裝

反應本機

yarn add react-native-mmkv
cd ios && pod install

世博會

npx expo install react-native-mmkv
npx expo prebuild

用法

建立一個新實例

若要建立 MMKV 儲存的新實例，請使用MMKV建構子。建議您在整個應用程式中重複使用此實例，而不是每次都建立新實例，因此export storage物件。

預設

 import { MMKV } from 'react-native-mmkv'

export const storage = new MMKV ( )

這將使用預設 MMKV 儲存 ID ( mmkv.default ) 建立一個新的儲存實例。

應用程式群組或擴展

如果您想要在您的應用程式與同一組中的其他應用程式或應用程式擴充功能之間共享 MMKV 數據，請開啟Info.plist並使用您的應用程式群組的值建立一個AppGroup鍵。然後，MMKV 將自動將資料儲存在應用程式群組內，透過利用 MMKV 的多處理模式，可以從同一組中的其他應用程式或應用程式擴展讀取和寫入資料。請參閱配置應用程式組。

客製化

 import { MMKV , Mode } from 'react-native-mmkv'

export const storage = new MMKV ( {
  id : `user- ${ userId } -storage` ,
  path : ` ${ USER_DIRECTORY } /storage` ,
  encryptionKey : 'hunter2' ,
  mode : Mode . MULTI_PROCESS ,
  readOnly : false
} )

這將使用自訂 MMKV 儲存 ID 建立一個新的儲存實例。透過使用自訂儲存 ID，您的儲存與應用程式的預設 MMKV 儲存分開。

可以配置以下值：

id ：MMKV 實例的 ID。如果要使用多個實例，請使用不同的 ID。例如，您可以分離全域應用程式的儲存和登入使用者的儲存。（如果指定了path或encryptionKey字段，則為必需，否則預設為： 'mmkv.default' ）
path ：MMKV 實例的根路徑。預設情況下，MMKV 將檔案儲存在$(Documents)/mmkv/內。您可以在MMKV初始化時自訂MMKV的根目錄（文件：iOS / Android）
encryptionKey ：MMKV 實例的加密/解密金鑰。預設情況下，MMKV 將所有鍵值以純文字形式儲存在檔案中，並依靠 iOS/Android 的沙箱來確保檔案加密。如果您擔心資訊洩露，可以選擇加密MMKV。（文件：iOS/Android）
mode ：MMKV 的進程行為 - 當設定為MULTI_PROCESS時，MMKV 實例將假定可以從外部變更資料（例如應用程式剪輯、擴充或應用程式群組）。
readOnly ：此 MMKV 實例是否應處於唯讀模式。這通常更有效，並且可以避免不必要的資料寫入（如果不需要）。任何對set(..)呼叫都會拋出異常。

放

 storage . set ( 'user.name' , 'Marc' )
storage . set ( 'user.age' , 21 )
storage . set ( 'is-mmkv-fast-asf' , true )

得到

 const username = storage . getString ( 'user.name' ) // 'Marc'
const age = storage . getNumber ( 'user.age' ) // 21
const isMmkvFastAsf = storage . getBoolean ( 'is-mmkv-fast-asf' ) // true

掛鉤

 const [ username , setUsername ] = useMMKVString ( 'user.name' )
const [ age , setAge ] = useMMKVNumber ( 'user.age' )
const [ isMmkvFastAsf , setIsMmkvFastAf ] = useMMKVBoolean ( 'is-mmkv-fast-asf' )

按鍵

 // checking if a specific key exists
const hasUsername = storage . contains ( 'user.name' )

// getting all keys
const keys = storage . getAllKeys ( ) // ['user.name', 'user.age', 'is-mmkv-fast-asf']

// delete a specific key + value
storage . delete ( 'user.name' )

// delete all keys
storage . clearAll ( )

物件

 const user = {
  username : 'Marc' ,
  age : 21
}

// Serialize the object into a JSON string
storage . set ( 'user' , JSON . stringify ( user ) )

// Deserialize the JSON string into an object
const jsonUser = storage . getString ( 'user' ) // { 'username': 'Marc', 'age': 21 }
const userObject = JSON . parse ( jsonUser )

加密

 // encrypt all data with a private key
storage . recrypt ( 'hunter2' )

// remove encryption
storage . recrypt ( undefined )

緩衝器

 const buffer = new ArrayBuffer ( 3 )
const dataWriter = new Uint8Array ( buffer )
dataWriter [ 0 ] = 1
dataWriter [ 1 ] = 100
dataWriter [ 2 ] = 255
storage . set ( 'someToken' , buffer )

const buffer = storage . getBuffer ( 'someToken' )
console . log ( buffer ) // [1, 100, 255]

尺寸

 // get size of MMKV storage in bytes
const size = storage . size
if ( size >= 4096 ) {
  // clean unused keys and clear memory cache
  storage . trim ( )
}

使用 Jest 或 Vitest 進行測試

使用 Jest 或 Vitest 進行測試時，會自動使用模擬的 MMKV 實例，因此您將能夠在測試中正常使用new MMKV() 。有關使用 Jest 的範例，請參閱 package/example/test/MMKV.test.ts。

文件

掛鉤
價值改變的傾聽者
從 AsyncStorage 遷移
將 MMKV 與 redux-persist 結合使用
使用帶有後座力的 MMKV
將 MMKV 與 mobx-persist-storage 結合使用
將 MMKV 與 mobx-persist 結合使用
將 MMKV 與 zustand persist-middleware 一起使用
將 MMKV 與 jotai 結合使用
將 MMKV 與反應查詢結合使用
這個函式庫與react-native-mmkv-storage有什麼不同？

本機儲存和記憶體儲存（Web）

如果使用者選擇在瀏覽器中停用 LocalStorage，則該程式庫將自動提供有限的記憶體儲存作為替代方案。但是，這種記憶體儲存不會持久保存數據，如果使用者刷新頁面或關閉瀏覽器，可能會遇到資料遺失的情況。為了優化用戶體驗，請考慮在您的應用程式中實施合適的解決方案來解決這種情況。

限制

react-native-mmkv V3 需要react-native 0.74 或更高版本。
react-native-mmkv V3 需要啟用新的架構/TurboModules。
由於react-native-mmkv使用JSI進行同步本機方法調用，因此不再可能進行遠端偵錯（例如使用Chrome）。相反，您應該使用 Flipper 或 React DevTools。