Kotlin 委托属性(Delegated Properties)用法与实践(SharedPreferences封装及模仿LiveData)

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"))

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

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 172,050评论 25 707
  • 前言 Android Architecture Components,简称 AAC ,是 Google IO 20...
    前行的乌龟阅读 5,773评论 3 27
  • 回家过年6:2017年1月26日,农历腊月29。 午后的阳光暖暖的,室外没有风,有些早春的气息。因常年在外,家乡县...
    春之原野阅读 985评论 5 11
  • 我们大都会认同,自己并非总是处于理性之中。我们会情绪崩溃,会放纵自己,会偷懒,会失控。 然而这些都只是冰山...
    童小晴阅读 337评论 1 1
  • 相机 你在桥上看风景 我在窗里看你 我在用手机拍老腊肉 小妹纸却用手机拍我
    白岭南阅读 160评论 0 1