您的小妾DataStore已经驾到,SharePreference离你而去

简介: 您的小妾DataStore已经驾到,SharePreference离你而去

DataStore 介绍


Jetpack DataStore 是一种数据存储解决方案,允许您使用协议缓冲区存储键值对或类型化对象。DataStore 使用 Kotlin 协程和 Flow 以异步、一致的事务方式存储数据。

DataStore 是用来替代 SharePreference 的,如果你的项目使用的是 SharePreference,那么建议你迁移到 DataStore

DataStore 提供两种实现 PreferenceDataStore 和 Proto DataStore


PreferenceDataStore

使用键值对的方式存储数据,不能确保类型安全


Proto DataStore

将数据作为自定义类型进行存储,可以确保类型安全


DataStore 使用


PreferenceDataStore

依赖

implementation("androidx.datastore:datastore:1.0.0-beta01")
复制代码


代码

  1. 初始化 DataStore

首先我们在 App 中初始化 dataStore,

class App: Application() {
    companion object{
        val Context.dataStore: DataStore<Preferences> by preferencesDataStore(name = "settings")
    }
}
复制代码

val Context.dataStore 这句代码调用后我们就可以再全局使用 dataStore 对象了


  1. 初始化 key
val EXAMPLE_COUNTER = intPreferencesKey("example_counter")
复制代码


  1. PreferenceDataStore 存储数据
dataStore.edit { settings ->
            val currentCounterValue = settings[EXAMPLE_COUNTER] ?: 0
            settings[EXAMPLE_COUNTER] = currentCounterValue + 1
        }
复制代码

存储数据的代码每次存储一次数据,EXAMPLE_COUNTER 对应的数据就会加一


  1. PreferenceDataStore 获取数据
val exampleCounterFlow: Flow<Int> = dataStore.data
                .map { preferences ->
                    logEE(preferences[EXAMPLE_COUNTER].toString())//打印数据
                    preferences[EXAMPLE_COUNTER] ?: 0
                }
复制代码


ProtoDataStore

Proto DataStore 实现使用 DataStore 和协议缓冲区将类型化的对象保留在磁盘上。

所谓的协议缓冲区,其实就是指的流

官网对 ProtoDataStore 的集成流程写的不全,所以我找到了这篇文章进行学习:

文章入口


配置集成

  1. 集成依赖
implementation("androidx.datastore:datastore-preferences:1.0.0-beta01")
 implementation "com.google.protobuf:protobuf-javalite:3.10.0"
复制代码


  1. 添加 protobuf protobuf 与 android 和 dependencies 同级
protobuf {
    // 设置 protoc 的版本
    protoc {
        // //从仓库下载 protoc 这里的版本号需要与依赖 com.google.protobuf:protobuf-javalite:xxx 版本相同
        artifact = 'com.google.protobuf:protoc:3.10.0'
    }
    generateProtoTasks {
        all().each { task ->
            task.builtins {
                java {
                    option "lite"
                }
            }
        }
    }
    // 默认生成目录 $buildDir/generated/source/proto 通过 generatedFilesBaseDir 改变生成位置
    generatedFilesBaseDir = "$projectDir/src/main"
}
复制代码


  1. 添加源码目录
sourceSets {
        main {
            proto {
                // proto 文件默认路径是 src/main/proto
                // 可以通过 srcDir 修改 proto 文件的位置
                srcDir 'src/main/proto'
            }
        }
    }
复制代码


  1. 添加 gradle 插件
id "com.google.protobuf" version "0.8.12"
复制代码

配置集成完成


代码集成

  1. 编写 proto 文件并编译

image.png


  1. 编写 proto 文件
syntax = "proto3";
option java_package = "com.ananananzhuo.datastoredemo";//必须是自己的包名
option java_multiple_files = true;
message Settings {
  int32 example_counter = 1;
}
复制代码


  1. 编写 java 文件 SettingsSerializer 这个文件在编译后会被移动到 src/main/debug/java/com.ananananzhuo.datastoredemo 目录下
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
)
复制代码


  1. 存储数据 存储数据一定要在协程中调用
suspend fun incrementCounter() {
        settingsDataStore.updateData { currentSettings ->
            currentSettings.toBuilder()
                .setExampleCounter(currentSettings.exampleCounter + 1)
                .build()
        }
    }
复制代码


  1. 获取数据
val exampleCounterFlow: Flow<Int> = settingsDataStore.data
                .map { settings ->
                    logEE(settings.exampleCounter.toString())//获取数据并打印
                    settings.exampleCounter
                }
复制代码

项目git地址:

github.com/ananananzhu…



相关文章
|
存储 XML 安全
Jetpack DataStore 你总要了解一下吧?
一、DataStore 介绍 DataStore 是 Android Jetpack 中的一个组件,它是一个数据存储的解决方案,跟 SharedPreferences 一样,采用key-value形式存储。 DataStore 保证原子性,一致性,隔离性,持久性。尤其是,它解决了 SharedPreferences API 的设计缺陷。 Jetpack DataStore 是经过改进的新版数据存储解决方案,旨在取代 SharedPreferences,让应用能够以异步、事务方式存储数据。
1032 0
Jetpack DataStore 你总要了解一下吧?
|
存储 安全 Java
一文带你玩转 DataStore
一文带你玩转 DataStore
607 0
一文带你玩转 DataStore
|
弹性计算 关系型数据库 MySQL
数据库表损坏解决方法( is marked as crashed and should be repaired)
表损坏原因过程大致如下,过了个国庆没有查看服务器状态,7号晚上手机收到ECS服务器异常短信,查了下发现是磁盘满了,导致无法创建临时空间,造成商城无法访问,速速的解决方法是删除了大量日志文件,访问网站发现已经ok了,一切正常,今天客户忽然打电话说,网站的搜索功能出现问题,我查了下错误原因
355 0
|
存储 安全 API
Jetpack之DataStore使用
前言DataStore提供了一种安全且持久的方式来存储少量数据。它不支持部分更新:如果任何字段被修改,整个对象将被序列化并持久到磁盘。它是线程安全的,非阻塞的。特别是,它解决了SharedPreferences这些设计缺陷:同步API鼓励违反StrictModeapply和commit没有发出错误信号的机制apply将阻塞fsync上的UI线程不持久-它可以返回尚未持久的状态没有一致性或事务语义在
294 0
Jetpack之DataStore使用
DHL
|
存储 JSON Ubuntu
[Google]再见SharedPreferences拥抱DataStore (二)
今天这篇文章主要来介绍 Proto DataStore,Proto DataStore 通过 protocol buffers 将对象序列化存储在本地,所以首先需要安装 Protobuf 编译 proto 文件,Protobuf 编译大致分为 Gradle 插件编译和命令行编译
DHL
332 0
[Google]再见SharedPreferences拥抱DataStore (二)
DHL
|
存储 缓存 安全
[Google] 再见 SharedPreferences 拥抱 Jetpack DataStore
Google 新增加了一个新 Jetpack 的成员 DataStore,主要用来替换 SharedPreferences, DataStore 应该是开发者期待已久的库,DataStore 是基于 Flow 实现的,一种新的数据存储方案,它提供了两种实现方式
DHL
346 0
[Google] 再见 SharedPreferences 拥抱 Jetpack DataStore
|
存储 安全 测试技术
DataStore —— SharedPreferences 的替代者 ?
DataStore —— SharedPreferences 的替代者 ?