Kotlin扩展函数

扩展函数一般用于为第三方SDK中的类添加功能方法,是实现多态的一种形式。

Kotlin的扩展函数是“开放-封闭原则”-----对扩展开放,对修改封闭的良好实现。它替代了继承形式的扩展,做到了更优雅的使用和调用,也避免了继承带来的其他问题。

一、编写和使用

  1. 自定义扩展函数

  2. 找到一个合适的定义文件

    1. 我们一般将一种类型,或者实现同一类方法的的扩展函数,统一定义到一个Kt文件里
  3. 与定义普通函数类似,除此之外,扩展函数需要定义“接收者类型”作为前缀,代表该函数的接收方

//形如
fun <class_name>.<method_name>() {

}

//举例
fun <T> MutableList<T>.swap(from: Int, to: Int): Boolean {
    if (from < 0 || from >= this.size) {
        return false
    }
    if (to < 0 || to >= this.size) {
        return false
    }
    val temp = this[from]
    this[from] = this[to]
    this[to] = temp
    return true
}

//使用
val list = mutableListOf(1, 2, 3)
list.swap(1, 2)

  1. 自定义扩展变量

    扩展属性实际上是提供一种方法来访问属性,因为不可能给类添加额外的属性字段,只是使用简洁语法类似直接操作属性,实际上还是方法的访问,自然就没有默认get()/set()方法实现,所以必须显式提供get()/set()方法。
    
var TextView.isBolder: Boolean
    get() {
        return this.paint.isFakeBoldText
    }

  1. 错误示例

  2. 覆盖已有成员方法

fun Activity.onDestroy() {
    //.....
}

同名的类中,成员方法的优先级总高于扩展函数,Kotlin会默认使用成员方法,防止方法调用的混淆。

  1. 不分场景的滥用
fun Context.loadImage(url: String, imageView: ImageView) {
    Glide.with(this)
         .load(url)
         .placeholder(R.drawable.default)
         .error(R.drawable.error)
}

我们为Context类扩展了不属于其使用范畴的功能,仅仅是省去了调用时的部分传参,还可能产生ImageView与当前Context不一致的问题,属于扩展机制的滥用。

应该进行如下修改:

fun ImageView.loadImage(url: String) {
    Glide.with(this.context)
         .load(url)
         .placeholder(R.drawable.default)
         .error(R.drawable.error)
}

二、常用标准库扩展函数的使用

  1. let

  2. 实现:public inline fun <T, R> T.let(block: (T) -> R): R = block(this)

  3. 返回:闭包形式,返回值为最后一行的值或者指定的return的表达式

  4. 适用场景:

    1. 明确一个变量所处特定的作用域范围,常用作处理需要针对一个可null的对象统一做判空处理
mArticle?.let {
    //it在let作用域内,代表mArticle非空对象
    it.todo()
}

  1. with

with其实不是一个扩展函数,只是一个内联函数

  1. 实现:fun <T, R> with(receiver: T, block: T.() -> R): R = receiver.block()

  2. 返回:闭包形式,返回值为最后一行的值或者指定的return的表达式

  3. 使用场景

    1. 适用于调用同一个类的多个方法时,可以省去类名重复,直接调用类的方法、变量
override fun onBindViewHolder(holder: ViewHolder, position: Int){
   val item = getItem(position)?: return

   //使用with
   with(item){
      holder.tvNewsTitle.text = StringUtils.trimToEmpty(title)
      holder.tvNewsSummary.text = StringUtils.trimToEmpty(summary)
   }

   //不使用with
   holder.tvNewsTitle.text = StringUtils.trimToEmpty(item.titleEn)
   holder.tvNewsSummary. text = StringUtils.trimToEmpty(item.summary)
}

  1. run

run函数是let、with两个函数结合体

  1. 实现:public inline fun <T, R> T.run(block: T.() -> R): R = block()

  2. 返回:闭包形式,返回值为最后一行的值或者指定的return的表达式

  3. 使用场景

    1. run函数一方面弥补了let函数在函数体内必须使用it参数替代对象,另一方面它弥补了with函数传入对象判空问题。在run函数中可以像let函数一样做判空处理,也可以像with函数一样可以省略类名,直接访问实例的公有属性和方法。
fun main(args: Array<String>) {
    var user :User? = null

    val result = user?.run {
        println("my name is $name, I'm $age years old)
        1000
    }
    println("result: $result") //result: 1000
}

class User(var name: String, var age: String) {
}

  1. apply

apply函数与run函数类似,唯一不同点就是它返回的值是对象本身

  1. 实现:fun T.apply(block: T.() -> Unit): T { block(); return this }

  2. 返回:返回this(当前对象)

  3. 使用场景

    1. apply一般用于一个对象实例初始化的时候,需要对对象中的属性进行赋值
fun initUserView(name: String, age: String) {
    userView = View.inflate(context, R.layout.layout_user, null).apply {
        user_name = name
        user_age = age
    }
}

  1. also

also函数与let函数类似,唯一不同点就是它返回的值是对象本身

  1. 实现:public inline fun T.also(block: (T) -> Unit): T { block(this); return this }

  2. 返回:返回this(当前对象)

  3. 使用场景

    1. also函数一般用于多个扩展函数链式调用
val original = "abc"

original.let{
    println(it) //abc
    it.reversed()
}.let{
    println(it) //cba
}

original.also{
    println(it) //abc
    it.reversed()
}.also{
    println(it) //abc
}
//let每次会返回最后一个表达式的结果,而also会返回内置对象。

  1. takeIf

  2. 实现:public inline fun <T> T.takeIf(predicate: (T) -> Boolean): T? = if (predicate(this)) this else null

  3. 返回:返回this或null

  4. 使用场景:

    1. 多重判空
//Java
if(someObject!= null && someObject.status){ 
   someObject.doThis()
}
//Kotlin
someObject?.takeIf {status}?doThis()

总结

6202959-757d95d7a54de330.png
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念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

推荐阅读更多精彩内容