//定义要操作的key
private val key = stringPreferencesKey(“name”)
这就是定义String类型的Key，通过这个Key去进行数据存取，还有一些其他的方法可供你使用。
基本上满足你的要求，SP的功能它肯定都会有的，这里这些方法可以快速构建一个符合类型的Key。
下面我们写一个方法进行存数据，代码如下：
private suspend fun put() = dataStore.edit { it[key] = “疫情” }
这里用到了Kotlin的协程，如果你对这个不太了解，那么也没有关系，你先知道这么用，然后再去了解协程。这个方法这样不太清晰，换种方式：
通过dataStore.edit函数，里面的it就是MutablePreferences，然后我们通过key去设置它的值，这里是设置疫情两个字。而这个suspend是协程中的关键字，你现在可以将这个put()当成是在子线程中执行的，那么执行结束之后需要怎么做呢？需要切换到主线程。这是在调用的地方进行切换，比如我们在点击存数据按钮的时候调用，如下图所示：
就是这样的。
下面我们再写一个取数据的方法。
private fun get() = runBlocking {
return@runBlocking dataStore.data.map { it[key] ?: “新冠” }.first()
}
你会发现和存数据又有不同，这里的first()就是取值，这个方法换个方式来看就清晰一些。
然后我们在取数据按钮的点击事件中调用。
下面我们运行一下：
第一次我先取数据，显示的是默认值，然后我存数据再取数据。效果就是这样，但你会觉得使用起来很麻烦，不如SP好用，这个我们后面再去封装，先了解一些它的功能特性。
在进行定义dataStore时，会在手机中生成一个pb文件，这里我们用虚拟机来看，
然后通过你的程序包名去找
这里的文件就是存放你的缓存信息的文件。这里我用txt打开看一下
可以看到键和值，也许是浏览文件不对，下面我们清理一下这个数据。在布局中增加一个按钮
在代码中
通过clear方法调用进行数据的清除，清除后我们再看看这个pb文件
这个文件就什么都没有了，清除的干干净净。
这个DataStore是肯定需要封装之后再使用的，直接使用太麻烦了，我们需要封装的像SP那样好用，数据类型就参考这个方法中的数据类型。
在写封装代码之前呢，我们先创建一个App类，里面的代码如下：
class App : Application() {
companion object {
lateinit var instance : App
}
override fun onCreate() {
super.onCreate()
instance = this
}
}
然后我们在AndroidManifest中设置
下面我们新建一个EasyDataStore类，将它设置为object，先创建DataStore，代码如下：
// 创建DataStore
val App.dataStore: DataStore 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 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 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中使用一下：
这里我们存数据、取数据、清空数据都用到了，下面运行一下：
对于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
再打开app下的build.gradle，添加如下代码：
id ‘com.google.protobuf’
② 添加协议缓冲区和 Proto DataStore 依赖项
在app的dependencies{}闭包中添加如下代码：
//Proto DataStore
implementation ‘androidx.datastore:datastore-core:1.0.0’
implementation ‘com.google.protobuf:protobuf-javalite:3.10.0’
③ 配置协议缓冲区
在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’
}
}
}
}
}
注意它添加的位置：
点击Sync Now。
2. 创建proto文件
将项目切换到Project，然后在main下面新建一个proto文件夹。
在此文件夹下新建study.proto文件，然后AS会发现打开这个格式需要安装一个插件。
点击Install plugins进行安装。
安装成功之后，重启AS插件生效。
注意看这个文件的图标变了，这说明你的插件安装成功并且配置成功了。
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 {
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)
扫一扫
2863
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
