1. 介紹
當你在寫一個教學專案(例如我們的主控台支出追蹤器)時,程式碼很快就會長出各種小小的「便利功能」:一下要把指令正規化,一下要為金額做漂亮的標籤,一下要計算「字串的最後索引,但要安全」。 這些都可以用函式來封裝——而且很正常。但有時從語意上就是想要用屬性,因為我們不是「做一個動作」,而是「查看一個特徵」: expense.title, money.formatted, command.normalized.
Extension‑properties 能讓程式碼更「一眼可讀」。它們特別適合用在格式化輸出、產生報表、做簡單檢查與轉換的地方。只要記得:這不是魔法,也不是「把欄位加到物件裡」——Kotlin 不會改變原始類別,我們只是得到更方便的存取語法。
2. Extension‑properties 的運作方式:為什麼它不是欄位
Extension‑property 看起來像屬性,但在實作上——它只是存取函式(getter/setter)的一對組合。 因此它沒有「物件內部的位置」可以放值。Kotlin 很誠實地說:想要 extension‑property——可以,但只能透過 get()/set()。 這也是為什麼你不能寫 = 123 當作「初始化」——編譯器會禁止。
基本形式如下:
val String.normalized: String
get() = trim().lowercase()
var StringBuilder.indent: Int
get() = 0 // example, but meaningless
set(value) { /* ... */ }
以及一個很有用的「心智模型」(非常粗略,但用來理解很有效):
obj.someProp
↓
getSomeProp(obj) // roughly: generated getter function
甚至可以畫一個迷你流程圖:
flowchart LR
A["obj.someProp"] --> B["someProp.get()"]
B --> C["執行 get() 的程式碼"]
C --> D["回傳值"]
為了避免混淆,請記住一個簡單規則:如果你能把它想成「此刻就能計算出的值」——extension‑property 很適合。 如果你需要「把值記在物件裡,之後再取出」——extension‑property 不適合。
下面是一個小對照表,幫你加深一般類別屬性與 extension‑property 的差異:
| 比較項目 | 類別中的一般屬性 | Extension‑property |
|---|---|---|
| 是否有 backing field(內部儲存欄位) | 可能有(field) | 沒有 |
| 能否用 = ... 來初始化 | 可以 | 不行,禁止 |
| 能否做成可計算屬性 | 可以 | 可以 |
| 能否把狀態儲存在「物件內」 | 可以 | 不行(只能用外部技巧) |
| 能否存取類別的 private 欄位 | 可以 | 不行 |
3. 範例:字串與資料模型
指令輸入的正規化
在主控台應用程式中,一半的「痛苦」都來自使用者輸入。使用者會輸入 " ADD ", "Add", "add",有時甚至 "aDd"(到底為什麼要這樣?)。 因此字串正規化是永遠的主題。
在之前的講座裡我們會用函式來做。但在這裡你可以讓自己用屬性,因為「字串的正規化版本」是一個特徵,而不是「會改變什麼的動作」。
val String.normalizedCommand: String
get() = trim().lowercase()
fun main() {
val raw = " AdD "
println(raw.normalizedCommand) // add
}
這樣的程式碼讀起來幾乎像是「這個字串有一個正規化後的指令」。但請記住:字串本身並沒有被改變——我們只是每次都重新計算結果。
另一個經典例子是「最後索引,但安全」。空字串的 length == 0,而 length - 1 會得到 -1。 如果你本來就是這樣設計的(例如乾脆不要去存取索引),那其實沒問題。
val String.lastIndexOrMinusOne: Int
get() = length - 1
fun main() {
println("".lastIndexOrMinusOne) // -1
println("kotlin".lastIndexOrMinusOne) // 5
}
在這裡 extension‑property 幾乎就是「程式碼裡的文件」:你看到 lastIndexOrMinusOne 這個名字,就立刻知道空字串會發生什麼事。
Money 的格式化與 Expense 的輸出字串
當專案成長時,你幾乎不可避免會引入自己的型別。在支出追蹤器裡,用一個「錢」的型別很方便,避免把「法郎/美元」和「內部的分/美分」混在一起,也避免不小心把字串與數字亂加。
我們用 value class 做一個最小的金錢型別(在型別安全的章節已經看過),然後把格式化放到 extension‑property 裡。 重點:格式化是「呈現」,不會改變物件,因此這裡用 property 很合適。
@JvmInline
value class Money(val cents: Long)
val Money.formatted: String
get() {
val sign = if (cents < 0) "-" else ""
val abs = kotlin.math.abs(cents)
val dollars = abs / 100
val rest = abs % 100
return "$sign$dollars.${rest.toString().padStart(2, '0')}"
}
fun main() {
println(Money(12345).formatted) // 123.45
println(Money(-90).formatted) // -0.90
}
沒錯,這個計算不是「零成本」(用到了 abs 與 padStart)。但它夠輕量、也符合直覺: 當你寫 money.formatted,就像是在要「字串表示」。這很合理。
接著加上一個支出模型,並為清單顯示做一行漂亮的字串。同樣地:我們不希望用格式化邏輯污染 data class(資料模型通常希望保持簡潔),因此 extension‑property 是很好的折衷。
data class Expense(
val title: String,
val amount: Money,
val category: String
)
val Expense.listLine: String
get() = "${category.padEnd(10)} | ${title.padEnd(15)} | ${amount.formatted}"
fun main() {
val e = Expense("Coffee", Money(390), "food")
println(e.listLine) // food | Coffee | 3.90
}
請注意命名的「誠實」。listLine 直接說明:這是一行用於輸出的字串。 如果我們把它叫做 val Expense.info,就會更不清楚格式為何、用在哪裡。
4. var extension‑properties 與外部儲存
對 val extension‑properties 大家通常都很舒服:它們就是計算並回傳。但 var 會引發一個合理的問題:「如果我做 set(value),值到底寫到哪裡?」這時你就該停下來,心裡問自己:「我是不是其實在嘗試把欄位硬掛到物件上?」
Kotlin 允許 var extension‑properties,但也提醒:它們沒有 backing field,因此本身不會儲存任何東西。 如果你需要「看起來像是附加了一個值」,你就得把它存到外部某處(通常是 Map)。
我們用一個和 Kotlin 文件裡很像的例子來示範。假設我們想為支出加上一個「標籤」(例如 "coffee", "home", "urgent"),但目前不想(或不能)立刻修改 Expense 類別本身。
我們做一個外部儲存,並做一個會去查它的 extension‑property。為了讓範例更穩定,我們用 id 綁定,而不是用整個物件。(請注意:這裡為了示範使用了簡化版的 Expense。)
data class Expense(
val id: Int,
val title: String
)
private val tagsById = mutableMapOf<Int, String>()
var Expense.tag: String?
get() = tagsById[id]
set(value) {
if (value == null) tagsById.remove(id) else tagsById[id] = value
}
fun main() {
val e = Expense(id = 1, title = "Coffee")
println(e.tag) // null
e.tag = "drink"
println(e.tag) // drink
}
技術上它確實可行。但在設計上這已經是「薄冰」:Expense 看起來像是有一個 tag 欄位,但其實標籤住在另一個 map 裡。 這可能作為暫時方案沒問題,但很容易變成奇怪 bug 的來源(例如 id 被重用,或你忘了清理 tagsById)。
5. 限制:初始化、昂貴的 get() 與副作用
為什麼不能初始化 extension‑property
新手有時會這樣想:「好吧,既然沒有欄位,那我現在就建一個。寫 var X.y = 0 就好了。」Kotlin 會回答:「extension‑properties 不允許初始化器。」 原因很簡單:初始化器意味著要存值,但沒有地方可以存——我們無法在別人的物件裡物理新增欄位。
下面是「錯誤的幻想」,它無法編譯:
data class User(val name: String)
var User.age = 0 // will NOT compile: no get/set and no field
如果你真的希望 User 有一個 age 欄位,通常正確作法是: 把屬性加回類別本身、為物件做一層 wrapper,或老老實實把狀態存到外部儲存(例如 repository/map),不要假裝那是「物件內的欄位」。
當然,外部儲存也可以用 var extension‑property 藏起來(就像上面的例子)。但那是有意識的技巧,而不是「一般新增欄位的方式」。
昂貴的 get() 與意外的效果
有個微妙的心理現象:當你看到 obj.prop,大腦預期它很快、沒驚喜。 但當你看到 obj.calculateTotal(),大腦會先做好「可能很花功夫」的準備。 因此,帶有昂貴 get() 的屬性可能會成為讀者的陷阱——一個月後也可能變成你自己的陷阱。
以支出清單為例,這樣寫看起來很誘人:
@JvmInline
value class Money(val cents: Long)
data class Expense(val amount: Money)
val List<Expense>.total: Money
get() {
var sum = 0L
for (e in this) sum += e.amount.cents
return Money(sum)
}
形式上這沒問題。但此後 expenses.total 每次都會掃過整個清單。 如果你在迴圈裡呼叫十次,就會走十次。 在教學專案的小資料量下還能接受,但這是一種危險的習慣。
在這種情況下,通常選擇 extension‑function 更好(我們也已經會寫),因為呼叫形式本身就更誠實地提醒「這裡有計算」。 Kotlin 允許用 property,不代表它永遠更好。
更糟的是 get() 產生副作用,例如列印或改動集合。 這會把 obj.prop 變成「最短的恐怖故事」:你只是讀了個值,程式卻突然改了東西或印到主控台。
6. 專案中 extension‑properties 應該放哪裡
當 extensions 變得有用時,很容易想做一個 Extensions.kt 檔案,把所有東西都丟進去:字串、金錢、報表、貓貓。 這很快就會變成隨機函式的墳場,什麼都找不到(就像 Downloads 資料夾,但更糟)。
Kotlin 的慣例提出了一個相當合理的想法:對於「所有使用者都重要」的 extension 函式/屬性,最好放在類別附近。 而那些只對特定情境有用的(例如只用在 CLI 輸出),就放在該情境附近,而不是全域亂放。
以我們的教學支出追蹤器來說,可以這樣理解:Expense.listLine 的格式是主控台輸出,最合理就是放在 CLI 程式碼附近或放在格式化檔案中。 而 Money.formatted 如果在多處使用,就更適合放在 Money 附近或專案的「財務」模組中。
另外一個實務點:extension‑properties 透過 import 引入,名稱衝突完全可能發生。 你選擇越精準、越領域化的名稱(listLine, formatted, normalizedCommand),就越不容易在不同套件裡不小心寫出兩個 val String.value,然後開始玩「猜 import」。
7. 使用 extension‑properties 的常見錯誤
錯誤 1:試圖用 var X.prop = ... 來「硬加欄位」。
這是從某些允許動態欄位或有元程式設計的語言轉來時常見的反射動作。Kotlin 不是這樣運作:extension‑property 不能有初始化器,因為那表示要把值存進物件,但我們沒有改變物件。 正確策略是寫 get/set,並清楚理解狀態實際會存在哪裡。
錯誤 2:把「昂貴的」 get() 偽裝成簡單屬性。
如果 get() 做了明顯的工作量(走訪大型集合、建立很長的字串、讀檔),讀程式的人可能完全沒預期這個成本。 結果就會出現意外卡頓與重複計算。這時通常選擇函式更誠實,因為呼叫語法本身就暗示「這裡有計算」。
錯誤 3:在 get() 中做副作用:列印、變異、隱藏變更。
Kotlin 的屬性讀起來像「取得一個值」。如果你的 get() 內部呼叫 println()、改動全域變數或修改集合,程式碼就會變得不可預測。 這些更適合用有明確動詞命名的函式來表達,讓動作是顯性的。
錯誤 4: var extension‑property 看起來「像在儲存」,但其實把值存到不明所以的地方。
用 MutableMap 的技巧有時確實需要(例如暫時的墊片),Kotlin 文件也展示過類似例子。 但如果讀者看不出值住在哪裡、以及誰負責這個儲存的生命週期,就會得到很難除錯的問題。 如果語意上它本來就該是模型的一部分——多數情況下更好的方式是把一般屬性加回類別裡。
錯誤 5:期待 extension‑property 能存取類別的 private 欄位。
Extension‑property 不會變成「類別的一部分」,也不會獲得特權。它只能看到外部可見的東西。 如果你卡在 private,這通常是個訊號:要嘛你需要在類別裡提供 public 的方法/屬性,要嘛你正在試圖破壞封裝,應該重新思考設計。
GO TO FULL VERSION