Android Jetpack组件 DataStore的使用和简单封装

简介: Android Jetpack组件 DataStore的使用和简单封装

前言


 也许你是第一次听说这个DataStore,也许你有所耳闻,但从未使用过,不过都没有关系,随着这篇文章去熟悉DataStore。


正文


 DataStore是Jetpack中的一个组件,用于做数据持久化,DataStore以异步、一致的事务方式存储数据,克服了SharedPreferences的一些缺点,DataStore基于Kotlin协程和Flow实现,就是用来取代SharedPreferences的。我们废话不多说,开始吧。按照惯例,我们新建一个项目去做演示,不过稍微有一些不同,这次我们新建的项目时Kotlin语言的,请注意。

33199f1a87d644ce902d6dea65f1b8e9.png


创建好项目,待项目配置完成之后,我们添加依赖。


一、添加依赖


在app模块下的build.gradle中的dependencies{}闭包中添加如下依赖:

  //DataStore
    implementation 'androidx.datastore:datastore-preferences:1.0.0'
    implementation 'androidx.datastore:datastore-preferences-core:1.0.0'


同时添加开启ViewBinding和DataBinding,如下图所示:

9f0448ece28f4a7ead271b08d469a29a.png


然后Sync Now。


二、数据存取


 首先我们改一下activity_main.xml布局,里面的代码如下:

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout 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"
    android:gravity="center"
    android:orientation="vertical"
    tools:context=".MainActivity">
    <TextView
        android:id="@+id/textView"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="Hello World!" />
    <Button
        android:id="@+id/btn_put"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:text="存数据" />
    <Button
        android:id="@+id/btn_get"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:text="取数据" />
</LinearLayout>


里面就是两个按钮一个文本,回到MainActivity中,首先完成点击事件的监听。

  private lateinit var binding: ActivityMainBinding
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        binding = ActivityMainBinding.inflate(layoutInflater)
        setContentView(binding.root)
        //存数据
        binding.btnPut.setOnClickListener {
        }
        //取数据
        binding.btnGet.setOnClickListener {
        }
    }

这应该没啥是好说的,就是使用了viewBinding,获取视图xml的控件id。


下面就是正式来使用DataStore了,首先我们需要定义一个变量。

  //定义dataStore
    private val Context.dataStore: DataStore<Preferences> by preferencesDataStore(name = "Study")

这里的变量就是dataStore,我们在定义的时候给了一个Study的名称,就像你使用SP时需要先给一个名字一样,然后才是键值的操作。


在DataStore中操作数据会麻烦一些,Key需要我们去定义,例如我定义一个String类型的key。

  //定义要操作的key
    private val key = stringPreferencesKey("name")

这就是定义String类型的Key,通过这个Key去进行数据存取,还有一些其他的方法可供你使用。

2465c248242e44acbaf09ac1dc597d71.png


基本上满足你的要求,SP的功能它肯定都会有的,这里这些方法可以快速构建一个符合类型的Key。


下面我们写一个方法进行存数据,代码如下:

  private suspend fun put() = dataStore.edit { it[key] = "疫情" }

这里用到了Kotlin的协程,如果你对这个不太了解,那么也没有关系,你先知道这么用,然后再去了解协程。这个方法这样不太清晰,换种方式:

4f89c7845fec422bb5c5dacc31a0bc78.png


通过dataStore.edit函数,里面的it就是MutablePreferences,然后我们通过key去设置它的值,这里是设置疫情两个字。而这个suspend是协程中的关键字,你现在可以将这个put()当成是在子线程中执行的,那么执行结束之后需要怎么做呢?需要切换到主线程。这是在调用的地方进行切换,比如我们在点击存数据按钮的时候调用,如下图所示:

fda7ba31da7246348f6adc2359580a14.png


就是这样的。


下面我们再写一个取数据的方法。

  private fun get() = runBlocking {
        return@runBlocking dataStore.data.map { it[key] ?: "新冠" }.first()
    }


你会发现和存数据又有不同,这里的first()就是取值,这个方法换个方式来看就清晰一些。

a9d14ecd43904db79d4a36436faa9fe1.png


