委托模式是软件设计模式中的一项根本技巧。在委托模式中,有两个对象参加解决同一个申请,承受申请的对象将申请委托给另一个对象来解决。

Kotlin 间接反对委托模式,更加优雅,简洁。Kotlin 通过关键字 by 实现委托。

类委托

类的委托即一个类中定义的办法理论是调用另一个类的对象的办法来实现的。

以下实例中派生类 Derived 继承了接口 Base 所有办法,并且委托一个传入的 Base 类的对象来执行这些办法。

// 创立接口interface Base {       fun print()}// 实现此接口的被委托的类class BaseImpl(val x: Int) : Base {    override fun print() { print(x) }}// 通过关键字 by 建设委托类class Derived(b: Base) : Base by bfun main(args: Array<String>) {    val b = BaseImpl(10)    Derived(b).print() // 输入 10}

在 Derived 申明中,by 子句示意,将 b 保留在 Derived 的对象实例外部,而且编译器将会生成继承自 Base 接口的所有办法, 并将调用转发给 b。

属性委托

属性委托指的是一个类的某个属性值不是在类中间接进行定义,而是将其托付给一个代理类,从而实现对该类的属性对立治理。

属性委托语法格局:

val/var <属性名>: <类型> by <表达式>
  • var/val:属性类型(可变/只读)
  • 属性名:属性名称
  • 类型:属性的数据类型
  • 表达式:委托代理类
    by 关键字之后的表达式就是委托, 属性的 get() 办法(以及set() 办法)将被委托给这个对象的 getValue() 和 setValue() 办法。属性委托不用实现任何接口, 但必须提供 getValue() 函数(对于 var属性,还须要 setValue() 函数)。

定义一个被委托的类

该类须要蕴含 getValue() 办法和 setValue() 办法,且参数 thisRef 为进行委托的类的对象,prop 为进行委托的属性的对象。

import kotlin.reflect.KProperty// 定义蕴含属性委托的类class Example {    var p: String by Delegate()}// 委托的类class Delegate {    operator fun getValue(thisRef: Any?, property: KProperty<*>): String {        return "$thisRef, 这里委托了 ${property.name} 属性"    }    operator fun setValue(thisRef: Any?, property: KProperty<*>, value: String) {        println("$thisRef 的 ${property.name} 属性赋值为 $value")    }}fun main(args: Array<String>) {    val e = Example()    println(e.p)     // 拜访该属性,调用 getValue() 函数    e.p = "Runoob"   // 调用 setValue() 函数    println(e.p)}

输入后果为:

Example@433c675d, 这里委托了 p 属性Example@433c675d 的 p 属性赋值为 RunoobExample@433c675d, 这里委托了 p 属性

规范委托

Kotlin 的规范库中曾经内置了很多工厂办法来实现属性的委托。

提早属性 Lazy

lazy() 是一个函数, 承受一个 Lambda 表达式作为参数, 返回一个 Lazy <T> 实例的函数,返回的实例能够作为实现提早属性的委托: 第一次调用 get() 会执行已传递给 lazy() 的 lamda 表达式并记录后果, 后续调用 get() 只是返回记录的后果。

