v1.1.4 released!

Author: FunnySaltyFish

app/src/main/java/com/funny/composedatasaver/ExampleActivity.kt

@@ -11,12 +11,9 @@ import androidx.datastore.preferences.preferencesDataStore
 import com.funny.composedatasaver.ui.ExampleBean
 import com.funny.composedatasaver.ui.ExampleComposable
 import com.funny.composedatasaver.ui.theme.FunnyTheme
-import com.funny.data_saver.core.DataSaverPreferences
-import com.funny.data_saver.core.DataSaverPreferences.Companion.setContext
+import com.funny.data_saver.core.DataSaverConverter.registerTypeConverters
 import com.funny.data_saver.core.LocalDataSaver
-import com.funny.data_saver.core.registerTypeConverters
-import com.funny.data_saver_mmkv.DataSaverMMKV
-import com.funny.data_saver_mmkv.DataSaverMMKV.Companion.setKV
+import com.funny.data_saver_mmkv.DefaultDataSaverMMKV
 import com.tencent.mmkv.MMKV
 import kotlinx.serialization.ExperimentalSerializationApi
 import kotlinx.serialization.decodeFromString
@@ -31,23 +28,18 @@ class ExampleActivity : ComponentActivity() {
         super.onCreate(savedInstanceState)
 
         // init preferences
-        val dataSaverPreferences = DataSaverPreferences().apply {
-            setContext(context = applicationContext)
-        }
+        // val dataSaverPreferences = DataSaverPreferences(applicationContext)
 
         // If you want to use [MMKV](https://github.com/Tencent/MMKV) to save data
         MMKV.initialize(applicationContext)
-        val dataSaverMMKV = DataSaverMMKV().apply {
-            setKV(newKV = MMKV.defaultMMKV())
-        }
+        val dataSaverMMKV = DefaultDataSaverMMKV
+        // you can use DefaultDataSaverMMKV like `DefaultDataSaverMMKV.readData(key, default)` and `DefaultDataSaverMMKV.saveData(key, value) anywhere`
 
         // if you want to use [DataStorePreference](https://developer.android.google.cn/jetpack/androidx/releases/datastore) to save data
-//        val dataSaverDataStorePreferences = DataSaverDataStorePreferences().apply {
-//            setDataStorePreferences(applicationContext.dataStore)
-//        }
+        // val dataSaverDataStorePreferences = DataSaverDataStorePreferences(applicationContext.dataStore)
 
         // cause we want to save custom bean, we provide a converter to convert it into String
-        registerTypeConverters<ExampleBean>(
+        registerTypeConverters<ExampleBean?>(
             save = { bean -> Json.encodeToString(bean) },
             restore = { str -> Json.decodeFromString(str) }
         )

app/src/main/java/com/funny/composedatasaver/ui/ExampleComposables.kt

@@ -8,9 +8,7 @@ import androidx.compose.foundation.verticalScroll
 import androidx.compose.material.*
 import androidx.compose.runtime.*
 import androidx.compose.ui.Modifier
-import androidx.compose.ui.platform.LocalContext
 import androidx.compose.ui.text.font.FontWeight
-import androidx.compose.ui.tooling.preview.Preview
 import androidx.compose.ui.unit.dp
 import androidx.compose.ui.unit.sp
 import com.funny.composedatasaver.Constant
@@ -19,8 +17,6 @@ import com.funny.composedatasaver.Constant.KEY_BOOLEAN_EXAMPLE
 import com.funny.composedatasaver.Constant.KEY_STRING_EXAMPLE
 import com.funny.composedatasaver.ExampleParcelable
 import com.funny.data_saver.core.*
-import com.funny.data_saver_mmkv.DataSaverMMKV
-import com.tencent.mmkv.MMKV
 import kotlinx.serialization.ExperimentalSerializationApi
 import kotlinx.serialization.Serializable
 
@@ -37,8 +33,9 @@ import kotlinx.serialization.Serializable
  */
 
 @Serializable
-data class ExampleBean(var id:Int, val label:String)
-val EmptyBean = ExampleBean(233,"FunnySaltyFish")
+data class ExampleBean(var id: Int, val label: String)
+
+val EmptyBean = ExampleBean(233, "FunnySaltyFish")
 
 
 @ExperimentalSerializationApi
@@ -55,15 +52,24 @@ fun ExampleComposable() {
     // 你可以设置 [savePolicy]为其他类型(参见 [SavePolicy] )，以防止某些情况下过于频繁地保存
     // 如果你设置为 SavePolicy.NEVER，则写入本地的操作需要自己做
     // 例如: onClick = { dataSaverState.save() }
-    var stringExample by rememberDataSaverState(KEY_STRING_EXAMPLE, "", savePolicy = SavePolicy.IMMEDIATELY, async = true)
+    var stringExample by rememberDataSaverState(
+        KEY_STRING_EXAMPLE,
+        "",
+        savePolicy = SavePolicy.IMMEDIATELY,
+        async = true
+    )
 
     var booleanExample by rememberDataSaverState(KEY_BOOLEAN_EXAMPLE, false)
 
     var beanExample by rememberDataSaverState(KEY_BEAN_EXAMPLE, default = EmptyBean)
 
-    var listExample by rememberDataSaverListState(key = "key_list_example", default = listOf(
-        EmptyBean.copy(label = "Name 1"), EmptyBean.copy(label = "Name 2"),EmptyBean.copy(label = "Name 3")
-    ))
+    var listExample by rememberDataSaverListState(
+        key = "key_list_example", default = listOf(
+            EmptyBean.copy(label = "Name 1"),
+            EmptyBean.copy(label = "Name 2"),
+            EmptyBean.copy(label = "Name 3")
+        )
+    )
 
     // Among our basic implementations, only MMKV supports `Parcelable` by default
     var parcelableExample by rememberDataSaverState(
@@ -90,34 +96,59 @@ fun ExampleComposable() {
 
         Text(text = "This is an example of saving Parcelable") // 保存布尔值的示例
         Text(parcelableExample.toString())
-        Button(onClick = { parcelableExample = parcelableExample.copy(age = parcelableExample.age + 1) }) {
+        Button(onClick = {
+            parcelableExample = parcelableExample.copy(age = parcelableExample.age + 1)
+        }) {
             Text(text = "Add age by 1")
         }
 
         Text(text = "This is an example of saving custom Data Bean") // 保存自定义类型的示例
         Text(text = beanExample.toString())
         Button(onClick = {
-            beanExample = beanExample.copy(id = beanExample.id+1)
+            beanExample = beanExample.copy(id = beanExample.id + 1)
         }) {
             Text(text = "Add bean's id") // id自加
         }
 
+        val nullableCustomBeanState: DataSaverMutableState<ExampleBean?> = rememberDataSaverState(key = "nullable_bean", initialValue = null)
+        Text(text = "This is an example of saving custom Data Bean(nullable)") // 保存自定义类型的示例
+        Text(text = nullableCustomBeanState.value.toString())
+        Row(Modifier.fillMaxWidth()) {
+            Button(onClick = {
+                nullableCustomBeanState.value = ExampleBean(id = 100, label = "I'm not null")
+            }) {
+                Text(text = "Set As Not Null")
+            }
+            Button(onClick = {
+                nullableCustomBeanState.value = null
+                // nullableCustomBeanState.remove(replacement = EmptyBean)
+            }) {
+                Text(text = "Set As Null")
+            }
+        }
+
+
         Spacer(modifier = Modifier.height(16.dp))
         Heading(text = "Save-When-Disposed Examples:")
         SaveWhenDisposedExample()
 
         Spacer(modifier = Modifier.height(16.dp))
         Heading(text = "List Example")
         LazyColumn(Modifier.heightIn(0.dp, 400.dp)) {
-            items(listExample){ item ->
+            items(listExample) { item ->
                 Text(modifier = Modifier.padding(8.dp), text = item.toString(), fontSize = 16.sp)
             }
             item {
                 Row {
-                    Button(onClick = { listExample = listExample + EmptyBean.copy(label = "Name ${listExample.size + 1}") }) {
+                    Button(onClick = {
+                        listExample =
+                            listExample + EmptyBean.copy(label = "Name ${listExample.size + 1}")
+                    }) {
                         Text(text = "Add To List")
                     }
-                    Button(onClick = { if (listExample.isNotEmpty()) listExample = listExample.dropLast(1) }) {
+                    Button(onClick = {
+                        if (listExample.isNotEmpty()) listExample = listExample.dropLast(1)
+                    }) {
                         Text(text = "Remove From List")
                     }
                 }
@@ -152,30 +183,6 @@ private fun SaveWhenDisposedExample() {
     }
 }
 
-
-@OptIn(ExperimentalSerializationApi::class)
-@Preview
-@Composable
-fun PreViewExample() {
-    val context = LocalContext.current
-    SideEffect {
-        MMKV.initialize(context.applicationContext)
-    }
-
-    val dataSaverMMKV = remember {
-        DataSaverMMKV().apply {
-            DataSaverMMKV.setKV(newKV = MMKV.defaultMMKV())
-        }
-    }
-
-    CompositionLocalProvider(LocalDataSaver provides dataSaverMMKV){
-        // or LocalDataSaver provides dataSaverMMKV
-        // or LocalDataSaver provides dataSaverDataStorePreferences
-        // or your Class instance
-        ExampleComposable()
-    }
-}
-
 @Composable
 fun Heading(text: String) {
     Text(text, fontWeight = FontWeight.W600, fontSize = 18.sp)

build.gradle

@@ -1,7 +1,7 @@
 // Top-level build file where you can add configuration options common to all sub-projects/modules.
 buildscript {
     ext.kotlin_version = '1.7.10'
-    ext.version_name = "1.1.2"
+    ext.version_name = "1.1.4"
     ext.compose_version = "1.3.0"
     repositories {
         google()

data_saver_core/src/main/java/com/funny/data_saver/core/SavePolicy.kt

@@ -15,7 +15,7 @@ open class SavePolicy {
 
     /**
      * do data persistence when the Composable enters `onDispose`. NOTE: USE THIS MODE CAREFULLY, BECAUSE SOMETIME
-     * `onDispose` will not be called
+     * `onDispose` WILL NOT BE CALLED
      *
      * Composable `onDispose` 时做数据持久化，适合数据变动比较频繁、且此Composable会进入onDispose的情况。
      * **慎用此模式，因为有些情况下onDispose不会被回调**

data_saver_data_store_preferences/src/main/java/com/funny/data_saver_data_store/DataSaverDataStore.kt

@@ -36,7 +36,6 @@ class DataSaverDataStorePreferences(private val dataStore: DataStore<Preferences
     // Reference：https://blog.csdn.net/qq_36707431/article/details/119447093
     private suspend fun <T> get(dataStore: DataStore<Preferences>, key: String, default: T): T {
         return when (default) {
-            null -> default
             is Int -> {
                 dataStore.data.map { setting ->
                     setting[intPreferencesKey(key)] ?: default

data_saver_mmkv/build.gradle

@@ -72,7 +72,7 @@ dependencies {
     implementation "androidx.compose.ui:ui:$compose_version"
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"
 
-    implementation 'com.tencent:mmkv:1.2.12'
+    implementation 'com.tencent:mmkv:1.2.14'
     implementation project(path: ":data_saver_core")
 
     testImplementation 'junit:junit:4.13.2'