preference 工具库

版本

dependencies {
 val version = "1.2.7"
 //必选
 implementation("com.github.Knightwood.ComposePreference:preference-data-core:$version")
 //如不需要界面,可以不引入此依赖
 implementation("com.github.Knightwood.ComposePreference:preference-ui-compose:$version")
 //偏好值读写工具,下面三选一,或者自己实现读写接口
 implementation("com.github.Knightwood.ComposePreference:preference-util:$version")
 implementation("com.github.Knightwood.ComposePreference:datastore-util:$version")
 implementation("com.github.Knightwood.ComposePreference:preference-mmkv-util:$version")
}
//注:如果使用mmkv,sharedpreference,你自己的工程不要忘记引入相应mmkv,sharedpreference依赖,以及初始化mmkv等。

介绍图

支持的存储偏好值的工具

委托工具类

mmkv 委托工具

 class MMKVHelper private constructor(val mmkv: MMKV) {
 //使用委托的方式生成一个委托对象,除了[parcelableM]方法,初始值可选
 var name by mv.strM("tom", "初始值")
}
//1. 获取单例
val helper = MMKVHelper.getInstance(prefs)
//2. 使用赋值将值存入
helper.name = "Tom"
//3. 直接使用即读取值,如果没有值写入,读取出来的会是默认值。
log.d(TAG, helper.name)

SharedPreference 委托工具

//注意,PrefsHelper 是单例。
class PrefsHelper private constructor(val prefs: SharedPreferences) {
 var isFinish by prefs.boolean("isFinish")
 var name by prefs.string("name")
 var age by prefs.int("age")
 //***其余无关代码省略
}
//1. 获取单例
val helper = PrefsHelper.getInstance(prefs)
//2. 使用赋值将值存入
helper.name = "Tom"
//3. 直接使用即读取值,如果没有值写入,读取出来的会是默认值。
log.d(TAG, helper.name)

DataStore 委托工具

//1. 需要有一个协程作用域
val scope = CoroutineScope(Dispatchers.IO)
//2. 你可以将属性委托给datastore,变量名就是key的名称
var username by dataStore.getting(11, scope)
//3. 对数据读写就可以存储到datastore
MaterialTheme {
 //可以在compose中观察数据变化
 val va = dataStore.asDataFlow<Int>("username").collectAsState(initial = 11)
 Column {
 Button(onClick = {
 val randoms = Random.nextInt(0, 11)
 //赋值就会将数据写入datastore
 username = randoms
 //访问变量就可以得到刚刚写入的数据
 println(username)
 }) {
 Text("Random")
 }
 Text("value:${va.value}")
 }
}

ui

ui的使用

单纯的ui组件

@Composable
fun SettingsScreen() {
 Column(
 modifier = Modifier
 .verticalScroll(rememberScrollState()),
 verticalArrangement = Arrangement.spacedBy(4.dp)
 ) {
 Preferences.SetTheme(
 iconStyle = PreferenceIconStyle(
 paddingValues = PaddingValues(8.dp),
 tint = MaterialTheme.colorScheme.onPrimary,
 backgroundColor = MaterialTheme.colorScheme.primary,
 )
 ) {
 PreferenceItemTest()
 PreferenceSubTitle(
 modifier = Modifier.padding(top = 8.dp),
 title = "其他"
 )
 var progress by remember {
 mutableStateOf(0f)
 }
 PreferenceSlider(
 value = progress,
 desc = "滑动条描述",
 onValueChanged = { progress = it })
 SwitchTest()
 PreferenceSubTitle(title = "多选框", modifier = Modifier)
 CheckBoxTest()
 PreferenceSubTitle(title = "单选框", modifier = Modifier)
 RadioTest()
 PreferenceSubTitle(title = "折叠", modifier = Modifier)
 var expand by remember { mutableStateOf(false) }
 PreferenceCollapseItem(
 expand = expand,
 title = "附加内容",
 stateChanged = { expand = !expand })
 {
 Preferences.SetTheme {
 Column(modifier = Modifier.padding(top = 12.dp, start = 12.dp, end = 12.dp)) {
 PreferenceItemTest()
 }
 }
 }
 }
 }
}

自动存储读取偏好值,带节点依赖的ui组件

