Kotlin学习 2 -- 标准函数和静态方法

本篇文章主要介绍以下几个知识点:

SUMMER DAY (图片来源于网络)

1. 标准函数 with、run 和 apply

Kotlin 的标准函数指的是 Standard.kt 文件中定义的函数,任何 Kotlin 代码都可以自由的调用所有的标准函数。

  • with 函数

with 函数接收两个参数:第一个参数可以是一个任意类型的对象,第二个参数是一个 Lambda 表达式。

with 函数会在 Lambda 表达式中提供第一个参数对象的上下文,并使用 Lambda 表达式中的最后一行代码作为返回值返回。示例代码如下:

val result = with(obj){
    // 这里是obj的上下文
    "value" // with 函数的返回值
}

with 函数可以在连续调用同一个对象的多个方法时让代码变得更加精简。

  • run 函数

run 函数的用法和使用场景和 with 函数非常类似,只是语法有些不同。

run 函数不能直接调用,一定要调用某个对象的 run 函数才行。

run 函数只接收一个 Lambda 参数,并且会在 Lambda 表达式中提供调用对象的上下文,用最后一行代码作为返回值。示例代码如下:

val result = obj.run{
    // 这里是obj的上下文
    "value" // run 函数的返回值
}
  • apply 函数

apply 函数和 run 函数也极其相似,都要在某个对象上调用,并且只接收一个 Lambda 参数,会在 Lambda 表达式中提供调用对象的上下文。

不过, apply 函数无法指定返回值,而是会自动返回调用对象本身。示例代码如下:

val result = obj.apply{
    // 这里是obj的上下文
}
// result == obj

举个例子,比如有一个水果列表,吃完所有水果并把结果打印出来,有如下代码:

val list = listOf("apple", "orange", "pear")
val builder = StringBuilder()
builder.append("开始吃水果:\n")
for (fruit in list){
    builder.append(fruit).append("\n")
}
builder.append("吃完全部水果!")
val result = builder.toString()
println(result)

上面代码连续调用了很多次 builder 对象的方法,若用 withrunapply 函数可以更加精简:

fun main() {
    val list = listOf("apple", "orange", "pear")

    // with 函数第一个参数传入 StringBuilder 对象,
    // 下面整个 Lambda 表达式的上下文都是这个 StringBuilder 对象
    val withResult = with(StringBuilder()) {
        append("开始吃水果:\n")
        for (fruit in list) {
            append(fruit).append("\n")
        }
        append("吃完全部水果!")
        toString()
    }

    // run 函数
    val runResult = StringBuilder().run {
        append("开始吃水果:\n")
        for (fruit in list) {
            append(fruit).append("\n")
        }
        append("吃完全部水果!")
        toString()
    }

    // apply 函数返回的是 StringBuilder 对象
    val applyResult = StringBuilder().apply {
        append("开始吃水果:\n")
        for (fruit in list) {
            append(fruit).append("\n")
        }
        append("吃完全部水果!")
    }

    println(withResult)
    println(runResult)
    println(applyResult.toString())
}

小结:withrunapply 函数的用法和使用场景非常类似,大多数情况下可以相互转换,编程时选择合适的即可。

2. 定义静态方法

静态方法是那种不需要创建实例就能调用的方法(某些编程语言里也叫类方法),在 Java 中定义一个静态方法只需要在方法上声明一个 static 关键字即可:

public class Util {
    public static void doAction() {
        // do something
        ...
    }
}

调用静态方法无需创建类的实例,直接用 Util.doAction() 即可,因而静态方法适合编写全局通用、无需创建实例的工具类。

不过,Kotlin 却极度弱化了静态方法这个概念,它提供了比静态方法更好的语法特性:单例类

像工具类这种功能,Kotlin 推荐用单例类来实现,如上述的代码用 Kotlin 实现:

object Util {
    fun doAction() {
        // do something
        ...
    }
}

使用单例类会将整个类中的所有方法变成类似静态方法的调用方式,若我们只想让类中的某一个方法变成静态方法的调用方式,则可以用 companion object,如下:

class Util {
    // doAction1 方法一定要先创建 Util 类的实例才能调用
    fun doAction1() {
        // do something
        ...
    }

    companion object {
        // doAction2 方法直接使用 Util.doAction2() 即可
        fun doAction2() {
            // do something
            ...
        }
    }
}

上面 doAction2() 方法并不是静态方法,关键字 companion object 会在 Util 类的内部创建一个伴生类,而 doAction2() 方法就是定义在这个伴生类里的实例方法。

当然,Kotlin 也提供了两种实现静态方法的方式:注解和顶层方法。

  • 注解

在单例类或 companion object 中的方法加上 @JvmStatic 注解,Kotlin 编译器就会将这些方法编译成真正的静态方法,如下:

class Util {
    fun doAction1() {
        println("do action1")
    }

    // @JvmStatic 注解只能加在单例类或者 companion object 中的方法上
    companion object {
        @JvmStatic
        fun doAction2() {
            println("do action2")
        }
    }
}
  • 顶层方法

顶层方法是指那些没有定义在任何类中的方法,如上面的 main() 方法。

Kotlin 编译器会把所有的顶层方法编译成静态方法。

定义顶层方法,首先要创建一个 Kotlin 文件,创建类型选择 File,比如创建了个 Helper.kt 文件,在此文件中定义的任何方法都是顶层方法:

// 在 Helper.kt 中定义了个 doSomething 顶层方法
fun doSomething() {
    println("do something")
}

所有的顶层方法在 Kotlin 代码中可以在任何位置被直接调用,不用管包名路径,也不用创建实例,如调用上面定义的顶层方法直接键入 doSomething() 即可。

不过,在 Java 中没有顶层方法这个概念,所有的方法必须定义在类中。上面创建的 Kotlin 文件名是 Helper.kt,Kotlin 编译器会自动创建一个叫 HelperKt 的类,在 Java 中调用上面定义的顶层方法使用 HelperKt.doSomething() 即可。

小结:除了 @JvmStatic 注解不太常用,其他像单例类、companion object、顶层方法都是 Kotlin 中比较常用的技巧。

本篇文章就介绍到这。

推荐阅读更多精彩内容