kotlin—observable及其原理

2022-05-20  本文已影响0人  jxiang112

1、observable简介

observable与lazy一样是kotlin标准库中属性委托的实现,它主要用于观察属性值变化。

2、observable语法

observable属于属性委托,所以它也遵循属性委托的语法,其完整语法如下所示:

var propertyName by observable(initialValue: T, onChange: (property: KProperty<*>, oldValue: T, newValue: T) -> Unit)

onChange使用lambda可以将observable的语法简化如下:

var propertyName by observable(initialValue: T, onChange: (property: KProperty<*>, oldValue: T, newValue: T) -> Unit) {
    property, oldValue, newValue -> {
          //onChange方法体....
    }
}

对属性声明时需要observable传递一个初始值initialValue,与一个值变化时的处理函数onChange,onChange的参数分别是:属性值变化的属性对象、属性变化前的值oldValue、属性变化之后的值newValue 。
当对属性的值进行赋值时,会回调onChange方法,我们可以在onChange中已经属性的变化处理不同的业务逻辑。

3、observable原理

根据2中的语法,observable是kotlin标准库中Delegates的内联函数,我们通过observable函数的源码分析器原理:

/**
  * initialValue 属性初始值
  * onChange 属性变化之后的处理函数
   * 返回读写属性类型ReadWriteProperty
*/
public inline fun <T> observable(initialValue: T, crossinline onChange: (property: KProperty<*>, oldValue: T, newValue: T) -> Unit):
            //创建观察属性对象ObservableProperty,并返回
            ReadWriteProperty<Any?, T> =
        object : ObservableProperty<T>(initialValue) {
            override fun afterChange(property: KProperty<*>, oldValue: T, newValue: T) = onChange(property, oldValue, newValue)
        }

observable函数是一个内联函数,函数内部通过object对象表达式方式创建观察属性对象ObservableProperty实例对象,它是ReadWriteProperty实现类,创建ObservableProperty时将属性初始值传递给其构造函数。我们继续查看ObservableProperty的源码:

public abstract class ObservableProperty<V>(initialValue: V) : ReadWriteProperty<Any?, V> {
    //将属性初始值赋值给value
    private var value = initialValue
    //定义属性变化之前的处理函数
    protected open fun beforeChange(property: KProperty<*>, oldValue: V, newValue: V): Boolean = true
    //定义属性变化之后的处理函数
    protected open fun afterChange(property: KProperty<*>, oldValue: V, newValue: V): Unit {}
    
    //实现ReadWriteProperty的getValue方法,用于获取属性的值
    public override fun getValue(thisRef: Any?, property: KProperty<*>): V { 
        //返回属性的值
        return value
    }
    //实现ReadWriteProperty的setValue方法,用于设置属性的值
    public override fun setValue(thisRef: Any?, property: KProperty<*>, value: V) {
        //旧值等于当前属性的值
        val oldValue = this.value
        //调用属性变化之后前的处理函数
        if (!beforeChange(property, oldValue, value)) {
            //如果被截断,则返回,不将新值赋给属性的值
            return
        }
        //如果没有被截断,则将新值赋给属性的值
        this.value = value
        //调用属性值变化之后的处理函数
        afterChange(property, oldValue, value)
    }
}

ObservableProperty实现了ReadWriteProperty的getValue和setValue方法,其beforeChange方法用于判断是否截断对属性的赋值(ObservableProperty默认是不截断的),afterChange用于处理属性值变化之后。
observable方法中创建的ObservableProperty重写了afterChange,用于在属性值变化之后回到onChange方法,所以observable默认是不会截断对属性值的赋值。
细心的朋友会发现其getValue和setValue与我们之前介绍的kotlin—委托属性及其原理是一样的,所以observable的原理其实与kotlin—委托属性及其原理是一样的,这里不对字节码class展开介绍,有兴趣的请查阅kotlin—委托属性及其原理

4、vetoable

observable只是观察属性值的变化,因为其创建的ObservableProperty对象没有重写beforeChange,而beforeChange默认是true,所以不会截断对属性值的赋值。
有没有办法实现截断的呢?答案是我们可以自己创建ObservableProperty对象并重写beforeChange进行判断是否截断,也可以使用标准库中的vetoable函数,我们看看vetoable方法的源码:

public inline fun <T> vetoable(initialValue: T, crossinline onChange: (property: KProperty<*>, oldValue: T, newValue: T) -> Boolean):
            ReadWriteProperty<Any?, T> =
        object : ObservableProperty<T>(initialValue) {
            override fun beforeChange(property: KProperty<*>, oldValue: T, newValue: T): Boolean = onChange(property, oldValue, newValue)
        }

vetoable与observable都创建ObservableProperty对象,区别在于vetoable重写ObservableProperty的beforeChange方法,而observable重写ObservableProperty的afterChange方法,所以vetoable是用于是否截断对属性的赋值的处理逻辑,而observable用于观察属性值变化之后的处理逻辑。

上一篇 下一篇

猜你喜欢

热点阅读