美文网首页
Kotlin 委托属性(Delegated Properties

Kotlin 委托属性(Delegated Properties

作者: 阿木秀华 | 来源:发表于2018-07-06 17:48 被阅读55次

1. 简介

官方文档

简单说,委托属性就是将by语句前面的属性委托给by后面的对象去处理。
调用属性的get() set()方法,会执行委托的getValue()和setValue()方法。

我们直接撸代码。
使用by 语句将属性b委托给Delegate对象。

class Example {
    var b: String by Delegate()
  }

Delegate定义与官方文档稍有区别,使用了interface ReadWriteProperty<in R, T>,比起直接使用委托,多了类型检查。

class Delegate : ReadWriteProperty<Example, String> {
    var name = "example-delegate"
    override fun getValue(thisRef: Example, property: KProperty<*>): String {
      println("get ${property.name}")
      return name
    }

    override fun setValue(thisRef: Example, property: KProperty<*>, value: String) {
      name = value
      println("set ${property.name} = $value")
    }
  }

测试代码

val e = Example()
println(e.b)
e.b = "test"
println(e.b)

输出结果

get b
example-delegate
set b = test
test

2. 常见标准委托

lazy: 平时用的最多的,可以实现属性的延迟初始化。

ReadWriteProperty: 上面的例子中用到,方便自定义属性委托。

Delegates.observable:可以观察变化的属性,下面会用她来实现了一个简单的LiveData。

3. 实践 - 使用可观察属性实现一个LiveData

模仿Android LiveData,实现了可以订阅变化的数据类型。observe之后返回一个disposable,不再使用时一定要dispose,避免造成内存泄露。没有做LifecycleAware,需要Lifecycle特性的可以直接用LiveData。

用法:

# 声明属性
val userState = ObservableData("default-state")

# 订阅属性变化
disposable = userState.observe { old, new ->
   println("userState changed: $old -> $new ")
}

# 修改属性,  修改后会上面的订阅会被回调
userState.value = "state-login"

实现原理关键代码只有一行,使用了Delegates.observable

/**
 * 可以监听变化的数据,
 * 通过observe方法注册onChange监听
 * value值改变时回调onChange,回调在主线程
 */
class ObservableData<T>(default: T) {
  private val subject: BehaviorSubject<Pair<T, T>> =
    BehaviorSubject.createDefault(Pair(default, default))

  var value by Delegates.observable(default) { _, oldValue, newValue ->
    subject.onNext(Pair(oldValue, newValue))
  }

  fun observe(onChange: (old: T, new: T) -> Unit): Disposable {
    return subject.observeOn(AndroidSchedulers.mainThread()).subscribe(
      { onChange(it.first, it.second) },
      { it.printStackTrace() }
    )
  }
}

直接看源码
有问题欢迎大家留言指教。

4. 实践 - 封装SharedPreferences

直接看源码

先看一段代码:

class HomeSP : PreferenceData(JHKApplication.application, "com.amglhit.jhk.home") {
  var homeName by PrefString(default = "def-home")
  var user: HomeUser by PrefJson(clazz = HomeUser::class.java, default = HomeUser.empty)
}

定义了一个HomeSP类,通过继承PreferenceData,并使用PrefString、PrefJson等委托,就可以实现将类的数据保存在SharedPreferences中。
定义很简单,用法和普通的data class一样。实现原理主要使用ReadWriteProperty

val homeSP = HomeSP()
homeSP.homeName = "test-name $index"
homeSP.user = HomeUser("test_user  $index", 1, city = UserCity("BeiJing"))

直接操作属性,即可实现数据的持久化。
可以直接看源码,如果大家感兴趣,我可以再写一篇详细一些的介绍。

相关文章

网友评论

      本文标题:Kotlin 委托属性(Delegated Properties

      本文链接:https://www.haomeiwen.com/subject/rhzvuftx.html