@Composable
fun NewComponents2(ctx: Context) {
 //1. 使用dataStore存储偏好值
 val holder = remember {
 DataStorePreferenceHolder.instance(
 dataStoreName = "test",
 ctx = AppCtx.instance
 )
 }
 //2. 使用mmkv存储偏好值
// val holder = remember {
// MMKVPreferenceHolder.instance(MMKV.defaultMMKV())
// }
 //3. 使用sharedprefrence存储偏好值
// val holder = remember {
// OldPreferenceHolder.instance(
// AppCtx.instance.getSharedPreferences(
// "ddd",
// Context.MODE_PRIVATE
// )
// )
// }
 val customNodeName = "customNode"
 //创建一个自定义节点
 val node = holder.registerDependence(customNodeName, true)
 val scope = rememberCoroutineScope()
 Column(
 modifier = Modifier
 .verticalScroll(rememberScrollState()),
 verticalArrangement = Arrangement.spacedBy(4.dp)
 ) {
 Preferences.SetTheme(
 holder = holder,
 iconStyle = PreferenceIconStyle(
 paddingValues = PaddingValues(8.dp),
 tint = MaterialTheme.colorScheme.onPrimary,
 backgroundColor = MaterialTheme.colorScheme.primary,
 )
 ) {
 Column {
 PreferenceSwitch(
 defaultValue = false,
 title = "使用新特性",
 desc = "实验功能,可能不稳定",
 dependenceKey = DependenceNode.rootName,
 keyName = "s1"
 ) { state ->
 //这里获取并修改了当前的enable状态,
 //依赖这个节点的会改变显示状态,
 //如果当前没有指定依赖,自身也会受到影响
 scope.launch {
 holder.getDependence("s1")?.setEnabled(state)
 }
 }
 PreferenceItem(
 dependenceKey = "s1",
 title = "关联组件",
 icon = Icons.Outlined.AccountCircle
 )
 PreferenceSwitchWithContainer(
 title = "调整您的设置信息",
 desc = "账户、翻译、帮助信息等",
 defaultValue = false,
 keyName = "b2",
 dependenceKey = DependenceNode.rootName,
 icon = Icons.Outlined.AccountCircle,
 ) {
 scope.launch {
 node.setEnabled(it)
 }
 }
 PreferenceItem(
 modifier = Modifier,
 title = "账户",
 icon = Icons.Outlined.AccountCircle,
 dependenceKey = customNodeName,
 desc = "本地、谷歌",
 )
 var expand by remember { mutableStateOf(false) }
 PreferenceCollapseItem(
 expand = expand,
 title = "附加内容",
 dependenceKey = customNodeName,
 stateChanged = { expand = !expand })
 {
 Column(modifier = Modifier.padding(horizontal = 16.dp)) {
 PreferenceItem(
 title = "动画",
 icon = Icons.Outlined.TouchApp,
 desc = "动画反馈、触感反馈",
 )
 PreferenceItem(
 title = "语言",
 desc = "中文(zh)",
 icon = Icons.Outlined.Language,
 )
 }
 }
 PreferencesCautionCard(
 title = "调整您的设置信息",
 desc = "账户、翻译、帮助信息等",
 dependenceKey = customNodeName,
 icon = Icons.Outlined.AccountCircle,
 )
 }
 }
 }
}

可用的组件:

依赖和置灰

PreferencesScope(holder = holder) {
 val node = holder.registerDependence("customNode", true)// 1
//PreferenceItem可组合函数
 PreferenceSwitchWithDivider(
 keyName = "bol3",
 title = "title",
 dependenceKey = "customNode", // 2
 description = "description",
 icon = Icons.Filled.CenterFocusWeak
 )
 PreferenceSwitch(
 keyName = "bol2",
 title = "title",
 description = "description",
 icon = Icons.Filled.CenterFocusWeak
 ) {
 node.enableState.value = it //3 修改节点状态
 }
}

Preferences.SetTheme(holder = holder) {
 //switch A
 PreferenceSwitch(
 keyName = "bol",
 title = "title",
 dependenceKey = DependenceNode.rootName,//指定依赖为根结点,这样自身就不会受到影响
 description = "description"
 ) { state ->
 //这里获取并修改了当前的enable状态,
 //依赖这个节点的会改变显示状态,
 //如果当前没有指定依赖,自身也会受到影响
 holder.getDependence("bol")?.let {
 it.enableState.value = state
 }
 }
 //switch B
 PreferenceSwitch(
 keyName = "bol2",
 title = "title",
 dependenceKey = "bol", //依赖key为bol的状态
 description = "description",
 icon = Icons.Filled.CenterFocusWeak
 )
}

直接使用偏好值读写工具

prefStoreHolder.getSingleDataEditor()方式

//1,获取读写工具
//MMKV
 val prefStoreHolder = MMKVPreferenceHolder.instance(MMKV.defaultMMKV())
//SharedPreference
val prefStoreHolder = OldPreferenceHolder.instance(
 AppCtx.instance.getSharedPreferences("ddd",Context.MODE_PRIVATE)
 )
 
//DataStore
val prefStoreHolder = DataStorePreferenceHolder.instance(
 dataStoreName = "test",
 ctx = AppCtx.instance
 )
//2,获取某个偏好值读写器
val pref =prefStoreHolder.getSingleDataEditor(keyName = keyName, defaultValue = "")
//3,获取偏好值
pref.flow().collect { s ->
	//flow收集到偏好值的变更
}
或者
val currentValue = pref.flow().collectAsState(defaultValue)
//4, 写入偏好值
pref.write("")