kotlin—observable及其原理

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用于观察属性值变化之后的处理逻辑。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,088评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,715评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,361评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,099评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 60,987评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,063评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,486评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,175评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,440评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,518评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,305评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,190评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,550评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,880评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,152评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,451评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,637评论 2 335

推荐阅读更多精彩内容