然后我们在取数据按钮的点击事件中调用。

7c4564e361fb42c4844f9422bf122891.png


下面我们运行一下:

dc837eed09664bc7a01a8b60631789fe.gif


 第一次我先取数据,显示的是默认值,然后我存数据再取数据。效果就是这样,但你会觉得使用起来很麻烦,不如SP好用,这个我们后面再去封装,先了解一些它的功能特性。


三、数据查看和清除


 在进行定义dataStore时,会在手机中生成一个pb文件,这里我们用虚拟机来看,

6ae182add8dc46a08b9c461737c8ae6a.png


然后通过你的程序包名去找

f782ac8830ca46919aacb8f065f9bba8.png


这里的文件就是存放你的缓存信息的文件。这里我用txt打开看一下

4a5127f5ae9a4fd9a21d8f12567fae26.png


可以看到键和值,也许是浏览文件不对,下面我们清理一下这个数据。在布局中增加一个按钮

cf5a3e63998d4f519fd6cb6b1dc6b3d0.png


在代码中

88354453cd44423b828bc30a4cfd1be9.png


通过clear方法调用进行数据的清除,清除后我们再看看这个pb文件

94aed5d6e7724dcbbb3560adc59873f2.png


这个文件就什么都没有了,清除的干干净净。


四、封装


 这个DataStore是肯定需要封装之后再使用的,直接使用太麻烦了,我们需要封装的像SP那样好用,数据类型就参考这个方法中的数据类型。

2465c248242e44acbaf09ac1dc597d71.png


在写封装代码之前呢,我们先创建一个App类,里面的代码如下:

class App : Application() {
    companion object {
        lateinit var instance : App
    }
    override fun onCreate() {
        super.onCreate()
        instance = this
    }
}


然后我们在AndroidManifest中设置

b72da2f05fd54a88ac9250339220e626.png


下面我们新建一个EasyDataStore类,将它设置为object,先创建DataStore,代码如下:

  // 创建DataStore
    val App.dataStore: DataStore<Preferences> by preferencesDataStore(
        name = "Study"
    )
    // DataStore变量
    val dataStore = App.instance.dataStore


下面我们先写好各个数据类型的存取方法,先写存数据的方法:

  /**
     * 存放Int数据
     */
    private suspend fun putIntData(key: String, value: Int) = dataStore.edit {
        it[intPreferencesKey(key)] = value
    }
    /**
     * 存放Long数据
     */
    private suspend fun putLongData(key: String, value: Long) = dataStore.edit {
        it[longPreferencesKey(key)] = value
    }
    /**
     * 存放String数据
     */
    private suspend fun putStringData(key: String, value: String) = dataStore.edit {
        it[stringPreferencesKey(key)] = value
    }
    /**
     * 存放Boolean数据
     */
    private suspend fun putBooleanData(key: String, value: Boolean) = dataStore.edit {
        it[booleanPreferencesKey(key)] = value
    }
    /**
     * 存放Float数据
     */
    private suspend fun putFloatData(key: String, value: Float) = dataStore.edit {
        it[floatPreferencesKey(key)] = value
    }
    /**
     * 存放Double数据
     */
    private suspend fun putDoubleData(key: String, value: Double) = dataStore.edit {
        it[doublePreferencesKey(key)] = value
    }

然后是取数据的方法:

  /**
     * 取出Int数据
     */
    private fun getIntData(key: String, default: Int = 0): Int = runBlocking {
        return@runBlocking dataStore.data.map {
            it[intPreferencesKey(key)] ?: default
        }.first()
    }
    /**
     * 取出Long数据
     */
    private fun getLongData(key: String, default: Long = 0): Long = runBlocking {
        return@runBlocking dataStore.data.map {
            it[longPreferencesKey(key)] ?: default
        }.first()
    }
    /**
     * 取出String数据
     */
    private fun getStringData(key: String, default: String? = null): String = runBlocking {
        return@runBlocking dataStore.data.map {
            it[stringPreferencesKey(key)] ?: default
        }.first()!!
    }
    /**
     * 取出Boolean数据
     */
    private fun getBooleanData(key: String, default: Boolean = false): Boolean = runBlocking {
        return@runBlocking dataStore.data.map {
            it[booleanPreferencesKey(key)] ?: default
        }.first()
    }
    /**
     * 取出Float数据
     */
    private fun getFloatData(key: String, default: Float = 0.0f): Float = runBlocking {
        return@runBlocking dataStore.data.map {
            it[floatPreferencesKey(key)] ?: default
        }.first()
    }
    /**
     * 取出Double数据
     */
    private fun getDoubleData(key: String, default: Double = 0.00): Double = runBlocking {
        return@runBlocking dataStore.data.map {
            it[doublePreferencesKey(key)] ?: default
        }.first()
    }