val lazyValue: String by lazy {    println("computed!")     // 第一次调用输入,第二次调用不执行    "Hello"}fun main(args: Array<String>) {    println(lazyValue)   // 第一次执行,执行两次输入表达式    println(lazyValue)   // 第二次执行,只输入返回值}

执行输入后果:

computed!HelloHello

可察看属性 Observable

observable 能够用于实现观察者模式。

Delegates.observable() 函数承受两个参数: 第一个是初始化值, 第二个是属性值变动事件的响应器(handler)。

在属性赋值后会执行事件的响应器(handler),它有三个参数:被赋值的属性、旧值和新值:

import kotlin.properties.Delegatesclass User {    var name: String by Delegates.observable("初始值") {        prop, old, new ->        println("旧值:$old -> 新值:$new")    }}fun main(args: Array<String>) {    val user = User()    user.name = "第一次赋值"    user.name = "第二次赋值"}

执行输入后果:

旧值:初始值 -> 新值:第一次赋值旧值:第一次赋值 -> 新值:第二次赋值

把属性贮存在映射中

一个常见的用例是在一个映射(map)里存储属性的值。 这经常出现在像解析 JSON 或者做其余"动静"事件的利用中。 在这种状况下,你能够应用映射实例本身作为委托来实现委托属性。

class Site(val map: Map<String, Any?>) {    val name: String by map    val url: String  by map}fun main(args: Array<String>) {    // 构造函数承受一个映射参数    val site = Site(mapOf(        "name" to "菜鸟教程",        "url"  to "www.runoob.com"    ))        // 读取映射值    println(site.name)    println(site.url)}

执行输入后果:

菜鸟教程www.runoob.com

如果应用 var 属性,须要把 Map 换成 MutableMap:

class Site(val map: MutableMap<String, Any?>) {    val name: String by map    val url: String by map}fun main(args: Array<String>) {    var map:MutableMap<String, Any?> = mutableMapOf(            "name" to "菜鸟教程",            "url" to "www.runoob.com"    )    val site = Site(map)    println(site.name)    println(site.url)    println("--------------")    map.put("name", "Google")    map.put("url", "www.google.com")    println(site.name)    println(site.url)}

执行输入后果:

菜鸟教程www.runoob.com--------------Googlewww.google.com

Not Null

notNull 实用于那些无奈在初始化阶段就确定属性值的场合。

class Foo {    var notNullBar: String by Delegates.notNull<String>()}foo.notNullBar = "bar"println(foo.notNullBar)

须要留神,如果属性在赋值前就被拜访的话则会抛出异样。

部分委托属性

你能够将局部变量申明为委托属性。 例如,你能够使一个局部变量惰性初始化:

fun example(computeFoo: () -> Foo) {    val memoizedFoo by lazy(computeFoo)    if (someCondition && memoizedFoo.isValid()) {        memoizedFoo.doSomething()    }}

memoizedFoo 变量只会在第一次拜访时计算。 如果 someCondition 失败,那么该变量基本不会计算。

属性委托要求

对于只读属性(也就是说val属性), 它的委托必须提供一个名为getValue()的函数。该函数承受以下参数:

  • thisRef —— 必须与属性所有者类型(对于扩大属性——指被扩大的类型)雷同或者是它的超类型
  • property —— 必须是类型 KProperty<*> 或其超类型
    这个函数必须返回与属性雷同的类型(或其子类型)。

对于一个值可变(mutable)属性(也就是说,var 属性),除 getValue()函数之外,它的委托还必须 另外再提供一个名为setValue()的函数, 这个函数承受以下参数:

  • property —— 必须是类型 KProperty<*> 或其超类型
  • new value —— 必须和属性同类型或者是它的超类型。

    翻译规定

    在每个委托属性的实现的背地,Kotlin 编译器都会生成辅助属性并委托给它。 例如,对于属性 prop,生成暗藏属性 prop$delegate,而拜访器的代码只是简略地委托给这个附加属性:

    class C {  var prop: Type by MyDelegate()}// 这段是由编译器生成的相应代码: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)}

    Kotlin 编译器在参数中提供了对于 prop 的所有必要信息:第一个参数 this 援用到外部类 C 的实例而 this::prop 是 KProperty 类型的反射对象,该对象形容 prop 本身。

提供委托

通过定义 provideDelegate 操作符,能够扩大创立属性实现所委托对象的逻辑。 如果 by 右侧所应用的对象将 provideDelegate 定义为成员或扩大函数,那么会调用该函数来 创立属性委托实例。

provideDelegate 的一个可能的应用场景是在创立属性时(而不仅在其 getter 或 setter 中)查看属性一致性。

例如,如果要在绑定之前查看属性名称,能够这样写:

class ResourceLoader<T>(id: ResourceID<T>) {    operator fun provideDelegate(            thisRef: MyUI,            prop: KProperty<*>    ): ReadOnlyProperty<MyUI, T> {        checkProperty(thisRef, prop.name)        // 创立委托    }    private fun checkProperty(thisRef: MyUI, name: String) { …… }}fun <T> bindResource(id: ResourceID<T>): ResourceLoader<T> { …… }class MyUI {    val image by bindResource(ResourceID.image_id)    val text by bindResource(ResourceID.text_id)}

provideDelegate 的参数与 getValue 雷同:

  • thisRef —— 必须与 属性所有者 类型(对于扩大属性——指被扩大的类型)雷同或者是它的超类型
  • property —— 必须是类型 KProperty<*> 或其超类型。
    在创立 MyUI 实例期间,为每个属性调用 provideDelegate 办法,并立刻执行必要的验证。

如果没有这种拦挡属性与其委托之间的绑定的能力,为了实现雷同的性能, 你必须显式传递属性名,这不是很不便:

// 查看属性名称而不应用“provideDelegate”性能class MyUI {    val image by bindResource(ResourceID.image_id, "image")    val text by bindResource(ResourceID.text_id, "text")}fun <T> MyUI.bindResource(        id: ResourceID<T>,        propertyName: String): ReadOnlyProperty<MyUI, T> {   checkProperty(this, propertyName)   // 创立委托}

在生成的代码中,会调用 provideDelegate 办法来初始化辅助的 prop$delegate 属性。 比拟对于属性申明 val prop: Type by MyDelegate() 生成的代码与 下面(当 provideDelegate 办法不存在时)生成的代码:

class C {    var prop: Type by MyDelegate()}// 这段代码是当“provideDelegate”性能可用时// 由编译器生成的代码:class C {    // 调用“provideDelegate”来创立额定的“delegate”属性    private val prop$delegate = MyDelegate().provideDelegate(this, this::prop)    val prop: Type        get() = prop$delegate.getValue(this, this::prop)}

请留神,provideDelegate 办法只影响辅助属性的创立,并不会影响为 getter 或 setter 生成的代码。