ต่อไปนี้เป็นวิธีการใช้Kotlin Delegated Propertiesที่ฉันเลือกจากที่นี่แต่ขยายและอนุญาตให้มีกลไกอย่างง่ายสำหรับการตั้งค่าคุณสมบัติ SharedPreference
สำหรับString, Int, Long, FloatหรือBooleanจะใช้ SharePreference ทะเยอทะยานมาตรฐาน (s) และหมา (s) อย่างไรก็ตามสำหรับคลาสข้อมูลอื่น ๆ ทั้งหมดนั้นจะใช้ GSON เพื่อทำให้เป็นอนุกรมStringสำหรับ setter จากนั้น deserializes วัตถุข้อมูลสำหรับทะเยอทะยาน
เช่นเดียวกับโซลูชันอื่น ๆ สิ่งนี้ต้องการเพิ่ม GSON เป็นการอ้างอิงในไฟล์ gradle ของคุณ:
implementation 'com.google.code.gson:gson:2.8.6'
นี่คือตัวอย่างของคลาสข้อมูลอย่างง่ายที่เราต้องการให้สามารถบันทึกและเก็บไว้ใน SharedPreferences:
data class User(val first: String, val last: String)
นี่คือคลาสหนึ่งที่ใช้ตัวแทนคุณสมบัติ:
object UserPreferenceProperty : PreferenceProperty<User>(
key = "USER_OBJECT",
defaultValue = User(first = "Jane", last = "Doe"),
clazz = User::class.java)
object NullableUserPreferenceProperty : NullablePreferenceProperty<User?, User>(
key = "NULLABLE_USER_OBJECT",
defaultValue = null,
clazz = User::class.java)
object FirstTimeUser : PreferenceProperty<Boolean>(
key = "FIRST_TIME_USER",
defaultValue = false,
clazz = Boolean::class.java
)
sealed class PreferenceProperty<T : Any>(key: String,
defaultValue: T,
clazz: Class<T>) : NullablePreferenceProperty<T, T>(key, defaultValue, clazz)
@Suppress("UNCHECKED_CAST")
sealed class NullablePreferenceProperty<T : Any?, U : Any>(private val key: String,
private val defaultValue: T,
private val clazz: Class<U>) : ReadWriteProperty<Any, T> {
override fun getValue(thisRef: Any, property: KProperty<*>): T = HandstandApplication.appContext().getPreferences()
.run {
when {
clazz.isAssignableFrom(String::class.java) -> getString(key, defaultValue as String?) as T
clazz.isAssignableFrom(Int::class.java) -> getInt(key, defaultValue as Int) as T
clazz.isAssignableFrom(Long::class.java) -> getLong(key, defaultValue as Long) as T
clazz.isAssignableFrom(Float::class.java) -> getFloat(key, defaultValue as Float) as T
clazz.isAssignableFrom(Boolean::class.java) -> getBoolean(key, defaultValue as Boolean) as T
else -> getObject(key, defaultValue, clazz)
}
}
override fun setValue(thisRef: Any, property: KProperty<*>, value: T) = HandstandApplication.appContext().getPreferences()
.edit()
.apply {
when {
clazz.isAssignableFrom(String::class.java) -> putString(key, value as String?) as T
clazz.isAssignableFrom(Int::class.java) -> putInt(key, value as Int) as T
clazz.isAssignableFrom(Long::class.java) -> putLong(key, value as Long) as T
clazz.isAssignableFrom(Float::class.java) -> putFloat(key, value as Float) as T
clazz.isAssignableFrom(Boolean::class.java) -> putBoolean(key, value as Boolean) as T
else -> putObject(key, value)
}
}
.apply()
private fun Context.getPreferences(): SharedPreferences = getSharedPreferences(APP_PREF_NAME, Context.MODE_PRIVATE)
private fun <T, U> SharedPreferences.getObject(key: String, defValue: T, clazz: Class<U>): T =
Gson().fromJson(getString(key, null), clazz) as T ?: defValue
private fun <T> SharedPreferences.Editor.putObject(key: String, value: T) = putString(key, Gson().toJson(value))
companion object {
private const val APP_PREF_NAME = "APP_PREF"
}
}
หมายเหตุ: sealed classคุณไม่ควรจะต้องมีอะไรปรับปรุงในการ คุณสมบัติที่ได้รับการแต่งตั้งเป็นวัตถุ / Singletons UserPreferenceProperty, NullableUserPreferencePropertyและFirstTimeUserและ
ในการตั้งค่าวัตถุข้อมูลใหม่สำหรับการบันทึก / รับจาก SharedPreferences ตอนนี้มันง่ายเหมือนการเพิ่มสี่บรรทัด:
object NewPreferenceProperty : PreferenceProperty<String>(
key = "NEW_PROPERTY",
defaultValue = "",
clazz = String::class.java)
สุดท้ายคุณสามารถอ่าน / เขียนค่าไปยัง SharedPreferences โดยใช้byคำหลัก:
private var user: User by UserPreferenceProperty
private var nullableUser: User? by NullableUserPreferenceProperty
private var isFirstTimeUser: Boolean by
Log.d("TAG", user) // outputs the `defaultValue` for User the first time
user = User(first = "John", last = "Doe") // saves this User to the Shared Preferences
Log.d("TAG", user) // outputs the newly retrieved User (John Doe) from Shared Preferences