最后我们根据存取的数据类型去做一个封装,存数据,代码如下:

  /**
     * 存数据
     */
    fun <T> putData(key: String, value: T) {
        runBlocking {
            when (value) {
                is Int -> putIntData(key, value)
                is Long -> putLongData(key, value)
                is String -> putStringData(key, value)
                is Boolean -> putBooleanData(key, value)
                is Float -> putFloatData(key, value)
                is Double -> putDoubleData(key, value)
                else -> throw IllegalArgumentException("This type cannot be saved to the Data Store")
            }
        }
    }

取数据:

  /**
     * 取数据
     */
    fun <T> getData(key: String, defaultValue: T): T {
        val data = when (defaultValue) {
            is Int -> getIntData(key, defaultValue)
            is Long -> getLongData(key, defaultValue)
            is String -> getStringData(key, defaultValue)
            is Boolean -> getBooleanData(key, defaultValue)
            is Float -> getFloatData(key, defaultValue)
            is Double -> getDoubleData(key, defaultValue)
            else -> throw IllegalArgumentException("This type cannot be saved to the Data Store")
        }
        return data as T
    }

对了,还有一个清除数据的方法:

  /**
     * 清空数据
     */
    fun clearData() = runBlocking { dataStore.edit { it.clear() } }

这样我们的DataStore就封装好了,下面我们在MainActivity中使用一下:

09d8a7e53a764332a324edcfe1719b26.png


这里我们存数据、取数据、清空数据都用到了,下面运行一下:

c4d694daf5d6480ebc94f5ab0841d9f5.gif


对于DataStore最基本的操作就完成了,那么下面来进阶一下。


五、对象存取


 其实我们刚才使用的是Preferences DataStore,是对数据进行操作,下面要操作的是Proto DataStore,官网上的说法是Proto DataStore 将数据作为自定义数据类型的实例进行存储。此实现要求您使用协议缓冲区来定义架构,但可以确保类型安全。


 Proto DataStore中采用的是ProtorBuffer,优势是性能好、效率高,表现在对数据的序列化和反序列化时间快,占用的空间小,还记得之前我们看到的那个pb文件吗,它里面采用的就是protobuf,之前一直是Google内部使用,这也是源于它的缺点,之前这个pb文件我们打开过,里面只能看懂键和值,缺乏描述,因此就影响了可读性,和广泛性,不如Json和XML简单。因此我们目前也只是在DataStore中使用protobuf,下面为了使用,我们需要在项目中装一个插件。


1. 插件安装


这个插件的安装比较的麻烦,首先是添加协议缓冲区插件


① 添加协议缓冲区插件


首先打开工程的build.gradle,在里面添加如下代码:

id "com.google.protobuf" version "0.8.12" apply false

cc682a197b8d410f9bd654ab90f7313d.png


再打开app下的build.gradle,添加如下代码:

  id 'com.google.protobuf'

345813fe2b8c4045a179cce907a31a0b.png


② 添加协议缓冲区和 Proto DataStore 依赖项


在app的dependencies{}闭包中添加如下代码:

  //Proto DataStore
    implementation  'androidx.datastore:datastore-core:1.0.0'
    implementation  'com.google.protobuf:protobuf-javalite:3.10.0'

6769ad9cd087458a8db882bf63dcea75.png


③ 配置协议缓冲区


在app的build.gradle中添加如下代码:

