Kotlin的扩展特性

Kotlin的扩展(Extension),主要分为两种语法:

1)扩展函数

2)扩展属性

从语法上看,扩展看起来就像是我们从类的外部为它扩展了新的成员。

这在实际编程当中是非常有用的功能,具体场景如:我们想修改JDK中的String,想在它的基础上增加一个方法"lastElement() "来获取末尾元素,如果使用Java,我们是无法通过常规手段实现的,因为我们无法修改JDK的源码。任务第三方提供的SDK,我们都无权修改。

但,借助Kotlin的扩展函数,我们就可以完全在语法层面,来为第三方SDK的类扩展新的成员方法和成员属性。不管是为JDK的String增加新的成员方法,还是为Android SDK的View增加新的成员属性,我们都可以实现。

什么事扩展函数和扩展属性?

扩展函数,就是从类的外部扩展出来的一个函数,这个函数看起来就像是类的成员函数一样。这里,我们以JDK中的String为例,来看看如何通过Kotlin的扩展特性,为它新增一个lastElement()方法。

// Ext.kt
package com.tcl.demo

fun String.lastElement(): Char? {
    if (this.isEmpty()) {
        return null
    }
    return this[length - 1]
}

// 使用扩展函数
fun main() {
    val msg = "Hello Wolrd"
    // lastElement就像String的成员方法一样可以直接调用
    val last = msg.lastElement() // last = d
}

如代码所示,我们先是定义了一个String的扩展函数"lastElement()",然后在main函数当中调用了这个函数,并且,这个扩展函数直接定义在Kotlin文件里的,而不是定义在某个类当中,这种扩展函数,我们称之为“顶层扩展”,因为它并没有嵌套在任何类当中,它自身就在最外层。

其中,"String.",代表我们的扩展函数为String这个类定义的,在Kotlin当中,它有一个名字,叫做接收者(Receiver),也就是扩展函数的接收方。

此外,如果去掉"String.",这段代码就会变成一个普通的函数定义:

fun lastElement(): Char? {
    if (this.isEmpty()) {
        return null
    }
    return this[length - 1]
}

反之,如果在普通函数的名字前面加上一个“接受者类型”,如"String.",Kotlin的普通函数就变成了扩展函数。

可见,Kotlin的扩展语法设计的非常巧妙,只要记住了普通函数的语法,只需要再记住一点点细微的差别,就能记住扩展函数的语法,所谓的扩展函数,就是多了个“扩展接受者”的函数。

扩展函数的实现原理

反编译示例代码,

public final class ExtKt {
   public static final Character lastElement(String $this) {
      CharSequence var1 = (CharSequence)$this;
      if (var1.length() == 0) {
        return null
      }

      return  var1.charAt(var1.length() - 1);
   }
}

public static final void main() {
  String msg = "Hello Wolrd";
  Character last = ExtKt.lastElement(msg);
}

可查看到:原本定义在String类型上面的扩展函数lastElement(),变成了一个普通的静态方法。另外,之前定义的扩展函数lastElement()是没有参数的,但反编译后的Java代码中,lastElement(String $this)多了一个String类型的参数。原本msg.lastElement()的地方变成了ExtKt.lastElement(msg),这说明,Kotlin编写的扩展函数调用代码,最终会变成静态方法的调用。

也就是说,由于JVM不理解Kotlin的扩展语法,所以Kotlin编译器会将扩展函数转换成对应的静态方法,而扩展函数调用处的代码也会被转换成静态方法的调用。

如何理解扩展属性?

扩展函数,是在类的外部为它定义一个新的成员方法;而扩展属性,则是在类的内部为它定义一个新的成员属性。

在反编译Kotlin代码之后,我们知道,从外部定义的成员方法和书写,都只是语法层面的,并没有实际修改那个类的源代码。

还是以lastElement为例,以扩展属性的方式实现。扩展函数的定义比普通函数,其实只是多了一个“接收者类型”,类似的,扩展属性,也就是在普通属性定义的时候多加了一个“接收者类型”即可。

// 接收者类型
val String.lastElement: Char?
    get() = if (isEmpty()) {
            null
        } else {
            get(length - 1)
        }

