如何巧用协程和流为 DataStore 偏好项实现值范围检查？

Android

2024-03-12 10:10:33

DataStore 偏好项中值的范围检查：巧用协程和流

问题：避免DataStore值的越界

在使用 DataStore 管理偏好项时，我们经常遇到一个问题：如何限制偏好项值的大小？例如，我们希望确保游戏中的生命值永远在 0 到 10 之间，但 DataStore 本身并没有提供这种功能。

解决方案：协程和流的力量

解决这个问题的关键在于利用协程和流。DataStore 提供了一个流接口，它以非阻塞方式监听值的变化。我们可以使用协程在流中捕获这些变化，并在此过程中执行范围检查。

优化实现

以下是优化后的实现：

创建一个 PrivateFlow，它会发射每次偏好项更新。
在流中映射值，执行范围检查，并将值限制在给定的范围内。
使用 distinctUntilChanged() 避免重复发射相同的值。
提供一个公共 Flow，用于安全获取偏好项值。

优点

这种方法有以下优点：

非阻塞范围检查： 协程使我们能够在不阻塞主线程的情况下执行范围检查。
易于理解： 实现简洁且易于理解，从而提高了代码的可维护性。
避免空值错误： 使用流可以避免因空值偏好项而引起的错误。

代码示例

// 创建一个 PrivateFlow，它会发射偏好项更新
private val numberOfLivesFlow: PrivateFlow<Int> = datastore.data
    .map { preferences ->
        // 获取偏好项值
        val numberOfLives = preferences[NUMBER_OF_LIVES_KEY] ?: 5

        // 检查值是否超出范围
        if (numberOfLives < 0) {
            0
        } else if (numberOfLives > 5) {
            5
        } else {
            numberOfLives
        }
    }
    .distinctUntilChanged()  // 避免重复发射相同的值

// 公开一个 Flow，以安全的方式获取偏好项值
val getNumberOfLives: Flow<Int> = numberOfLivesFlow

// 设置偏好项值，并立即验证范围
suspend fun setNumberOfLives(numberOfLives: Int) {
    datastore.edit { preferences ->
        if (numberOfLives < 0) {
            preferences[NUMBER_OF_LIVES_KEY] = 0
        } else if (numberOfLives > 5) {
            preferences[NUMBER_OF_LIVES_KEY] = 5
        } else {
            preferences[NUMBER_OF_LIVES_KEY] = numberOfLives
        }
    }
}