Kotlin 知识梳理(9) 委托属性

1、本文概要

本文是对<<Kotlin in Action>>的学习笔记，若是须要运行相应的代码能够访问在线环境 try.kotlinlang.org，这部分的思惟导图为：

2、委托属性的基本操做

2.1 委托属性的基本语法

class Foo {
    var p : Type by Delegate() } 复制代码

类型为Type的属性p将它的访问器逻辑委托给了另外一个Delegate实例，经过关键字by对其后的 表达式求值 来获取这个对象，关键字by能够用于任何 符合属性委托约定规则的对象。

按照约定，Delegate类必须具备getValue和setValue方法，它们能够是成员函数，也能够是扩展函数，Delegate的简单实现以下：

class Delegate {
    operator fun getValue(...) { ... }
    operator fun setValue(..., value : Type) { ... }
}
复制代码

使用方法以下：

val foo = Foo()
val oldValue = foo.p
foo.p = newValue
复制代码

当咱们将foo.p做为普通属性使用时，实际上将调用Delegate类型的辅助属性的方法。为了研究这种机制如何在实践中使用，咱们首先看一个委托属性展现威力的例子：库对惰性初始化的支持。

2.2 使用委托属性：惰性初始化和 "by lazy()"

惰性初始化是一种常见的模式，直到 在第一次访问该属性 的时候，才根据须要建立对象的一部分。

2.2.1 使用支持属性来实现惰性初始化

使用这种技术来实现惰性初始化时，须要两个值，一个是对内部可见的可空_emails变量，另外一个是提供对属性的读取访问的email变量，它是非空的，在email的get()函数中首先判断_emails变量是否为空，若是为空那么就先初始化它，不然直接返回。

2.2.2 使用委托属性来实现惰性初始化

class Person(val name : String) {
    val emails by lazy { loadEmails(this) }
}
复制代码

这里可使用标准库函数lazy返回的委托，lazy函数返回一个对象，该对象具备一个名为getValue且签名正确的方法，所以能够把它与by关键字一块儿使用来建立一个委托属性。lazy的参数是一个lambda，能够调用它来初始化这个值，默认状况下，lazy函数是线程安全的。

2.3 实现委托属性

2.3.1 常规实现方式

要了解委托属性的实现方式，让咱们来看另外一个例子：当一个对象的属性更改时通知监听器。Java具备用于此类通知的标准机制：PropertyChangeSupport和PropertyChangeEvent。PropertyChangeSupport类维护了一个监听器列表，并向它们发送PropertyChangeEvent事件，要使用它，你一般须要把PropertyChangeSupport的一个实例存储为bean类的一个字段，并将属性更改的处理委托给它。

为了不在每一个类中去添加这个字段，你须要建立一个小的工具类，用来存储PropertyChangeSupport的实例并监听属性更改，以后，你的类会继承这个工具类，以访问changeSupport。

open class ValueChangeAware {   
    protected val changeSupport = PropertyChangeSupport(this)
    //添加监听者。
    fun addListener(listener : PropertyChangeListener) {
        changeSupport.addPropertyChangeListener(listener)
    }
    //移除监听者。
    fun removeListener(listener : PropertyChangeListener) {
        changeSupport.removePropertyChangeListener(listener)
    }
}

//辅助类，若是经过该辅助类改变了属性，那么将会通知监听者。
class ObservableValue (
    val valueName : String, var valueValue : Int, 
    val changeSupport : PropertyChangeSupport
) {
    fun getValue() : Int = valueValue
    fun setValue(newValue : Int) {
        val oldValue = valueValue
        valueValue = newValue
        //通知监听者。
        changeSupport.firePropertyChange(valueName, oldValue, newValue)
    }
}

class Person(val name : String, age : Int) : ValueChangeAware() {
    // _age 为辅助类的一个实例。
    val _age = ObservableValue("age", age, changeSupport)
    //经过辅助类进行读写操做。
    var age : Int
    	get() = _age.getValue()
    	set(value) { _age.setValue(value) }
}
复制代码

下面是实际应用的代码：

fun main(args: Array<String>) {
	val person = Person("zemao", 20)
    person.addListener(
        //监听者打印出改变的属性名、原属性值和新的属性值。
    	PropertyChangeListener { event ->                              
        	println("${event.propertyName} " + 
                    "changed from ${event.oldValue} to ${event.newValue}" )
        }
    )
    person.age = 18
}
复制代码

