Kotlin封装SharedPreferences的操作

涉及知识点

主要涉及kotlin知识点有：伴生对象、类的定义、委托属性和when表达式。

伴生对象

• 使用了companion关键字标记的类内部的对象声明，类似于java中的static修饰的静态成员。
• 伴生对象的成员可通过类名作为限定符来调用。
• 可以省略伴生对象的名称，在这种情况下将使用名称Companion和object 即可。
• 即使伴生对象的成员看起来像其他语言的静态成员，在运行时他们仍然是真实对象的实例成员，例如还可以实现接口。

类的定义

• 使用关键字 class 声明类。
• 类声明由类名、类头（指定其类型参数、主构造函数等）和由大括号包围的类体构成。类头和类体都是可选的； 如果一个类没有类体，可以省略花括号。
• 一个类可以有一个主构造函数和一个或多个次构造函数。主构造函数是类头的一部分：它跟在类名（和可选的类型参数）后。
• 如果主构造函数没有任何注解或者可见性修饰符，可以省略这个constructor关键字。
• 主构造函数不能包含任何的代码。初始化的代码可以放到以init关键字作为前缀的初始化块中。

委托属性

• 在委托模式中，有两个对象参与处理同一个请求，接受请求的对象将请求委托给另一个对象来处理。
• 有些类的属性，每次使用时，我们都需要去实现，而使用委托只实现一次并放入一个库会更好，再次使用时将直接从库中取。
• 语法是： val/var <属性名>: <类型> by <表达式>。在 by 后面的表达式是该 委托， 因为属性对应的 get()（和 set()）会被委托给它的 getValue() 和 setValue() 方法。 属性的委托不必实现任何的接口，但是需要提供一个 getValue() 函数（和 setValue()——对于 var 属性）。

when表达式

• switch支持整数的封装类、字符串和枚举作为判断条件，而when表达式支持switch所支持的，甚至支持函数，强大到不行。
• when表达式 中可以使用in、!in、is、!is关键字。
• when 表达式一般情况下也是必须跟else的，除非你吧所有可能性都已经包含在判断条件内。

相关代码

Preference类

由于SP支持存储多种类型的数据，所以在这里我们定义成了一个带泛型的类。第一个变量prefs使用了懒加载lazy来缓存SharedPreference对象。getValue和setValue函数使用了operator修饰，operator修饰的函数就是属性委托的时候主动调用的。

class Preference<T>(val name: String, private val default: T) {
    private val prefs: SharedPreferences by lazy { App.instance.applicationContext.getSharedPreferences(name, Context.MODE_PRIVATE) }

    operator fun getValue(thisRef: Any?, property: KProperty<*>): T {
        Log.i("info", "调用$this 的getValue()")
        return getSharePreferences(name, default)
    }

    operator fun setValue(thisRef: Any?, property: KProperty<*>, value: T) {
        Log.i("info", "调用$this 的setValue() value参数值为：$value")
        putSharePreferences(name, value)
    }

    @SuppressLint("CommitPrefEdits")
    private fun putSharePreferences(name: String, value: T) = with(prefs.edit()) {
        when (value) {
            is Long -> putLong(name, value)
            is String -> putString(name, value)
            is Int -> putInt(name, value)
            is Boolean -> putBoolean(name, value)
            is Float -> putFloat(name, value)
            else -> throw IllegalArgumentException("This type of data cannot be saved!")
        }.apply()
    }

    @Suppress("UNCHECKED_CAST")
    private fun getSharePreferences(name: String, default: T): T = with(prefs) {
        val res: Any = when (default) {
            is Long -> getLong(name, default)
            is String -> getString(name, default)
            is Int -> getInt(name, default)
            is Boolean -> getBoolean(name, default)
            is Float -> getFloat(name, default)
            else -> throw IllegalArgumentException("This type of data cannot be saved!")
        }
        return res as T
    }
}

类中第一行代码通过调用了Application的实例来获取Context实例。在自定义的Application中，创建了一个伴生对象，用于获取Application实例。

App类

class App : Application() {
    companion object {// 伴生对象
        lateinit var instance: App
            private set
    }

    override fun onCreate() {
        super.onCreate()
        instance = this
    }
}

使用Preference，是需要一行代码。即，private var variable by Preference(“keyName”, “10”)。

测试代码

class MainActivity : AppCompatActivity() {
    // 委托属性，Preference把取值和存值的操作代理给variable，我们对userId的赋值和取值最终是操作的Preference得setValue和getValue函数。
    private var variable by Preference("keyName", "10")//由于已经能够推断出variable的类型是String，所以这里的variable省去了类型。
    //完整写法如下：
    //private var variable: String by Preference("keyName", "10")

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        tvShowResult.text = variable

        btnSave.setOnClickListener {
            variable = "20"
            Log.i("info", "保存成功")
        }

        btnRead.setOnClickListener {
            tvShowResult.text = "new-" + variable
        }
    }
}

首次安装apk，SP文件中没有存值，variable的到的默认值“10”。 执行了variable =
“20”之后，再去获取值时，就变成“20”了，我们看看日志，在取值的时候执行了Preference的getValue()函数。

日志

12-21 18:48:10.303 30573-30573/com.kv.kotlindemo I/info: 调用com.kv.kotlindemo.Preference@18a33be3 的getValue()
12-21 18:48:15.313 30573-30573/com.kv.kotlindemo I/info: 调用com.kv.kotlindemo.Preference@18a33be3 的setValue() value参数值为：20
12-21 18:48:15.313 30573-30573/com.kv.kotlindemo I/info: 保存成功
12-21 18:48:16.373 30573-30573/com.kv.kotlindemo I/info: 调用com.kv.kotlindemo.Preference@18a33be3 的getValue()