Android存储:轻松掌握MMKV

Android存储:轻松掌握MMKV

写在前面

前面我写了一篇文章讲解了 DataStore 的运用:Jetpack学习:轻松把握DataStore – () 后面了解到了 MMKV ,让咱们先看看它的介绍:

MMKV 是基于 mmap 内存映射的 key-value 组件,底层序列化/反序列化运用 protobuf 完成,性能高,稳定性强。从 2015 年中至今在微信上运用,其性能和稳定性经过了时刻的验证。近期也已移植到 Android / macOS / Win32 / POSIX 平台,一起开源。

能够看出它也能够用于代替 SP,操作也与 SP 类似,相较于 DataStore 更好上手,所以我爽性也写一篇文章介绍下怎么运用 MMKV。

参考文章

官方文档:
MMKV/README_CN.md at master Tencent/MMKV (github.com)
但官方文档讲得不够全面,所以还参考了其他优异文章:
Android:MMKV 组件入门 – 简书 (jianshu.com)
MMKV——Android上的运用(替换SP存储) – ()

预备

咱们经过一个计数器比如,在详细的情景中了解和运用 MMKV
xml布局如下:

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout     
    xmlns:android="http://schemas.android.com/apk/res/android"  
    xmlns:app="http://schemas.android.com/apk/res-auto"  
    xmlns:tools="http://schemas.android.com/tools"  
    android:layout_width="match_parent"  
    android:layout_height="match_parent"  
    tools:context=".MainActivity">  
    <TextView        
	    android:id="@+id/tv"  
        android:layout_width="wrap_content"  
        android:layout_height="wrap_content"  
        android:text="0"  
        android:textSize="28sp"  
        app:layout_constraintBottom_toBottomOf="parent"  
        app:layout_constraintEnd_toEndOf="parent"  
        app:layout_constraintStart_toStartOf="parent"  
        app:layout_constraintTop_toTopOf="parent" />  
	<com.google.android.material.floatingactionbutton.FloatingActionButton  
	    android:id="@+id/fab_delete"  
	    android:layout_width="wrap_content"  
	    android:layout_height="wrap_content"  
	    android:layout_marginBottom="12sp"  
	    android:layout_marginEnd="24dp"  
	    android:contentDescription="delete"  
	    android:src="@drawable/ic_baseline_delete_forever_24"  
	    app:background="@android:color/holo_red_dark"  
	    app:backgroundTint="@android:color/holo_red_dark"  
	    app:layout_constraintBottom_toTopOf="@+id/fab_add"  
	    app:layout_constraintEnd_toEndOf="parent"  
	    app:tint="@color/white" />
    <com.google.android.material.floatingactionbutton.FloatingActionButton        
	    android:id="@+id/fab_add"  
        android:layout_width="wrap_content"  
        android:layout_height="wrap_content"  
        android:layout_margin="24dp"  
        android:src="@drawable/ic_baseline_exposure_plus_1_24"  
        app:backgroundTint="@color/black"  
        app:background="@color/black"  
        app:tint="@color/white"  
        app:layout_constraintBottom_toBottomOf="parent"  
        app:layout_constraintEnd_toEndOf="parent"  
        android:contentDescription="add" />  
</androidx.constraintlayout.widget.ConstraintLayout>

activity代码如下:

class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {  
        super.onCreate(savedInstanceState)  
        setContentView(R.layout.activity_main)  
        val tv = findViewById<TextView>(R.id.tv)  
        val add = findViewById<FloatingActionButton>(R.id.fab_add)
        val delete = findViewById<FloatingActionButton>(R.id.fab_delete)  
    }  
}

咱们的终究意图是经过不断点击 fab_add 使得 TextView 内的数字不断+1,然后点击 fab_delete 将 TextView 内的数字清零。

Android存储:轻松掌握MMKV

开端运用

添加依靠

Github:Tencent/MMKV: An efficient, small mobile key-value storage framework developed by WeChat. Works on Android, iOS, macOS, Windows, and POSIX. (github.com)

dependencies {
    // 将1.3.1替换为最新的版别
    implementation 'com.tencent:mmkv:1.3.1'
}
初始化

完成应用的存储功能通常在App启动时就要开端初始化其目标,所以咱们在自界说 Application 内对 MMKV 初始化。

class GlobalApplication : Application() {
    override fun onCreate() {  
        super.onCreate()  
        // 初始化  
        MMKV.initialize(this)  
    }  
}

MMKV 默许把文件存放在$(FilesDir)/mmkv/目录。能够在 MMKV初始化时自界说根目录

String dir = getFilesDir().getAbsolutePath() + "/mmkv";
String rootDir = MMKV.initialize(dir);

MMKV 为咱们供给一个大局的实例,能够直接运用

// 获取 MMKV 默许大局实例,一般选用这个,本文也是挑选这个进行实例创立
val mmkv = MMKV.defaultMMKV()
// 依据设置 id 来自界说 MMKV 目标。比如依据业务来区分的存取实例
val mmkv = MMKV.mmkvWithID("ID")  
// 敞开多进程拜访。默许是单线程
val mmkv = MMKV.mmkvWithID("ID",MMKV.MULTI_PROCESS_MODE)

