Skip to content

擴充函式 ​

在本章中,你將探索特殊的 Kotlin 函式,它們能讓你的程式碼更加簡潔且易讀。了解它們如何協助你運用高效的設計模式,讓你的專案更上一層樓。

擴充函式 ​

在軟體開發中,你經常需要在不修改原始碼的情況下變更程式的行為。例如,你可能想要為來自第三方程式庫的類別新增額外功能。

你可以藉由新增_擴充函式_來擴充類別。呼叫擴充函式的方式與呼叫類別成員函數的方式相同,都是使用句點 .。

在介紹擴充函式的完整語法之前,你需要了解什麼是 接收者(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 元素中傳回。

擴充導向設計 ​

你可以在任何地方定義擴充函式,這讓你能實現擴充導向設計(extension-oriented design)。這些設計將核心功能與實用但非必要的功能區分開來,使你的程式碼更易於閱讀與維護。

一個很好的例子是來自 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!
}