Implement DataStore for configuration management and migrate from SharedPreferences

wxxsfxyzm · wxxsfxyzm · commit 7596c819032e · 2025-06-06T20:11:27.000+08:00
diff --git a/app/src/main/java/com/rosan/installer/data/settings/model/datastore/AppDataStore.kt b/app/src/main/java/com/rosan/installer/data/settings/model/datastore/AppDataStore.kt
@@ -0,0 +1,28 @@
+package com.rosan.installer.data.settings.model.datastore
+
+import androidx.datastore.core.DataStore
+import androidx.datastore.preferences.core.Preferences
+import androidx.datastore.preferences.core.edit
+import androidx.datastore.preferences.core.intPreferencesKey
+import androidx.datastore.preferences.core.stringPreferencesKey
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.map
+
+class AppDataStore(private val dataStore: DataStore<Preferences>) {
+
+    suspend fun putString(key: String, value: String) {
+        dataStore.edit { it[stringPreferencesKey(key)] = value }
+    }
+
+    fun getString(key: String, default: String = ""): Flow<String> {
+        return dataStore.data.map { it[stringPreferencesKey(key)] ?: default }
+    }
+
+    suspend fun putInt(key: String, value: Int) {
+        dataStore.edit { it[intPreferencesKey(key)] = value }
+    }
+
+    fun getInt(key: String, default: Int = 0): Flow<Int> {
+        return dataStore.data.map { it[intPreferencesKey(key)] ?: default }
+    }
+}
diff --git a/app/src/main/java/com/rosan/installer/data/settings/model/room/entity/converter/AuthorizerConverter.kt b/app/src/main/java/com/rosan/installer/data/settings/model/room/entity/converter/AuthorizerConverter.kt
@@ -6,7 +6,7 @@ import com.rosan.installer.data.settings.model.room.entity.ConfigEntity
 object AuthorizerConverter {
     @TypeConverter
     fun revert(value: String?): ConfigEntity.Authorizer =
-        (if (value != null) ConfigEntity.Authorizer.values().find { it.value == value }
+        (if (value != null) ConfigEntity.Authorizer.entries.find { it.value == value }
         else null) ?: ConfigEntity.Authorizer.Shizuku
 
     @TypeConverter
diff --git a/app/src/main/java/com/rosan/installer/data/settings/util/ConfigUtil.kt b/app/src/main/java/com/rosan/installer/data/settings/util/ConfigUtil.kt
@@ -1,42 +1,88 @@
 package com.rosan.installer.data.settings.util
 
-import android.content.Context
+import com.rosan.installer.data.settings.model.datastore.AppDataStore
 import com.rosan.installer.data.settings.model.room.entity.AppEntity
 import com.rosan.installer.data.settings.model.room.entity.ConfigEntity
 import com.rosan.installer.data.settings.model.room.entity.converter.AuthorizerConverter
 import com.rosan.installer.data.settings.model.room.entity.converter.InstallModeConverter
 import com.rosan.installer.data.settings.repo.AppRepo
 import com.rosan.installer.data.settings.repo.ConfigRepo
 import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.flow.first
 import kotlinx.coroutines.withContext
 import org.koin.core.component.KoinComponent
 import org.koin.core.component.get
 import org.koin.core.component.inject
 
+/**
+ * Utility class for managing configuration settings.
+ *
+ * DataStore 迁移注意事项
+ * 由于 DataStore 的读写是异步操作，原本通过 `val` 属性（同步获取）的配置项，迁移后需改为 `suspend fun`（挂起函数）。调用时必须在协程或挂起环境下进行，否则会编译报错。
+ *
+ * 迁移前（同步）
+ * val authorizer = ConfigUtil.globalAuthorizer
+ *
+ * 迁移后（异步）
+ * val authorizer = withContext(Dispatchers.IO) {
+ *     ConfigUtil.getGlobalAuthorizer()
+ * }
+ **/
 class ConfigUtil {
     companion object : KoinComponent {
-        private val context by inject<Context>()
+        // SharedPreferences
+//        private val context by inject<Context>()
+//        private val sharedPreferences = context.getSharedPreferences("app", Context.MODE_PRIVATE)
 
-        private val sharedPreferences = context.getSharedPreferences("app", Context.MODE_PRIVATE)
+        // DataStore
+        private val appDataStore by inject<AppDataStore>()
 
-        val globalAuthorizer: ConfigEntity.Authorizer
-            get() = AuthorizerConverter.revert(sharedPreferences.getString("authorizer", null))
+        /*
+                val globalAuthorizer: ConfigEntity.Authorizer
+                    get() = AuthorizerConverter.revert(sharedPreferences.getString("authorizer", null))
 
-        val globalCustomizeAuthorizer: String
-            get() = sharedPreferences.getString("customize_authorizer", null) ?: ""
+                val globalCustomizeAuthorizer: String
+                    get() = sharedPreferences.getString("customize_authorizer", null) ?: ""
 
-        val globalInstallMode: ConfigEntity.InstallMode
-            get() = InstallModeConverter.revert(sharedPreferences.getString("install_mode", null))
+                val globalInstallMode: ConfigEntity.InstallMode
+                    get() = InstallModeConverter.revert(sharedPreferences.getString("install_mode", null))
+        */
+
+        suspend fun getGlobalAuthorizer(): ConfigEntity.Authorizer {
+            val str = appDataStore.getString("authorizer", "").first()
+            return AuthorizerConverter.revert(str)
+        }
+
+        suspend fun getGlobalCustomizeAuthorizer(): String {
+            return appDataStore.getString("customize_authorizer", "").first()
+        }
+
+        suspend fun getGlobalInstallMode(): ConfigEntity.InstallMode {
+            val str = appDataStore.getString("install_mode", "").first()
+            return InstallModeConverter.revert(str)
+        }
+
+        /*        suspend fun getByPackageName(packageName: String? = null): ConfigEntity {
+                    var entity = getByPackageNameInner(packageName)
+                    if (entity.authorizer == ConfigEntity.Authorizer.Global)
+                        entity = entity.copy(
+                            authorizer = globalAuthorizer,
+                            customizeAuthorizer = globalCustomizeAuthorizer
+                        )
+                    if (entity.installMode == ConfigEntity.InstallMode.Global)
+                        entity = entity.copy(installMode = globalInstallMode)
+                    return entity
+                }*/
 
         suspend fun getByPackageName(packageName: String? = null): ConfigEntity {
             var entity = getByPackageNameInner(packageName)
             if (entity.authorizer == ConfigEntity.Authorizer.Global)
                 entity = entity.copy(
-                    authorizer = globalAuthorizer,
-                    customizeAuthorizer = globalCustomizeAuthorizer
+                    authorizer = getGlobalAuthorizer(),
+                    customizeAuthorizer = getGlobalCustomizeAuthorizer()
                 )
             if (entity.installMode == ConfigEntity.InstallMode.Global)
-                entity = entity.copy(installMode = globalInstallMode)
+                entity = entity.copy(installMode = getGlobalInstallMode())
             return entity
         }
 
@@ -61,4 +107,4 @@ class ConfigUtil {
             return null
         }
     }
-}
+}
diff --git a/app/src/main/java/com/rosan/installer/di/datastore_module.kt b/app/src/main/java/com/rosan/installer/di/datastore_module.kt
@@ -0,0 +1,25 @@
+package com.rosan.installer.di
+
+import androidx.datastore.preferences.SharedPreferencesMigration
+import androidx.datastore.preferences.core.PreferenceDataStoreFactory
+import androidx.datastore.preferences.preferencesDataStoreFile
+import com.rosan.installer.data.settings.model.datastore.AppDataStore
+import org.koin.android.ext.koin.androidContext
+import org.koin.dsl.module
+
+val datastoreModule = module {
+    single {
+        PreferenceDataStoreFactory.create(
+            migrations = listOf(
+                // Migration from SharedPreferences to DataStore
+                SharedPreferencesMigration(androidContext(), "app")
+            )
+        ) {
+            androidContext().preferencesDataStoreFile("app_settings")
+        }
+    }
+
+    single {
+        AppDataStore(get())
+    }
+}
diff --git a/app/src/main/java/com/rosan/installer/di/init/app_modules.kt b/app/src/main/java/com/rosan/installer/di/init/app_modules.kt
@@ -1,5 +1,6 @@
 package com.rosan.installer.di.init
 
+import com.rosan.installer.di.datastoreModule
 import com.rosan.installer.di.installerModule
 import com.rosan.installer.di.reflectModule
 import com.rosan.installer.di.roomModule
@@ -13,5 +14,6 @@ val appModules = listOf(
     serializationModule,
     workerModule,
     installerModule,
-    reflectModule
+    reflectModule,
+    datastoreModule
 )
diff --git a/app/src/main/java/com/rosan/installer/di/viewmodel_module.kt b/app/src/main/java/com/rosan/installer/di/viewmodel_module.kt
@@ -16,7 +16,7 @@ val viewModelModule = module {
     }
 
     viewModel {
-        PreferredViewModel()
+        PreferredViewModel(get())
     }
 
     viewModel { (navController: NavController) ->
diff --git a/app/src/main/java/com/rosan/installer/ui/activity/SettingsActivity.kt b/app/src/main/java/com/rosan/installer/ui/activity/SettingsActivity.kt
@@ -1,37 +1,19 @@
 package com.rosan.installer.ui.activity
 
-import android.content.Context
 import android.os.Bundle
-import android.text.method.LinkMovementMethod
-import android.widget.TextView
 import androidx.activity.ComponentActivity
 import androidx.activity.compose.setContent
 import androidx.activity.enableEdgeToEdge
 import androidx.compose.foundation.layout.fillMaxSize
-import androidx.compose.material3.AlertDialog
-import androidx.compose.material3.AlertDialogDefaults
 import androidx.compose.material3.Surface
-import androidx.compose.material3.Text
-import androidx.compose.material3.TextButton
-import androidx.compose.runtime.Composable
-import androidx.compose.runtime.getValue
-import androidx.compose.runtime.mutableStateOf
-import androidx.compose.runtime.remember
-import androidx.compose.runtime.setValue
 import androidx.compose.ui.Modifier
-import androidx.compose.ui.graphics.toArgb
-import androidx.compose.ui.platform.LocalContext
-import androidx.compose.ui.res.stringResource
-import androidx.compose.ui.viewinterop.AndroidView
-import androidx.core.content.edit
-import androidx.core.text.HtmlCompat
-import com.rosan.installer.R
 import com.rosan.installer.ui.page.settings.SettingsPage
 import com.rosan.installer.ui.theme.InstallerTheme
 import org.koin.core.component.KoinComponent
 
 class SettingsActivity : ComponentActivity(), KoinComponent {
     override fun onCreate(savedInstanceState: Bundle?) {
+        // Enable edge-to-edge mode for immersive experience
         enableEdgeToEdge()
         super.onCreate(savedInstanceState)
         setContent {
@@ -41,16 +23,17 @@ class SettingsActivity : ComponentActivity(), KoinComponent {
                     modifier = Modifier
                         .fillMaxSize()
                 ) {
+                    // Disable AgreementDialog for now
                     // AgreementDialog()
                     SettingsPage()
                 }
             }
         }
     }
 
-    @Composable
+    /*@Composable
     private fun AgreementDialog() {
-        val preferences = LocalContext.current.getSharedPreferences("app", Context.MODE_PRIVATE)
+        val preferences = LocalContext.current.getSharedPreferences("app", MODE_PRIVATE)
         var agreed by remember {
             mutableStateOf(preferences.getBoolean("agreement", false))
         }
@@ -87,5 +70,5 @@ class SettingsActivity : ComponentActivity(), KoinComponent {
                 Text(text = stringResource(id = R.string.agree))
             }
         })
-    }
+    }*/
 }
diff --git a/app/src/main/java/com/rosan/installer/ui/page/settings/config/edit/EditPage.kt b/app/src/main/java/com/rosan/installer/ui/page/settings/config/edit/EditPage.kt
@@ -43,6 +43,7 @@ import androidx.compose.runtime.LaunchedEffect
 import androidx.compose.runtime.MutableState
 import androidx.compose.runtime.getValue
 import androidx.compose.runtime.mutableStateOf
+import androidx.compose.runtime.produceState
 import androidx.compose.runtime.remember
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.geometry.Offset
@@ -297,7 +298,13 @@ fun DataInstallModeWidget(viewModel: EditViewModel) {
 fun DataDeclareInstallerWidget(viewModel: EditViewModel) {
     var authorizer = viewModel.state.data.authorizer
     if (authorizer == ConfigEntity.Authorizer.Global)
-        authorizer = ConfigUtil.globalAuthorizer
+    // authorizer = ConfigUtil.globalAuthorizer
+    {
+        val globalAuthorizer by produceState<ConfigEntity.Authorizer?>(null) {
+            value = ConfigUtil.getGlobalAuthorizer()
+        }
+        authorizer = globalAuthorizer!!
+    }
     val declareInstaller = viewModel.state.data.declareInstaller
     if (authorizer == ConfigEntity.Authorizer.Dhizuku) {
         viewModel.dispatch(EditViewAction.ChangeDataDeclareInstaller(false))
diff --git a/app/src/main/java/com/rosan/installer/ui/page/settings/main/MainPage.kt b/app/src/main/java/com/rosan/installer/ui/page/settings/main/MainPage.kt
@@ -72,7 +72,7 @@ fun MainPage(navController: NavController) {
         modifier = Modifier
             .fillMaxSize()
     ) {
-        val isLandscapeScreen = maxHeight / maxWidth > 1.4
+        val isLandscapeScreen = this.maxHeight.value / this.maxWidth.value > 1.4
 
         val navigationSide =
             if (isLandscapeScreen) WindowInsetsSides.Bottom
diff --git a/app/src/main/java/com/rosan/installer/ui/page/settings/preferred/PreferredViewModel.kt b/app/src/main/java/com/rosan/installer/ui/page/settings/preferred/PreferredViewModel.kt

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ val viewModelModule = module {`
`16`	`16`	`}`
`17`	`17`
`18`	`18`	`viewModel {`
`19`		`- PreferredViewModel()`
	`19`	`+ PreferredViewModel(get())`
`20`	`20`	`}`
`21`	`21`
`22`	`22`	`viewModel { (navController: NavController) ->`