SmartKey

基本使用

初始化

//注解非必须,不加注解,会使用默认配置路径,和默认存储实现
@Config("app_config", implCls = JsonSettings::class)
object AppConfig {
 //基本类型存储
 var text: String by smartKey("a")
 //可空基础类型
 var nullableInt: Int? by smartKey(null)
 var number: Int by smartKey(50)
 //数组
 var intArr: Array<Int> by smartKey(emptyArray())
 //实体类
 var userInfo: UserInfo? by smartKey(null, encrypt = true)
 
 //实体数组 [操作即更新] 默认空列表
 var modelList by smartKeyList<ListModel>()
 //实体集 [操作即更新] 默认空集
 var modelSet by smartKeySet<ListModel>(emptySet())
 // [操作即更新]
 var map by smartKeyMap<String, Int>()
}
//数组实体
data class ListModel(val s: String, val a: Int)
//实体类
data class UserInfo(
 var name: String,
 var email: String,
 var age: Int
)

//获取存储值
val value = AppConfig.text
val n = AppConfig.number 
//实时存储
AppConfig.text = "setValue"
AppConfig.number = 0
//存储登录用户数据
val user = UserInfo("new_user", "xx@xx.xx", 0)
AppConfig.userInfo = user
//注意修改实体中的属性无法触发持久化操作
user.name = "hello"
//需要赋值操作触发
AppConfig.userInfo = user
//操作 实时存储 无需显式赋值;需要注意避免循环 add, 可以使用addAll
AppConfig.modelList.add(ListModel("string", 1))
//set map 操作同 List 实时存储

object AppConfig : BaseConfig {
 //...
}

// 清空此配置所有key
AppConfig.clear()
// 直接存储key
AppConfig["key"] = 1 //key, value
AppConfig["text"] = "abc" //key, value
// 加密储存(目前只支持String及实体类型加密)
AppConfig["key", true] = "value"
"key" in AppConfig // is contains key
AppConfig -= "key" // remove key
// 获取可空类型的值
val strNullable: String? = AppConfig["dont_exists_key"]
//提供默认值 以获取不可空值
val s :String = AppConfig["text", "default"] //key, default
// 获取解密后的数据
val value :String? = AppConfig["key", true]
//获取可空数据
val user :UserInfo? = AppConfig["userInfo"]
// or
val user = AppConfig.get<UserInfo?>("userInfo")
//获取加密内容
val user: UserInfo? = AppConfig["userInfo", true]

demo

更多操作

object AppConfig2 : BaseConfig { //指定key 
 //import cn.vove7.smartkey.smartKey
 var text: String by smartKey("defaultValue", key = "your_key")
 var textWithKey: String by smartKey("aaa", key="text_key")
 //安卓项目可通过resId指定keyId
 //import cn.vove7.smartkey.android.smartKey
 var textAndroid: String by smartKey("defaultValue", keyId = R.string.key)
}

print(AppConfig2.textWithKey) //aaa
AppConfig2["text_key"] = "bbb"
print(AppConfig2.textWithKey) //bbb

 //使用encrypt来声明加密存储数据
 var userInfo: UserInfo? by smartKey(null, encrypt = true)

@Config(implCls = FileSettings::class)
class AppConfig1 {
}
@Config(implCls = PropertiesSettings::class)
class AppConfig2 {
}

 var text: String by noCacheKey("defaultValue", key = "your_key")

基本存储实现

自定义持久化实现

//必须存在构造函数(val configName:String)
class MySettingsImpl(val configName:String) : Settings

@Config(implCls = MySettingsImpl::class)
class AppConfig {
}

引入SmartKey

Step 1. Add it in your root build.gradle at the end of repositories:

allprojects {
 repositories {
 //...
 maven { url 'https://jitpack.io' }
 }
}

Step 2. Add the dependency

dependencies {
 implementation "com.github.Vove7.SmartKey:smartkey:$lastest_version"
}

dependencies {
 implementation "com.github.Vove7.SmartKey:smartkey-android:$lastest_version"
}

注意事项

TODO

val dk by synamicKey(0) { 
 SimpleDateFormat("yyyy-MM-dd").format(Date()) + "_today_xxx_count"
}

Thanks