protobuf {
    protoc {
        artifact = "com.google.protobuf:protoc:3.10.0"
    }
    // 为该项目中的 Protobufs 生成 java Protobuf-lite 代码。
    generateProtoTasks {
        all().each { task ->
            task.builtins {
                java {
                    option 'lite'
                }
            }
        }
    }
}


注意它添加的位置:

98ace729edb8429e902dcf8ceb97df19.png


点击Sync Now。


2. 创建proto文件


将项目切换到Project,然后在main下面新建一个proto文件夹。

d4efef0025754b738a2465725a7db955.png


在此文件夹下新建study.proto文件,然后AS会发现打开这个格式需要安装一个插件。

6f1c71ba5a1048f7adc26ce5e9eeb126.png


点击Install plugins进行安装。

73bccb2c423f43f997ba217ced8d85b1.png


安装成功之后,重启AS插件生效。

501a81bd165a43b4b3b365e3ad0b7f5c.png


注意看这个文件的图标变了,这说明你的插件安装成功并且配置成功了。


3. 配置proto文件


 里面的代码如下:

// 声明协议, 也支持 prota2,普遍使用proto3
syntax = "proto3";
/**
 * 通过potorbuf 描述对象生成java类。
 */
option java_package = "com.llw.datastore";//设置生成的类所在的包
option java_multiple_files = true;//可能会有多个文件。
message PersonPreferences {
  string name = 1;
  int32 age = 2;
}


这里要按照Protobuf的语言规则去设置,参考protobuf 语言指南


这里我们定了一个对象,然后你可以Make Project,此时通过编译时技术,会生成一个PersonPreferences类,下面我们创建一个序列化器。


4. 创建序列化器


在com.llw.datastore下新建一个data包,包下新建一个PersonSerializer的单例,里面的代码如下:

object PersonSerializer : Serializer<PersonPreferences> {
    override val defaultValue: PersonPreferences = PersonPreferences.getDefaultInstance()
    override suspend fun readFrom(input: InputStream): PersonPreferences {
        try {
            return PersonPreferences.parseFrom(input)
        } catch (exception: InvalidProtocolBufferException) {
            throw CorruptionException("Cannot read proto.", exception)
        }
    }
    override suspend fun writeTo(t: PersonPreferences, output: OutputStream) = t.writeTo(output)
}


这里要注意导包的问题,这个类的作用就是PersonPreferences的序列化和反序列化。


5. 对象写入和取出


这里我们现在xml中增加两个按钮,如下所示:

b8ab80bdcb904afe97f10f749ef4cc9f.png


然后回到MainActivity中,在里面添加如下代码:

  //创建 DataStore
  val Context.studyDataStore: DataStore<PersonPreferences> by dataStore(
        fileName = "study.pb",
        serializer = PersonSerializer
    )

这里就用到了那个序列化器,然后会保存到study.pb下,下面来看存和取的方法,代码如下:

    //proto 存数据
        binding.btnProtoPut.setOnClickListener {
            runBlocking {
                studyDataStore.updateData {
                    it.toBuilder()
                        .setName("刘爱国")
                        .setAge(11)
                        .build()
                }
            }
        }
        //proto 取数据
        binding.btnProtoGet.setOnClickListener {
            runBlocking {
                val person = studyDataStore.data.first()
                binding.textView.text = "name: ${person.name} , age: ${person.age}"
            }
        }


下面我们运行一下:

70b665ee2b064b94a886f3f46219d9c6.gif


六、源码


GitHub:DataStoreDemo

CSDN:DataStoreDemo.rar


