来实现一个DataStore的封装吧

2022-05-19 16:20 由 wendster 发表于 #移动端开发

之前Content Provider，Room，DataStore一起弄，对于蒟蒻我来说步子迈得太大了，bug满天飞（DataStore一直给我报错说同时打开了多个DataStore，却又找不到问题所在），遂不得不暂且抛下DataStore换回SharedPreference，后来才发现是被Hook应用在启动的时候，LSPosed检测了新Module导致同时Hook到了模块本身，然而模块里又没忽略自己，导致两个Content Resolver同时请求了两次数据。

既然bug已经解决了，那大可以把SharedPreference给扔了，由于Project目前过于混乱，不仅所有业务逻辑居然都在ViewModel和Provider里，而且SharedPreference的调用也分别在MainViewModel和MainProvider里写了两次，极为Chulu，为了以后自己和项目不爆炸，不得不学习一下工具类的封装，~~免得重复逻辑飞得到处都是。~~

然后就开始写DataStoreUtil，由于会被重复使用，所以必须使其遵循单例模式，~~因为本蒟蒻对单例模式这些东西一无所知，连object关键字都不知道是干嘛的~~，所以瞎学一气后，使用了最为简单的懒汉模式，直接用object定义一个单例，~~反正程序在启动时本来就要初始化DataStore的，懒汉模式的缺点在此就不构成影响，双重校验锁这种高级东西以后有需要再用吧~~。

由于Project其他部分的逻辑还不支持异步，所以我这里之暴露的同步操作的方法，以后支持异步了后，只要把private删掉就可以了。这回顺便还学习了个泛型，这样就可以用一个方法来处理不同的类型，不用像以前那样，定义一堆类似getBooleanPreference，getStringPreference的方法了。

val Context.dataStore by preferencesDataStore(name = "settings")

object DataStoreUtil {

    private lateinit var dataStore: DataStore<Preferences>
    fun initialize(context: Context) { dataStore = context.dataStore }

    fun <T> getPreference(key: String, defaultValue: T): T {
        return runBlocking { asyncGetPreference(key, defaultValue).first() }
    }

    fun <T> setPreference(key: String, value: T) {
        runBlocking { asyncSetPreference(key, value) }
    }

    @Suppress("UNCHECKED_CAST")
    private fun <T> asyncGetPreference(key: String, defaultValue: T): Flow<T> {
        return when (defaultValue) {
            is String -> dataStore.data.map { it[stringPreferencesKey(key)] ?: defaultValue }
            is Boolean -> dataStore.data.map { it[booleanPreferencesKey(key)] ?: defaultValue }
            else -> throw IllegalArgumentException("Wrong value provided with invalid value type")
        } as Flow<T>
    }

    private suspend fun <T> asyncSetPreference(key: String, value: T) {
        when (value) {
            is String -> dataStore.edit { it[stringPreferencesKey(key)] = value }
            is Boolean -> dataStore.edit { it[booleanPreferencesKey(key)] = value }
            else -> throw IllegalArgumentException("Wrong value provided with invalid value type")
        }
    }
}

使用例：

var dataStore: DataStoreUtil = DataStoreUtil.apply { initialize(context) }
val appTheme = dataStore.getPreference("theme", "light")
dataStore.setPreference("theme", "dark")

得益于Kotlin提供的内置拓展函数，原本需要两行的的代码被精简到了一行，美丽了不少。

除了搓一个单例，也可以用Kotlin的委托功能，像使用普通变量一样进行DataStore的存取操作。

class dataStoreVariable <T> (private val context: Context, private val key: String, private val defaultValue: T) : ReadWriteProperty<Any?, T> {

    private val dataStore by lazy { context.dataStore }

    @Suppress("UNCHECKED_CAST")
    override fun getValue(thisRef: Any?, property: KProperty<*>): T {
        return when (defaultValue) {
            is String -> runBlocking { dataStore.data.map { it[stringPreferencesKey(key)] ?: defaultValue } }
            is Boolean -> runBlocking { dataStore.data.map { it[booleanPreferencesKey(key)] ?: defaultValue } }
            else -> throw IllegalArgumentException("Wrong value provided with invalid value type")
        } as T
    }

    override fun setValue(thisRef: Any?, property: KProperty<*>, value: T) {
        when (value) {
            is String -> runBlocking { dataStore.edit { it[stringPreferencesKey(key)] = value } }
            is Boolean -> runBlocking { dataStore.edit { it[booleanPreferencesKey(key)] = value } }
            else -> throw IllegalArgumentException("Wrong value provided with invalid value type")
        }
    }
}

使用例：

var appTheme: String by dataStoreVariable(activity, "theme", "light")
appTheme = "dark"

看起来也非常不错，不过这里只写了同步的存取操作，如果需要异步只需要稍作修改即可。

当然，使用Kotlin的扩展功能也是可以实现的，就像给Context扩展dataStore一样，可以给Context扩展对DataStore进行各种操作的方法：

@Suppress("UNCHECKED_CAST")
fun <T> Context.getDataStoreValue(key: String, defaultValue: T): T {
    val dataStore = dataStore
    return when (defaultValue) {
        is String -> runBlocking { dataStore.data.map { it[stringPreferencesKey(key)] ?: defaultValue }.first() }
        is Boolean -> runBlocking { dataStore.data.map { it[booleanPreferencesKey(key)] ?: defaultValue }.first() }
        else -> throw IllegalArgumentException("Wrong value provided with invalid value type")
    } as T
}

fun <T> Context.setDataStoreValue(key: String, value: T) {
    val dataStore = dataStore
    when (value) {
        is String -> runBlocking { dataStore.edit { it[stringPreferencesKey(key)] = value } }
        is Boolean -> runBlocking { dataStore.edit { it[booleanPreferencesKey(key)] = value } }
        else -> throw IllegalArgumentException("Wrong value provided with invalid value type")
    }
}

然后就只需要拿着手上有的context，就可以获取DataStore里的值了：

var appTheme = context.getDataStoreValue("theme", "light")
context.setDataStoreValue("theme", "dark")

虽然说，工具类是一种违反面向对象思想的东西，应该多利用kotlin的特性（委托、扩展），但自己还是太菜了，所以这回在Project里依然选择了单例，希望以后能尽可能把后面这两种实现给用起来，还有太多东西需要学了（逃）。