运行结果为：

>> age changed from 20 to 18
复制代码

2.3.2 使用 ObservableValue 做为属性委托

在上面的代码中，若是Person类中包含了多个与age相似的属性，那么就须要建立多个_age的实例，并把getter和setter委托给它，Kotlin的委托属性可让你摆脱这些样板代码，首先，咱们须要重写ObservableValue代码，让它符合属性委托的约定。

class ObservableValue (
	var valueValue : Int, 
    val changeSupport : PropertyChangeSupport
) {
    //按照约定的须要，用 operator 来标记，并添加了 KProperty。
    operator fun getValue(p : Person, prop : KProperty<*>) : Int = valueValue
    operator fun setValue(p : Person, prop : KProperty<*>, newValue : Int) {
        val oldValue = valueValue
        valueValue = newValue
        //通知监听者。
        changeSupport.firePropertyChange(prop.name, oldValue, newValue)
    }
}
复制代码

和2.3.1相比，咱们作了如下几点修改：

• 按照约定的须要，getValue和setValue函数被标记了operator。
• 这些函数加了两个参数：一个用于接收属性的实例，用来设置和读取属性，另外一个用于表示属性自己，这个属性类型为KProperty，你可使用KProperty.name的方式来访问该属性的名称。

下面，咱们再修改Person类，将age属性委托给ObservableValue类：

class Person(val name : String, age : Int) : ValueChangeAware() {
    var age : Int by ObservableValue(age, changeSupport)
}
复制代码

运行结果和2.3.1相同。

2.3.3 使用 Delegates.observable 来实现属性修改的通知

在Kotlin标准库中，已经包含了相似于ObservableValue的类，所以咱们不用手动去实现可观察的属性逻辑，下面咱们重写Person类：

class Person(
    val name: String, age: Int
) : ValueChangeAware() {

    private val observer = {
        prop: KProperty<*>, oldValue: Int, newValue: Int ->
        changeSupport.firePropertyChange(prop.name, oldValue, newValue)
    }

    var age: Int by Delegates.observable(age, observer)
   
}
复制代码

运行结果和以上两小结相同。

2.4 委托属性的变换规则

让咱们来总结一下委托属性是怎么工做的，假设你已经有了一个具备委托属性的类：

class Foo {
    var p : Type by Delegate() } 复制代码

Delegate实例将会被保存到一个隐藏的属性中，它被称为<delegate>，编译器也将用一个KProperty类型的对象来表示这个属性，它被称为<property>，编译器生成的的代码以下：

class Foo {
    private val <delegate> = Delegate()

    var prop : Type {
        get() = <delegate>.getValue(this, <property>)
        set(value : Type) = <delegate>.setValue(this, <property>, value)
    }
}
复制代码

所以，在每一个属性访问器中，编译器都会生成对应的getValue和setValue方法。

2.5 在 map 中保存属性的值

委托属性发挥做用的另外一种常见用法是 用在动态定义的属性集的对象中，这样的对象有时被称为 自订对象。例如考虑一个联系人管理系统，能够用来存储有关联系人的任意信息，系统中的每一个人都有一些属性须要特殊处理（例如名字），以及每一个人特有的数量任意的额外属性（例如，最小的孩子的生日）。

实现这种系统的一种方法是将人的全部属性存储在map中，不肯定提供属性，来访问须要特殊处理的信息。

class Person {
    private val _attributes = hashMapOf<String, String>()

    fun setAttribute(attrName: String, value: String) {
        _attributes[attrName] = value
    }
    //把 map 做为委托属性。
    val name: String by _attributes
}
复制代码

使用方式：

fun main(args: Array<String>) {
    val p = Person()
    val data = mapOf("name" to "Dmitry", "company" to "JetBrains")
    for ((attrName, value) in data)
       p.setAttribute(attrName, value)
    println(p.name)
}
复制代码

由于标准库已经在标准map和MutableMap接口上定义了getValue和setValue扩展函数，因此能够在这里直接调用。

---

更多文章，欢迎访问个人 Android 知识梳理系列：

• Android 知识梳理目录：www.jianshu.com/p/fd82d1899…
• 我的主页：lizejun.cn
• 我的知识总结目录：lizejun.cn/categories/