相关文章
|
12天前
|
存储 缓存 Android开发
安卓Jetpack Compose+Kotlin, 使用ExoPlayer播放多个【远程url】音频,搭配Okhttp库进行下载和缓存,播放完随机播放下一首
这是一个Kotlin项目,使用Jetpack Compose和ExoPlayer框架开发Android应用,功能是播放远程URL音频列表。应用会检查本地缓存,如果文件存在且大小与远程文件一致则使用缓存,否则下载文件并播放。播放完成后或遇到异常,会随机播放下一首音频,并在播放前随机设置播放速度(0.9到1.2倍速)。代码包括ViewModel,负责音频管理和播放逻辑,以及UI层,包含播放和停止按钮。
|
12天前
|
数据管理 API 数据库
探索Android Jetpack:现代安卓开发的利器
Android Jetpack是谷歌为简化和优化安卓应用开发而推出的一套高级组件库。本文深入探讨了Jetpack的主要构成及其在应用开发中的实际运用,展示了如何通过使用这些工具来提升开发效率和应用性能。
|
8天前
|
JavaScript Java Android开发
kotlin安卓在Jetpack Compose 框架下跨组件通讯EventBus
**EventBus** 是一个Android事件总线库,简化组件间通信。要使用它,首先在Gradle中添加依赖`implementation &#39;org.greenrobot:eventbus:3.3.1&#39;`。然后,可选地定义事件类如`MessageEvent`。在活动或Fragment的`onCreate`中注册订阅者,在`onDestroy`中反注册。通过`@Subscribe`注解方法处理事件,如`onMessageEvent`。发送事件使用`EventBus.getDefault().post()`。
|
8天前
|
JavaScript 前端开发 Android开发
kotlin安卓在Jetpack Compose 框架下使用webview , 网页中的JavaScript代码如何与native交互
在Jetpack Compose中使用Kotlin创建Webview组件,设置JavaScript交互:`@Composable`函数`ComposableWebView`加载网页并启用JavaScript。通过`addJavascriptInterface`添加`WebAppInterface`类,允许JavaScript调用Android方法如播放音频。当页面加载完成时,执行`onWebViewReady`回调。
|
11天前
|
监控 Android开发 数据安全/隐私保护
安卓kotlin JetPack Compose 实现摄像头监控画面变化并录制视频
在这个示例中,开发者正在使用Kotlin和Jetpack Compose构建一个Android应用程序,该程序 能够通过手机后置主摄像头录制视频、检测画面差异、实时预览并将视频上传至FTP服务器的Android应用
|
10天前
|
安全 网络安全 API
kotlin安卓开发JetPack Compose 如何使用webview 打开网页时给webview注入cookie
在Jetpack Compose中使用WebView需借助AndroidView。要注入Cookie,首先在`build.gradle`添加WebView依赖,如`androidx.webkit:webkit:1.4.0`。接着创建自定义`ComposableWebView`,通过`CookieManager`设置接受第三方Cookie并注入Cookie字符串。最后在Compose界面使用这个自定义组件加载URL。注意Android 9及以上版本可能需要在网络安全配置中允许第三方Cookie。
|
12天前
|
Android开发 Kotlin
kotlin安卓开发【Jetpack Compose】:封装SnackBarUtil工具类方便使用
GPT-4o 是一个非常智能的模型,比当前的通义千问最新版本在能力上有显著提升。作者让GPT开发一段代码,功能为在 Kotlin 中使用 Jetpack Compose 框架封装一个 Snackbar 工具类,方便调用
|
3天前
|
安全 Java Android开发
安卓开发中的新趋势:Kotlin与Jetpack的完美结合
【6月更文挑战第20天】在不断进化的移动应用开发领域,Android平台以其开放性和灵活性赢得了全球开发者的青睐。然而,随着技术的迭代,传统Java语言在Android开发中逐渐显露出局限性。Kotlin,一种现代的静态类型编程语言,以其简洁、安全和高效的特性成为了Android开发中的新宠。同时,Jetpack作为一套支持库、工具和指南,旨在帮助开发者更快地打造优秀的Android应用。本文将探讨Kotlin与Jetpack如何共同推动Android开发进入一个新的时代,以及这对开发者意味着什么。
|
5天前
|
存储 Java 数据库连接
Android Java开发异步
【6月更文挑战第15天】
|
2天前
|
Java 开发工具 Android开发
安卓与iOS开发差异解析
【6月更文挑战第21天】本文旨在深入探讨安卓和iOS两大移动操作系统在应用开发过程中的主要差异。通过对比分析,揭示各自的设计哲学、编程语言选择、用户界面构建、性能优化策略以及发布流程的异同。文章将提供开发者视角下的实用信息,帮助他们更好地理解各自平台的特点和挑战,从而做出更明智的开发决策。