Jetpack成员-DataStore

DataStore

定义：一种数据存储解决方案，允许您使用协议缓冲区存储键值对或类型化对象。DataStore 使用 Kotlin 协程和 Flow 以异步、一致的事务方式存储数据
适用于：简单的小型数据集，不支持部分更新或参照完整性(可以说是SharedPreferences的替代物)

DataStore 提供两种不同的实现：Preferences DataStore 和 Proto DataStore

Preferences DataStore 使用键存储和访问数据。此实现不需要预定义的架构，也不确保类型安全(为什么会说类型安全等会再说)
Proto DataStore 将数据作为自定义数据类型的实例进行存储。此实现要求您使用协议缓冲区来定义架构，但可以确保类型安全。

1.Preferences DataStore

添加依赖

// 如果是用的kotlin 直接用这个好了
 implementation "androidx.datastore:datastore:1.0.0-alpha08"

  // optional - RxJava2 support
  implementation "androidx.datastore:datastore-rxjava2:1.0.0-alpha08"
  // optional - RxJava3 support
  implementation "androidx.datastore:datastore-rxjava3:1.0.0-alpha08"

创建dataStore对象通过 preferencesDataStore 属性委托来创建 Datastore<Preferences> 实例。
在您的 Kotlin 文件顶层调用该实例一次，便可在应用的所有其余部分通过此属性访问该实例。这样可以更轻松地将 DataStore 保留为单例

val Context.dataStore: DataStore<Preferences> by preferencesDataStore(name = "settings")

读取内容

  //DataStore 的key值  stringPreferencesKey 表示String  intPreferencesKey 表示 int .... 
  // 返回Flow 提供适当的存储值。

 
                val EXAMPLE_COUNTER =stringPreferencesKey("example_counter")
               val exampleCounterFlow: Flow<String> = dataStore.data.map { preferences ->
                     preferences[EXAMPLE_COUNTER] ?: "" }
      
         
    mainScope.launch {
             exampleCounterFlow.collect {
              Log.e("TAG",it)
             }
          }

内容写入

 val EXAMPLE_COUNTER =stringPreferencesKey("example_counter")
 mainScope.launch {
                dataStore.edit { settings ->
                    settings[EXAMPLE_COUNTER] = etValue.text.toString() 
                }
            }

为什么类型不安全？
因为他跟SharedPreferences存放文件目录是一样的，在data/data/你的包名/files/datastore/自己设置名称_preferences.pd，数据都是明文的。

2.Proto DataStore

Proto DataStore 实现使用 DataStore 和协议缓冲区将类型化的对象保留在磁盘上。
Proto 相对Preferences起来，配置比较复杂，先配置Proto

在文件目录下的 build.gradle添加依赖

// 添加protobuf 插件
 classpath "com.google.protobuf:protobuf-gradle-plugin:0.8.8"

在app 目录的 build.gradle 配置文件，添加依赖

// 应用插件
apply plugin: 'com.google.protobu'

android{


    sourceSets {

        main {

            java {
                srcDirs 'src/main/java'
            }
            proto {
                srcDirs 'src/main/proto'
            }
        }
    }
}

//编写编译任务，调用plugin编译生成java文件

protobuf {
    protoc {
        artifact = 'com.google.protobuf:protoc:3.0.0'//编译器版本
    }
    plugins {
        javalite {
            artifact = 'com.google.protobuf:protoc-gen-javalite:3.0.0'//指定当前工程使用的protobuf版本为javalite版，以生成javalite版的java类
        }
    }

    generateProtoTasks.generatedFilesBaseDir = "$projectDir/src/main/java" //指定编译生成java类的存放位置

    generateProtoTasks {
        all().each { task ->
            task.plugins {
                javalite {
                    outputSubDir = '' //指定存放位置的二级目录，这里未指定
                }
            }
        }

    }

}

dependencies {

// datastore文件
 implementation "androidx.datastore:datastore:1.0.0-alpha08"

 implementation 'com.google.protobuf:protobuf-lite:3.0.0' //依赖protobuf-lite库

}

Proto DataStore 要求在 app/src/main/proto/ 目录的 proto 文件中保存预定义的架构。此架构用于定义您在 Proto DataStore 中保存的对象的类型。如需详细了解如何定义 proto 架构，请参阅 protobuf 语言指南。

syntax = "proto3";

option java_package = "com.lorenzogao.jetpackexample.datastore"; // 自定义包名，等下编译的时候会生成文件在包下面
option java_multiple_files = true;

message Settings {
  string example_counter = 1;
}

配置好以上内容，重新编译，会生成一以下文件

image.png

创建 Proto DataStore 来存储类型化对象涉及两个步骤(官网的)：

1.定义一个实现 Serializer<T> 的类，其中 T 是 proto 文件中定义的类型。此序列化器类会告知 DataStore 如何读取和写入您的数据类型。请务必为该序列化器添加默认值，以便在尚未创建任何文件时使用。

2.使用由 dataStore 创建的属性委托来创建 DataStore<T> 的实例，其中 T 是在 proto 文件中定义的类型。在您的 Kotlin 文件顶层调用该实例一次，便可在应用的所有其余部分通过此属性委托访问该实例。filename 参数会告知 DataStore 使用哪个文件存储数据，而 serializer 参数会告知 DataStore 第 1 步中定义的序列化器类的名称。

object SettingsSerializer : Serializer<Settings> {
  override val defaultValue: Settings = Settings.getDefaultInstance()

  override suspend fun readFrom(input: InputStream): Settings {
    try {
      return Settings.parseFrom(input)
    } catch (exception: InvalidProtocolBufferException) {
      throw CorruptionException("Cannot read proto.", exception)
    }
  }

  override suspend fun writeTo(
    t: Settings,
    output: OutputStream) = t.writeTo(output)
}

val Context.settingsDataStore: DataStore<Settings> by dataStore(
  fileName = "settings.pb",
  serializer = SettingsSerializer
)

读取内容

 val exampleCounterFlow: Flow<String> =  settingsDataStore.data
                .map { settings ->
                    // The exampleCounter property is generated from the proto schema.
                    settings.exampleCounter
                }

mainScope.launch {
            exampleCounterFlow.collect {
             Log.e("TAG",it)
            }
         }

内容写入

 mainScope.launch {
                settingsDataStore.updateData { currentSettings ->
                    currentSettings.toBuilder()
                        .setExampleCounter(etValue.text.toString())
                        .build()
                }
            }

参考：官网的DataStore
项目地址：https://gitee.com/LorenzoGao/jetpack-example