[移动开发]kotlin-属性委托

一直没太明白 属性委托的含义及作用，但是现在又明白了。

一句话总结：属性委托 = 把成员变量的 set/get函数封装到其他地方 + 使用的时候直接调用这个封装好的东西。

一步一步去了解：

• kt中属性不是单纯的成员变量。
  比如下面这个代码中的 personName 就不算是。

  class Person {
  	var personName = "Tom"
  }
  

  完整的属性是包含 set + get 方法的。 【属性 = 成员变量 + 该变量的get方法 + 该变量的set方法】
  上面只有一行var personName = "Tom"实际上编译后会自动生成默认的get+set方法。
• 每次调用 person.personName 的时候，如果是当作左值使用，其实调用的是 person.personName#set(value)方法；如果是当作右值使用，其实调用的是 person.personName#get()方法;
  如果我们要控制 get set的默认逻辑就要去重写对应的方法。

  class Person {
  	var personName = "Tom"
  	// 这是默认的 get/set
  	get() = field
  	set(value) {
  		field = value
  	}
  }
  

  class Person {
  	var personName = "Tom"
  	// 这是重写的 get/set
  	get() = "PersonName $field"
  	set(value) {
  		field = if (value.length > 10) value else field
  	}
  }
  

• 如果我们不想直接在这个类里面去重写成员的 set/get，或者这个逻辑其实是通用的，对其他成员变量也是能重用到的，那么可以通过自定义属性委托去实现。【属性委托 = 把成员变量的 set/get函数封装到其他地方 + 使用的时候直接调用这个封装好的东西】

前面的介绍已经差不多了，下面开始去定义和使用。

下面使用一下内置的一个属性委托的封装：Delegates.vetoable

class Person {
    var personName = "Tom"
        // 这是重写的 get/set
        get() = "PersonName $field"
        set(value) {
            field = if (value.length > 10) value else field
        }
    
    var desc by Delegates.vetoable("person") { property, oldValue, newValue ->
        return@vetoable newValue.length > 5
    }

	override fun toString(): String {
        return "Person[name=$personName, $desc]"
    }
}

fun main() {
    val p = Person()
    println("call01-- $p")
    p.desc = "good"
    println("call02-- $p")
    p.desc = "kotlin developer"
    println("call03-- $p")
}

比如上面定义了一个新的属性desc, 这个属性是 var的，理论上可以任意的改变这个变量的值对吧。下面看一下使用的效果：
调用如下：

call01-- Person[name=PersonName Tom, person]
call02-- Person[name=PersonName Tom, person]
call03-- Person[name=PersonName Tom, kotlin developer]

看起来是不是有点奇怪，在main里面调用p.desc = "good"都没有生效。其实是 return@vetoable newValue.length > 5 里面进行了限制。这个 return的作用就是判断，如果是true了，才会实际去set,否则不会去set。

这个是内置属性委托：Delegates.vetoable(...)的效果。

那么，我们如何去自定义一个委托类呢。

看：

class RangeRegulator(
    initialValue: Int,
    private val minValue: Int,
    private val maxValue: Int
) : ReadWriteProperty<Any?, Int> {

    private var fieldData = initialValue

    override fun getValue(thisRef: Any?, property: KProperty<*>): Int {
        return fieldData.coerceAtMost(maxValue).coerceAtLeast(minValue)
    }

    override fun setValue(thisRef: Any?, property: KProperty<*>, value: Int) {
        if (value in minValue..maxValue) {
            fieldData = value
        }
    }
}

class Duo {
    var count by RangeRegulator(99, 0, 5)
}

fun main() {
    val obj = Duo()
    println("c1==${obj.count}")
    obj.count = 9
    println("c2==${obj.count}")
    obj.count = 1
    println("c3==${obj.count}")
}

输出效果如下：

c1==5
c2==5
c3==1

应该很容易懂，但是为什么是这样呢?

• 这个 ReadWriteProperty 就是用来实现属性委托的，如果是需要重写 set函数，一定要去实现这个接口。
• 里面的实现基本就是模板代码，完全可以参考上面的 RangeRegulator 去实现。
• 如果只要实现 get函数的委托，那么只要实现 ReadOnlyProperty 这个接口即可。