Skip to content

扩展函数 ​

在本章中,你将探索能够让代码更加简洁且易读的特殊 Kotlin 函数。了解它们如何帮助你利用高效的设计模式,使项目更上一层楼。

扩展函数 ​

在软件开发中,通常需要在不修改原始源代码的情况下更改程序的行为。例如,你可能希望向第三方库中的类添加额外的功能。

你可以通过添加扩展函数(extension functions)来扩展类。调用扩展函数的方式与调用类的成员函数相同,都是使用点号 .。

在介绍扩展函数的完整语法之前,你需要理解什么是接收者(receiver)。接收者就是调用该函数的对象。换句话说,接收者是信息传递的目标或共享对象。

发送者与接收者示例

在此示例中,main() 函数调用了 .first() 函数来返回列表中的第一个元素。.first() 函数在 readOnlyShapes 变量上调用,因此 readOnlyShapes 变量就是接收者。

要创建扩展函数,请先编写要扩展的类名,后跟一个 . 和函数名称。接着完成函数声明的其余部分,包括其形参和返回值类型。

例如:

kotlin
fun String.bold(): String = "<b>$this</b>"

fun main() {
    // "hello" 是接收者
    println("hello".bold())
    // <b>hello</b>
}

在此示例中:

  • String 是被扩展的类。
  • bold 是扩展函数的名称。
  • .bold() 扩展函数的返回值类型是 String。
  • "hello"(String 的一个实例)作为接收者。
  • 在函数体内通过关键字 this 访问接收者。
  • 使用字符串模板($)来访问 this 的值。
  • .bold() 扩展函数接收一个字符串,并将其包裹在用于加粗文本的 <b> HTML 元素中返回。

面向扩展的设计 ​

你可以在任何地方定义扩展函数,从而能够采用面向扩展的设计。这类设计将核心功能与有用但非必需的特性分离开来,使代码更易于阅读和维护。

Ktor 库中的 HttpClient 类就是一个很好的例子,它可以帮助执行网络请求。其核心功能是单个 request() 函数,该函数接收 HTTP 请求所需的所有信息:

kotlin
class HttpClient {
    fun request(method: String, url: String, headers: Map<String, String>): HttpResponse {
        // 网络代码
    }
}

在实际开发中,最常用的 HTTP 请求是 GET 或 POST 请求。该库为这些常见用例提供更简短的名称是很合理的。然而,这些并不需要编写新的网络代码,只需调用特定的请求即可。换言之,它们非常适合定义为独立的 .get() 和 .post() 扩展函数:

kotlin
fun HttpClient.get(url: String): HttpResponse = request("GET", url, emptyMap())
fun HttpClient.post(url: String): HttpResponse = request("POST", url, emptyMap())

这些 .get() 和 .post() 函数扩展了 HttpClient 类。它们可以直接使用 HttpClient 类中的 request() 函数,因为它们是在作为接收者的 HttpClient 类实例上被调用的。你可以使用这些扩展函数以相应的 HTTP 方法调用 request() 函数,从而简化代码并使其更易于理解:

kotlin
class HttpClient {
    fun request(method: String, url: String, headers: Map<String, String>): HttpResponse {
        println("Requesting $method to $url with headers: $headers")
        return HttpResponse("Response from $url")
    }
}

fun HttpClient.get(url: String): HttpResponse = request("GET", url, emptyMap())

fun main() {
    val client = HttpClient()

    // 直接使用 request() 发起 GET 请求
    val getResponseWithMember = client.request("GET", "https://example.com", emptyMap())

    // 使用 get() 扩展函数发起 GET 请求
    // client 实例即为接收者
    val getResponseWithExtension = client.get("https://example.com")
}

这种面向扩展的方法在 Kotlin 的标准库以及其他库中被广泛使用。例如,String 类拥有许多扩展函数,可帮助你处理字符串。

有关扩展函数的更多信息,请参阅扩展。

练习 ​

检查整数是否为正数

编写一个名为 isPositive 的扩展函数,该函数接收一个整数并检查其是否为正数。

kotlin
fun Int.// 在此处编写你的代码

fun main() {
    println(1.isPositive())
    // true
}
示例解决方案 {...}
kotlin
fun Int.isPositive(): Boolean = this > 0

fun main() {
    println(1.isPositive())
    // true
}
将字符串转换为小写

编写一个名为 toLowercaseString 的扩展函数,该函数接收一个字符串并返回其小写版本。

提示
对 String 类型使用 .lowercase() 函数。
kotlin
fun // 在此处编写你的代码

fun main() {
    println("Hello World!".toLowercaseString())
    // hello world!
}
示例解决方案 {...}
kotlin
fun String.toLowercaseString(): String = this.lowercase()

fun main() {
    println("Hello World!".toLowercaseString())
    // hello world!
}