Kotlin 代理属性-一一网

在我们开发中，有一些常见的属性，虽然我们可以在每次需要的时候手动实现它们。但是如果将它们实现一次并添加到官方库中会更好。例子包括：

惰性属性：仅在第一次访问时计算值
Observable 属性：观察者会收到此属性更改的通知

为了涵盖这些情况，Kotlin 支持委托属性。

class Example {
    var p: String by Delegate()
}
复制代码

语法

val/var <property name>: <Type> by <expression>
复制代码

后面的表达式 by 是一个委托，因为对应于属性的 get()（和 set()）会被委托给它的 getValue() 和 setValue() 方法。属性委托不必实现任何接口，但它们必须提供一个 getValue() 函数（和 setValue()— 用于vars ）。

例如

class Delegate {
    operator fun getValue(thisRef: Any?, property: KProperty<*>): String {
        return "$thisRef, thank you for delegating '${property.name}' to me!"
    }

    operator fun setValue(thisRef: Any?, property: KProperty<*>, value: String) {
        println("$value has been assigned to '${property.name}' in $thisRef.")
    }
}
复制代码

当您从 p 该委托读取的实例时 Delegate，将 getValue() 调用 from 函数 Delegate，因此它的第一个参数是您读取的对象 p，第二个参数包含对 p 自身的描述（例如，您可以使用它的名称）。

val e = Example()
println(e.p)
复制代码

打印结果：

Example@33a17727, thank you for delegating ‘p’ to me!
复制代码

同样，当您分配给 p 时，setValue() 将调用该函数。前两个参数是相同的，第三个保存被分配的值：

e.p = "NEW"
复制代码

打印结果：

NEW has been assigned to ‘p’ in Example@33a17727.
复制代码

标准库中的代理

懒惰属性

lazy() 是一个函数，它接受一个 lambda 并返回一个实例，Lazy<T> 该实例可以作为实现惰性属性的委托：第一次调用 get() 执行传递给的 lambdalazy() 并记住结果，随后的调用 get() 只返回记住的结果。

val lazyValue: String by lazy {
    println("computed!")
    "Hello"
}

fun main() {
    println(lazyValue)
    println(lazyValue)
}
复制代码

默认情况下，惰性属性的评估是同步的：该值仅在一个线程中计算，所有线程将看到相同的值。如果不需要同步初始化委托，以便多个线程可以同时执行，则 LazyThreadSafetyMode.PUBLICATION 作为参数传递给 lazy() 函数。

如果您确定初始化将始终发生在与您使用该属性的线程相同的线程上，则可以使用 LazyThreadSafetyMode.NONE：它不会产生任何线程安全保证和相关开销。

可观察属性

Delegates.observable() 接受两个参数：初始值和修改的闭包。
每次分配给属性时都会调用闭包（在执行分配之后）。它具有三个参数：被分配的属性、旧值和新值：

class User {
    var name: String by Delegates.observable("<no name>") {
        prop, old, new ->
        println("$old -> $new")
    }
}

fun main() {
    val user = User()
    user.name = "first"
    user.name = "second"
}
复制代码

如果您想拦截分配并否决它们，请使用 vetoable() 代替 observable()。

委托给另一个属性

一个属性可以把他的 setter() 和 getter() 代理给另一个属性。这种代理可以用于 top-level 和 class 属性（成员或者扩展）。这种代理属性可以是：

一个 top-level 属性
同一个类中的成员属性或者扩展属性
不同类中的成员属性或者扩展属性

像这种把一个属性委托给别一个属性的情况，要用 ::proper 的语法

var topLevelInt: Int = 0
class ClassWithDelegate(val anotherClassInt: Int)

class MyClass(var memberInt: Int, val anotherClassInstance: ClassWithDelegate) {
    var delegatedToMember: Int by this::memberInt
    var delegatedToTopLevel: Int by ::topLevelInt

    val delegatedToAnotherClass: Int by anotherClassInstance::anotherClassInt
}
var MyClass.extDelegated: Int by ::topLevelInt
复制代码

这个其实是很有用的。举个例子，如果我们想以向后兼容的方式重命名属性时：引入一个新的属性，用注释对旧属性进行 @Deprecated 注释，然后委托其实现。

class MyClass {
   var newName: Int = 0
   @Deprecated("Use 'newName' instead", ReplaceWith("newName"))
   var oldName: Int by this::newName
}
fun main() {
   val myClass = MyClass()
   // Notification: 'oldName: Int' is deprecated.
   // Use 'newName' instead
   myClass.oldName = 42
   println(myClass.newName) // 42
}
复制代码

上述两个例子是官方文档（1.5.10）提供的用法，老版本的 kotlin 是不支持的

属性代理

对于只读属性 val，委托应提供 getValue() 具有以下参数的运算符函数：

thisRef 必须是属性所有者的相同或超类型（对于扩展属性，它应该是被扩展的类型）。

property 必须是类型 KProperty<*> 或其超类型。

getValue() 必须返回与属性（或其子类型）相同的类型。

class Owner {
    val valResource: Resource by ResourceDelegate()
}

class ResourceDelegate {
    operator fun getValue(thisRef: Owner, property: KProperty<*>): Resource {
        return Resource()
    }
}
复制代码

对于可变属性 var，委托必须额外提供 setValue() 具有以下参数的运算符函数：

thisRef 必须是属性所有者的相同或超类型（对于扩展属性，它应该是被扩展的类型）。

property 必须是类型 KProperty<*> 或其超类型。

value 必须与属性（或其超类型）具有相同的类型。

getValue()/setValue() 函数可以作为委托类的成员函数或扩展函数提供。当您需要将属性委托给最初不提供这些功能的对象时，后者很方便。这两个函数都需要用 operator 关键字标记。

您可以将委托创建为匿名对象，而无需使用接口 ReadOnlyProperty 和 ReadWritePropertyKotlin 标准库创建新类。它们提供了所需的方法：getValue() 在 ReadOnlyProperty 中声明，ReadWriteProperty 扩展它并添加 setValue()。因此，您可以在需要传递 ReadOnlyProperty 的时候传递 ReadWriteProperty。

fun resourceDelegate(): ReadWriteProperty<Any?, Int> =
    object : ReadWriteProperty<Any?, Int> {
        var curValue = 0
        override fun getValue(thisRef: Any?, property: KProperty<*>): Int = curValue
        override fun setValue(thisRef: Any?, property: KProperty<*>, value: Int) {
            curValue = value
        }
    }

val readOnly: Int by resourceDelegate()  // ReadWriteProperty as val
var readWrite: Int by resourceDelegate()
复制代码

转换规则

Kotlin 编译器为每个委托属性生成一个辅助属性并委托给它。例如，为属性生成 prop 隐藏属性prop$delegate，访问器的代码简单地委托给这个附加属性：

class C {
    var prop: Type by MyDelegate()
}

// this code is generated by the compiler instead:
class C {
    private val prop$delegate = MyDelegate()
    var prop: Type
        get() = prop$delegate.getValue(this, this::prop)
        set(value: Type) = prop$delegate.setValue(this, this::prop, value)
}
复制代码