如何让Proto Datastore布尔字段useVoiceReader默认值为true？

问题背景 #

使用Proto Datastore存储用户偏好时，需要将useVoiceReader布尔字段的默认值强制设置为true，但当前配置的默认值未生效。相关代码如下：

偏好模型类 #

data class UserData(
    val themeBrand: ThemeBrand,
    val shouldHideOnboarding: Boolean,
    val dynamic: UserDataDynamic    
)

data class UserDataDynamic(
    val darkThemeConfig: DarkThemeConfig,
    val useDynamicColor: Boolean,
    val useVoiceReader: Boolean = true,
    val useMultipleInvitatory: Boolean,
    val rubricColor: RubricColorConfig,
)

PreferencesDataSource代码 #

class PreferencesDataSource @Inject constructor(
    private val userPreferences: DataStore<UserPreferences>,
) {
    val userData = userPreferences.data
        .map {
            UserData(
                bookmarkedNewsResources = it.bookmarkedNewsResourceIdsMap.keys,
                viewedNewsResources = it.viewedNewsResourceIdsMap.keys,
                followedTopics = it.followedTopicIdsMap.keys,
                themeBrand = when (it.themeBrand) {
                    null,
                    ThemeBrandProto.THEME_BRAND_UNSPECIFIED,
                    ThemeBrandProto.UNRECOGNIZED,
                    ThemeBrandProto.THEME_BRAND_DEFAULT,
                    -> ThemeBrand.DEFAULT

                    ThemeBrandProto.THEME_BRAND_ANDROID -> ThemeBrand.ANDROID
                },
                shouldHideOnboarding = it.shouldHideOnboarding,

                dynamic = UserDataDynamic(
                darkThemeConfig = when (it.darkThemeConfig) {
                    null,
                    DarkThemeConfigProto.DARK_THEME_CONFIG_UNSPECIFIED,
                    DarkThemeConfigProto.UNRECOGNIZED,
                    DarkThemeConfigProto.DARK_THEME_CONFIG_FOLLOW_SYSTEM,
                    ->
                        DarkThemeConfig.FOLLOW_SYSTEM
                    DarkThemeConfigProto.DARK_THEME_CONFIG_LIGHT ->
                        DarkThemeConfig.LIGHT
                    DarkThemeConfigProto.DARK_THEME_CONFIG_DARK -> DarkThemeConfig.DARK
                },
                    rubricColor = when (it.rubricColor) {
                        null,
                        RubricColorProto.RUBRIC_COLOR_LIGHT,
                        ->
                            RubricColorConfig.LIGHT

                        RubricColorProto.RUBRIC_COLOR_DARK,
                        ->
                            RubricColorConfig.DARK

                        RubricColorProto.UNRECOGNIZED -> RubricColorConfig.LIGHT
                    },
                useDynamicColor = it.useDynamicColor,
                    useVoiceReader = it.useVoiceReader,
                    useMultipleInvitatory = it.useMultipleInvitatory
                )
            }
        }

    suspend fun setVoiceReaderPreference(useVoiceReader: Boolean) {
        userPreferences.updateData {
            it.copy { this.useVoiceReader = useVoiceReader }
        }
    }

}

Proto文件 #

syntax = "proto3";

option java_package = "***";
option java_multiple_files = true;

message UserPreferences {
  reserved 2;
  
  // ...

  ThemeBrandProto theme_brand = 16;
  DarkThemeConfigProto dark_theme_config = 17;
  RubricColorProto rubric_color = 18;

  bool should_hide_onboarding = 19;

  bool use_dynamic_color = 21;

  bool use_voice_reader = 22;

  bool use_multiple_invitatory = 23;

  // NEXT AVAILABLE ID: 24

}

原因分析 #

1. Proto3默认值规则：Proto3中布尔类型的默认值为false，当字段未被写入Datastore时，读取会返回这个默认值，优先级高于Kotlin data class的默认参数。
2. 映射逻辑问题：当前代码中直接使用it.useVoiceReader赋值，未处理字段未设置的情况，导致Proto的默认false覆盖了预期的true。

解决方案 #

1. 修改映射逻辑，强制设置默认值 #

在PreferencesDataSource的map块中，修改useVoiceReader的赋值逻辑，判断字段是否被设置过：如果未设置（即使用Proto默认值），则返回true；否则使用存储的值。

修改后的代码片段：

dynamic = UserDataDynamic(
    // 其他字段保持不变
    useVoiceReader = if (it.hasUseVoiceReader()) it.useVoiceReader else true,
    useMultipleInvitatory = it.useMultipleInvitatory
)

注：Proto生成的类会自动为每个字段生成hasXxx()方法，用于判断该字段是否被显式设置过。

2. 迁移现有用户数据（可选） #

如果需要确保所有用户（包括之前未设置过该字段的老用户）都使用true作为默认值，可以在应用启动时执行一次数据迁移：

在PreferencesDataSource中添加迁移方法：

suspend fun migrateVoiceReaderDefault() {
    userPreferences.updateData { prefs ->
        // 若字段未设置，强制设为true；若需要覆盖所有用户（包括之前设为false的），直接返回copy后的对象即可
        if (!prefs.hasUseVoiceReader()) {
            prefs.copy { useVoiceReader = true }
        } else {
            prefs
        }
    }
}

然后在应用启动流程中（比如Application类的onCreate方法，或启动页的ViewModel中）调用该方法：

// 在协程中调用
viewModelScope.launch {
    preferencesDataSource.migrateVoiceReaderDefault()
}

3. 验证效果 #

修改后，新安装应用的用户会默认使用true；老用户首次启动时，若未设置过该字段，也会自动切换为true。如果需要强制所有用户都使用true，去掉迁移方法中的else分支即可。

内容的提问来源于stack exchange，提问作者A. Cedano