与 SP 类似,咱们需要界说一个 key 值用于读取写入 MMKV 中的数据

val key = "number"
支撑类型

支撑以下 Java 言语基础类型:

  • boolean、int、long、float、double、byte[]
  • 支撑以下 Java 类和容器:
  • String、Set< String >
  • 任何完成了 Parcelable 的类型
读取数据

MMKV 为用户读取数据供给了两种类型的函数,其间T为上述的 MMVK 支撑类型

  • decodeT(String key):读取指定 key 中的值
  • decodeT(String key, T defaultValue):读取指定 key 中的值,假如该 key 不存在则赋予默许值并回来。

其间需要注意的是,第一个函数虽然没有明面上赋予默许值,但检查源码,能够发现假如 key 不存在时 MMKV 也会为其设置固定默许值并回来,以 decodeInt 为比如,MMKV 会设置初始默许值 0

public int decodeInt(String key) {
    return this.decodeInt(this.nativeHandle, key, 0);  
}
public int decodeInt(String key, int defaultValue) {  
    return this.decodeInt(this.nativeHandle, key, defaultValue);  
}

以下为其他类型 MMKV 赋予的初始默许值

Android存储:轻松掌握MMKV

在计数器事例中,咱们挑选 int 类型数据

// 初始化 TextView 的值  
// 获取存储在本地的 number 值,假如不存在 mmkv 回来默许值为 0
tv.text = mmkv.decodeInt(key).toString()
写入数据

MMKV 供给了便当的 API 能够直接写入数据: public boolean encode(String key, T value)
其间 T 为 MMKV 可支撑的类型,在上文现已提过了。 现在咱们就能够直接完成点击 fab_add 按钮来修正数据

add.setOnClickListener {
    // 因为点击 FloatingActionButton 值会添加,所以 value 值在原先存储值的基础上 +1    
    val value = mmkv.decodeInt(key) + 1  
    // 将数据写入 MMVK    
    mmkv.encode(key, value)  
    // 更新 TextView 的值 
    tv.text = value.toString()  
}
删除数据

删除单个key:removeValueForKey(String key)
删除多个key:removeValuesForKeys(String[] arrKeys)
清空一切数据:clearAll()
在这里因为咱们只要一个 key ,所以直接运用removeValueForKey来铲除咱们的数据,一起更新 TextView 的 UI

delete.setOnClickListener {
    // 铲除数据
    mmkv.removeValueForKey(key)  
    // 更新 TextView 数据
    tv.text = mmkv.decodeInt(key, 0).toString()  
}
从 SharedPreferences 搬迁到 MMKV

为了演示怎么搬迁,咱们重头再来,在预备部分的代码基础上临时创立 SharedPreferences 储存数据。

val sp = getSharedPreferences("test", Context.MODE_PRIVATE)
val edit = sp.edit()  
// 为了验证顺畅搬迁,咱们初始值设置为10  
edit.putInt("number",10);  
edit.apply()

运转程序后检查数据现已成功保存在本地

Android存储:轻松掌握MMKV
好的现在咱们来进行搬迁,MMKV 供给了 importFromSharedPreferences 方法让咱们便利进行 SP 数据的搬迁,只要供给需要搬迁的 SP 实例就能非常快速完成实例。
MMKV 完成了 SharedPreferences,Editor两个接口,所以在搬迁之后SP的操作代码能够不用更改。

val oldData = getSharedPreferences("test",Context.MODE_PRIVATE)
mmkv.importFromSharedPreferences(oldData)  
oldData.edit().clear().apply()

其他代码如同前面,现在重新运转,能够看到界面初始数值为10,阐明搬迁数据成功

Android存储:轻松掌握MMKV

完整代码

Application:

class GlobalApplication : Application() {
    override fun onCreate() {  
        super.onCreate()  
        // 初始化  
        MMKV.initialize(this)  
    }  
}

Activity:

class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {  
        super.onCreate(savedInstanceState)  
        setContentView(R.layout.activity_mmkv)  
        val tv = findViewById<TextView>(R.id.tv_mmkv)  
        val add = findViewById<FloatingActionButton>(R.id.fab_add)  
        val delete = findViewById<FloatingActionButton>(R.id.fab_delete)  
        // 获取 MMKV 实例  
        val mmkv = MMKV.defaultMMKV()  
        // 设置 key 值  
        val key = "number"  
        // 数据搬迁
        val oldData = getSharedPreferences("test",Context.MODE_PRIVATE)  
        mmkv.importFromSharedPreferences(oldData)  
        oldData.edit().clear().apply()
        // 初始化 TextView 的值  
        // 获取存储在本地的 number 值,假如不存在则默许值为 0        
        tv.text = mmkv.decodeInt(key, 0).toString()  
        add.setOnClickListener {  
            // 因为点击 FloatingActionButton 值会添加,所以 value 值 +1            
            val value = mmkv.decodeInt(key) + 1  
            // 将数据写入 MMVK            
            mmkv.encode(key, value)  
            // 更新 TextView            
            tv.text = value.toString()  
        }  
        delete.setOnClickListener {  
            // 铲除数据  
            mmkv.removeValueForKey(key)  
            // 更新 TextView 数据  
            tv.text = mmkv.decodeInt(key, 0).toString()  
        }  
    }  
}