DataStore 与 Flow 结合：Preferences DataStore、Proto DataStore、实时读取、类型安全

4.1 DataStore 概述与 Flow 原生集成

DataStore 是 Jetpack 官方推荐的新型本地持久化组件，完全取代 SharedPreferences。它基于协程和 Flow 实现异步、线程安全的数据存储，天然支持响应式读取。DataStore 提供两种实现方式：

• Preferences DataStore：键值对存储，无类型约束，类似 SharedPreferences 但完全异步。
• Proto DataStore：使用 Protocol Buffers 定义结构化数据，在编译期保证类型安全，支持复杂对象。

4.2 Preferences DataStore 实现流程

4.2.1 添加依赖

// build.gradle (module)
implementation("androidx.datastore:datastore-preferences:1.1.1")

4.2.2 创建 DataStore

在顶层文件或单例中扩展 Context.preferencesDataStore 属性：

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

4.2.3 实时读取

通过 dataStore.data 获得 Flow，指定键：

val userTheme: Flow<Boolean> = context.settingsDataStore.data.map { preferences ->
    preferences[PreferenceKeys.THEME_KEY] ?: false
}

4.2.4 写入数据

suspend fun saveTheme(context: Context, isDark: Boolean) {
    context.settingsDataStore.edit { preferences ->
        preferences[PreferenceKeys.THEME_KEY] = isDark
    }
}

object PreferenceKeys {
    val THEME_KEY = booleanPreferencesKey("theme_dark")
}

4.3 Proto DataStore 实现流程

4.3.1 定义 Proto 文件

在 app/src/main/proto/ 目录下创建 user_prefs.proto：

syntax = "proto3";

option java_package = "com.example.app";
option java_multiple_files = true;

message UserPreferences {
  bool theme_dark = 1;
  int32 font_size = 2;
  string display_name = 3;
}

4.3.2 添加 Protobuf 插件和依赖

// root build.gradle
plugins {
    id "com.google.protobuf" version "0.9.4" apply false
}

// module build.gradle
plugins {
    id "com.google.protobuf"
}

protobuf {
    protoc { artifact = "com.google.protobuf:protoc:3.24.0" }
    generateProtoTasks {
        all().each { task ->
            task.builtins {
                java { option "lite" }
            }
        }
    }
}

dependencies {
    implementation "androidx.datastore:datastore:1.1.1"
    implementation "com.google.protobuf:protobuf-javalite:3.24.0"
}

4.3.3 创建 Proto DataStore

val Context.userPreferencesDataStore: DataStore<UserPreferences> by dataStore(
    fileName = "user_prefs.pb",
    serializer = UserPreferencesSerializer()
)

4.3.4 实现序列化器

object UserPreferencesSerializer : Serializer<UserPreferences> {
    override val defaultValue: UserPreferences
        get() = UserPreferences.getDefaultInstance()

    override fun readFrom(input: InputStream): UserPreferences {
        return UserPreferences.parseFrom(input)
    }

    override fun writeTo(t: UserPreferences, output: OutputStream) {
        t.writeTo(output)
    }
}

4.3.5 类型安全的读取与写入

val displayName: Flow<String> = context.userPreferencesDataStore.data.map { prefs ->
    prefs.displayName
}

suspend fun updateDisplayName(context: Context, name: String) {
    context.userPreferencesDataStore.updateData { currentPrefs ->
        currentPrefs.toBuilder()
            .setDisplayName(name)
            .build()
    }
}

4.4 实时读取与 Flow 操作符

DataStore 的 .data 属性返回 Flow<T>，可与标准 Flow 操作符组合：

context.userPreferencesDataStore.data
    .catch { e ->
        emit(UserPreferences.getDefaultInstance()) // 降级
    }
    .map { it.themeDark }
    .distinctUntilChanged()
    .collect { isDark ->
        // 更新 UI
    }

4.5 性能优化与稳定性

• 批量写入：在 edit 或 updateData 块内完成所有修改，避免多次提交。
• 减少全局 Flow 集合：使用 distinctUntilChanged 避免不必要的触发。
• 文件大小控制：Proto DataStore 使用二进制格式，通常很小；Preferences DataStore 应避免存储大量数据。
• 异常处理：在 collect 层使用 catch 并记录日志，防止应用崩溃。
• 内存泄漏预防：在 ViewModel 中使用 stateIn 或 shareIn 配合 viewModelScope 自动取消。

4.6 常见错误与调试