fun main() {
    val msg = "Hello Wolrd"
    // lastElement就像String的成员属性一样可以直接调用
    val last = msg.lastElement // last = d
}

在示例代码中,我们为String类型扩展了一个新的成员属性"lastElement",然后在main函数当中,直接使用msg.lastElement使用了这个扩展属性。

1.png

上面的两个箭头,说明了扩展函数与扩展属性,它们最终会被Kotlin编译器转换成静态方法;下面两个箭头,说明了扩展函数和扩展属性的调用代码,最终会被Kotlin编译器转换成静态方法的调用。

不管是扩展函数还是扩展属性,它本质上都会变成一个静态的方法。

扩展能做什么?

当我们想要从外部为一个类扩展一些方法和属性的时候,我们就可以通过扩展来实现了。在Kotlin当中,几乎所有的类都可以被扩展,包括普通类,单例类,密封类,枚举类,伴生对象,甚至包含第三方提供的Java类。唯有匿名内部类,由于它本身不存在名称,我们无法指定“接收者类型”,所以不能被扩展,当然,它也没有必要被扩展。

可以说,Kotlin扩展的应用范围是非常广的,它最重要的用处,就是用来取代Java当中的各种工具栏,比如StringUtils,DateUtils等。

所有Java工具类能做的事情,Kotlin扩展函数都能做,并且可以做的更好,扩展甘薯的优势在于,开发工具可以在编写代码的时候智能提示。

2.gif
扩展不能做什么?

Kotlin的扩展,由于它本质上并没有修改接收类型的源代码,所以它的行为是无法与类成员完全一致的,对比普通的类成员,它有以下几个限制:

1、无法被它的子类重写。

2、扩展属性无法存储状态。

3、扩展的访问作用域仅限于两个地方:1)定义处的成员,2)接收者类型的公开成员。(无法访问私有成员)

针对扩展的第三个限制来说:

  • 如果扩展时顶层的扩展,那么扩展的访问域仅限于该Kotlin文件当中的所有成员,以及被扩展类型的公开成员,这种方式定义的扩展是可以被全局使用的。
  • 如果扩展是被定义在某个类当中的,那么该扩展的访问域仅限于该类当中的所有成员,以及被扩展类型的公开成员,这种方式定义的扩展仅能在该类当中使用。
实战与思考

在Kotlin源码当中,String.kt的源码如下:

// String.kt
public class String : Comparable<String>, CharSequence {
    companion object {}

    public operator fun plus(other: Any?): String

    public override val length: Int

    public override fun get(index: Int): Char

    public override fun subSequence(startIndex: Int, endIndex: Int): CharSequence

    public override fun compareTo(other: String): Int
}

你一定会惊讶,Kotlin里面的String类竟然只有不到十行代码,那么String类的那些字符操作的方法去哪里了?如,String.trim(),String.lowercase()

实际上,String相关的操作方法全部放到了Strings.kt当中去了。而这些字符操作方法全部都是以扩展函数的方式定义的:

// Strings.kt 部分代码

public fun CharSequence.trim(): CharSequence = trim(Char::isWhitespace)

public expect fun String.lowercase(): String

这就是Kotlin扩展的一个很典型的使用场景:关注点分离。所谓关注点分离,就是将我们程序的逻辑划分成不同的部分,每一个部分,都只关注自己的那部分的职责。以上面的String类为例,String.kt这个类,只关注String的核心逻辑,而Strings.kt则只关注String的操作符逻辑。

小结一下,Kotlin扩展主要有两个核心的使用场景:

1、主动使用扩展,通过它来优化软件架构。

对复杂的类进行职责划分,关注点分离。让类的核心尽量简单易懂,而类的功能性属性与方法以扩展的形式存在于类的外部,如String.kt和Strings.kt

2、被动使用扩展,提升可读性与开发效率。

当我们无法修改外部的SDK时,对于重复的代码模式,我们将其以扩展的方式封装起来,提供给对应的接收者类型。

在学习的过程中,我们需要将知识点梳理,分类整理,关联记忆,形成体系化的知识面,深度思考,不断深挖探索。


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

推荐阅读更多精彩内容