專案應用中通常會對 SharedPreference 再封裝一層，使用 Kotlin 語法糖可以極大簡化這層封裝。本文將使用委託、泛型、過載運算子來達到化簡的目的。
這是 Kotlin 系列的第八篇，系列文章目錄如下：
SharedPreference 在專案中的封裝類通常如下所示：
public final class SPUtils {
//'持有SharedPreferences例項'
private SharedPreferences sp;
//'在建構函式中構建SharedPreferences例項'
private SPUtils(final String spName) {
sp = Utils.getApp().getSharedPreferences(spName, Context.MODE_PRIVATE);
}
//'寫函式'
public void put(@NonNull final String key, final int value, final boolean isCommit) {
if (isCommit) {
sp.edit().putInt(key, value).commit();
} else {
sp.edit().putInt(key, value).apply();
}
}
//'讀函式'
public int getInt(@NonNull final String key, final int defaultValue) {
return sp.getInt(key, defaultValue);
}
...
}
複製程式碼SharedPreferences 共支援 6 種資料型別的讀寫，加起來一共 12 個讀寫函式。
類委託
用 Kotlin類委託語法，可以將 SharedPreferences 工具類宣告如下：
//'將類委託給 SharedPreferences 例項'
class Preference(private val sp: SharedPreferences) : SharedPreferences by sp {
...
}
複製程式碼Preference繼承介面SharedPreferences，這樣做的目的是對業務層保留SharedPreferences原有介面。並把構建SharedPreferences例項移出工具類，交給業務層處理。
class Class2(private val c1: Class1) : Class1 by c1這個語法叫類委託，它的意思是：Class2是Class1的子型別並且Class2將所有介面的實現委託為c1例項，這樣 Kotlin 會自動生成所有介面並將其實現委託給超型別的例項。這就是為啥Preference並未實現介面中的任何一個函式，編譯器卻不報錯，開啟 Kotlin 位元組碼驗證一下：
public final class Preference implements SharedPreferences {
private final SharedPreferences sp;
public Preference(@NotNull SharedPreferences sp) {
Intrinsics.checkParameterIsNotNull(sp, ‘sp’);
super();
//'依賴注入'
this.sp = sp;
}
public boolean getBoolean(String key, boolean defValue) {
//'將實現委託為sp例項'
return this.sp.getBoolean(key, defValue);
}
public float getFloat(String key, float defValue) {
//'將實現委託為sp例項'
return this.sp.getFloat(key, defValue);
}
...
}
複製程式碼Kotlin 自定將所有介面的實現委託給了 SharedPreferences 例項。by關鍵詞使我們可以省去這些模版程式碼。
過載運算子
為了簡化讀寫函式的呼叫，重新定義了兩個函式：
class Preference(private val sp: SharedPreferences) : SharedPreferences by sp {
//'寫函式'
operator fun set(key: String, isCommit: Boolean = false , value: Int) {
val edit = sp.edit()
edit.putInt(key,value)
if (isCommit) {
edit.commit()
} else {
edit.apply()
}
}
//'讀函式'
operator fun get(key: String, default: Int): Int = sp.getInt(key,default)
}
複製程式碼這兩個函式都以保留詞operator開頭，它表示過載運算子，即重新定義運算子的語義。Kotlin 中預定義了一些函式名和運算子的對應關係，稱為約定：
| 函式名 | 運算子 |
|---|---|
| plus | a + b |
| times | a * b |
| div | a / b |
| mod | a % b |
| minus | a - b |
| unaryPlus | + a |
| unaryMinus | - a |
| not | ! a |
| inc | ++a , a++ |
| dec | --a, a-- |
| get | a[b] |
| set | a = b |
| rangeTo | .. |
這次用到的是約定是get和set，宣告他們時可以定義任意長度的引數，分別以 2 引數和 3 引數為例：
| java | kotlin |
|---|---|
| p.get( key, default ) | p[ key, default ] |
| p.set( key, true, value ) | p[ key, true ] = value |
其中set函式中最後一個引數是=右邊的值，其餘引數是=左邊的值。
然後就可以像這樣簡潔地讀寫了：
class Activity1 : AppCompatActivity() {
private lateinit var pre: Preference
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
//'構建Preferences例項'
pre = Preference(getSharedPreferences(”test“, Context.MODE_PRIVATE))
//'寫'
pre[”a“] = 1
//'讀'
pre[”a“,0]
}
}
複製程式碼但只定義了 Int 值的讀寫，難道其餘的型別都要新起一對讀寫函式？
泛型
泛型是型別的型別，使用泛型就可以讓讀寫函式與具體型別解耦：
class Preference(private val sp: SharedPreferences) : SharedPreferences by sp {
//'將寫函式的資料型別抽象為T'
operator fun <T> set(key: String, isCommit: Boolean = false , value: T) {
with(sp.edit()) {
//'將泛型具體化，並委託為sp例項'
when (value) {
is Long -> putLong(key, value)
is Int -> putInt(key, value)
is Boolean -> putBoolean(key, value)
is Float -> putFloat(key, value)
is String -> putString(key, value)
is Set<*> -> (value as? Set<String>)?.let { putStringSet(key, it) }
else -> throw IllegalArgumentException(”unsupported type of value“)
}
if (isCommit) {
commit()
} else {
apply()
}
}
}
//'將讀函式的資料型別抽象為T'
operator fun <T> get(key: String, default: T): T = with(sp) {
//'將泛型具體化，並委託為sp例項'
when (default) {
is Long -> getLong(key, default)
is Int -> getInt(key, default)
is Boolean -> getBoolean(key, default)
is Float -> getFloat(key, default)
is String -> getString(key, default)
is Set<*> -> getStringSet(key, mutableSetOf())
else -> throw IllegalArgumentException(”unsupported type of value“)
} as T
}
}
複製程式碼其中的with、as、when、is的詳細解釋可以翻閱該系列前面的文章。
然後就可以像這樣無視型別地使用讀寫函式了：
class DelegateActivity : AppCompatActivity() {
private lateinit var pre: Preference
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
pre = Preference(getSharedPreferences(”test“, Context.MODE_PRIVATE))
//'寫int'
pre[”a“] = 1
//'使用commit方式寫String'
pre[”b“,true] = ”2“
//'寫Set<String>'
pre[”c“] = mutableSetOf(”cc“,“dd”)
//'讀String'
pre[”b“]
}
}
複製程式碼