屬性
在 Kotlin 中,屬性讓你無需撰寫用於存取或變更資料的函式,即可儲存並管理資料。 你可以在類別、介面、物件、伴生物件中使用屬性, 甚至可以在這些結構之外作為頂層屬性使用。
每個屬性都有名稱、型別,以及一個自動產生的 get() 函式(稱為 getter)。你可以使用 getter 來讀取屬性的值。如果該屬性是可變的,它還會有一個名為 setter 的 set() 函式,允許 你變更該屬性的值。
Getter 和 setter 被稱為存取子 (accessors)。
宣告屬性
屬性可以是可變的 (var) 或唯讀的 (val)。 你可以在 .kt 檔案中將它們宣告為頂層屬性。可以將頂層屬性視為屬於某個套件的全域變數:
// 檔案:Constants.kt
package my.app
val pi = 3.14159
var counter = 0你也可以在類別、介面或物件內部宣告屬性:
// 具有屬性的類別
class Address {
var name: String = "Holmes, Sherlock"
var street: String = "Baker"
var city: String = "London"
}
// 具有屬性的介面
interface ContactInfo {
val email: String
}
// 具有屬性的物件
object Company {
var name: String = "Detective Inc."
val country: String = "UK"
}
// 實作介面的類別
class PersonContact : ContactInfo {
override val email: String = "sherlock@example.com"
}若要使用屬性,直接透過其名稱參照即可:
class Address {
var name: String = "Holmes, Sherlock"
var street: String = "Baker"
var city: String = "London"
}
interface ContactInfo {
val email: String
}
object Company {
var name: String = "Detective Inc."
val country: String = "UK"
}
class PersonContact : ContactInfo {
override val email: String = "sherlock@example.com"
}
fun copyAddress(address: Address): Address {
val result = Address()
// 存取 result 執行個體中的屬性
result.name = address.name
result.street = address.street
result.city = address.city
return result
}
fun main() {
val sherlockAddress = Address()
val copy = copyAddress(sherlockAddress)
// 存取 copy 執行個體中的屬性
println("Copied address: ${copy.name}, ${copy.street}, ${copy.city}")
// Copied address: Holmes, Sherlock, Baker, London
// 存取 Company 物件中的屬性
println("Company: ${Company.name} in ${Company.country}")
// Company: Detective Inc. in UK
val contact = PersonContact()
// 存取 contact 執行個體中的屬性
println("Email: ${contact.email}")
// Email: sherlock@email.com
}在 Kotlin 中,我們建議在宣告屬性時就進行初始化,以確保程式碼的安全與易讀。然而, 在特殊情況下,你可以稍後再進行初始化。
如果編譯器可以從初始設定式或 getter 的傳回型別推論出型別,則宣告屬性型別是選用的:
var initialized = 1 // 推論型別為 Int
var allByDefault // 錯誤:屬性必須初始化。自訂 getter 和 setter
預設情況下,Kotlin 會自動產生 getter 和 setter。當你需要額外的邏輯時(例如驗證、格式化或根據其他屬性進行計算), 你可以定義自己的自訂存取子。
每次存取屬性時,都會執行自訂 getter:
class Rectangle(val width: Int, val height: Int) {
val area: Int
get() = this.width * this.height
}
fun main() {
val rectangle = Rectangle(3, 4)
println("Width=${rectangle.width}, height=${rectangle.height}, area=${rectangle.area}")
}如果編譯器可以從 getter 推論出型別,你可以省略型別宣告:
val area get() = this.width * this.height除了初始化期間之外,每次為屬性指派值時都會執行自訂 setter。 依照慣例,setter 參數的名稱為 value,但你可以選擇其他名稱:
class Point(var x: Int, var y: Int) {
var coordinates: String
get() = "$x,$y"
set(value) {
val parts = value.split(",")
x = parts[0].toInt()
y = parts[1].toInt()
}
}
fun main() {
val location = Point(1, 2)
println(location.coordinates)
// 1,2
location.coordinates = "10,20"
println("${location.x}, ${location.y}")
// 10, 20
}變更可見性或新增註解
在 Kotlin 中,你可以變更存取子的可見性或新增註解,而無需取代預設實作。 你不需要在主體花括號 {} 內進行這些變更。
若要變更存取子的可見性,請在 get 或 set 關鍵字前面加上修飾詞:
class BankAccount(initialBalance: Int) {
var balance: Int = initialBalance
// 只有該類別可以修改餘額
private set
fun deposit(amount: Int) {
if (amount > 0) balance += amount
}
fun withdraw(amount: Int) {
if (amount > 0 && amount <= balance) balance -= amount
}
}
fun main() {
val account = BankAccount(100)
println("Initial balance: ${account.balance}")
// 100
account.deposit(50)
println("After deposit: ${account.balance}")
// 150
account.withdraw(70)
println("After withdrawal: ${account.balance}")
// 80
// account.balance = 1000
// 錯誤:無法指派,因為 setter 是 private
}若要為存取子加上註解,請在 get 或 set 關鍵字之前使用該註解:
// 定義可套用於 getter 的註解
@Target(AnnotationTarget.PROPERTY_GETTER)
annotation class Inject
class Service {
var dependency: String = "Default Service"
// 標註 getter
@Inject get
}
fun main() {
val service = Service()
println(service.dependency)
// Default service
println(service::dependency.getter.annotations)
// [@Inject()]
println(service::dependency.setter.annotations)
// []
}此範例使用反射來展示 getter 和 setter 上存在哪些註解。
支援欄位
當值需要儲存在記憶體中時,編譯器會自動為屬性產生支援欄位。
例如,當你使用預設的 get() 和 set() 函式時,編譯器會建立支援欄位,因為它們 會讀取並寫入儲存的值:
var count = 0你可以在自訂 get() 或 set() 函式中使用 field 關鍵字來存取支援欄位。 例如,你可以為 getter 或 setter 新增額外邏輯,或是在屬性變更時觸發額外的操作。
在此範例中,score 屬性在 set() 函式內部使用支援欄位,以便在更新值時同時觸發記錄事件:
class Scoreboard {
var score: Int = 0
set(value) {
field = value
// 更新值時加入記錄
println("Score updated to $field")
}
}
fun main() {
val board = Scoreboard()
board.score = 10
// Score updated to 10
board.score = 20
// Score updated to 20
}並非所有屬性都會預設建立支援欄位,因為它們可能不需要。例如,isEmpty 屬性就沒有支援欄位,因為每次存取時,其值都是從 size 屬性計算得出的:
val isEmpty: Boolean
get() = this.size == 0明確支援欄位
有時你可能需要更大的靈活性。例如,在某個 API 中,你希望能夠在內部修改屬性,但禁止從外部修改。在這種情況下,你可以使用明確支援欄位 (explicit backing field)。
在以下範例中,ShoppingCart 類別具有一個代表購物車中所有項目的 items 屬性。 該類別將 items 屬性公開為字串唯讀清單,但在內部透過明確支援欄位將資料儲存於可變清單中:
class ShoppingCart {
// 具有明確支援欄位的 public 唯讀檢視
val items: List<String>
field = mutableListOf()
fun addItem(item: String) {
items.add(item)
}
fun removeItem(item: String) {
items.remove(item)
}
}
fun main() {
val cart = ShoppingCart()
cart.addItem("Apple")
cart.addItem("Banana")
println(cart.items)
// [Apple, Banana]
cart.removeItem("Apple")
println(cart.items)
// [Banana]
}在此範例中,編譯器會從 mutableListOf() 呼叫推論支援欄位的型別:MutableList<String>。 你也可以明確宣告支援欄位的型別:
val items: List<String>
// 具有明確型別的明確支援欄位
field: MutableList<String> = mutableListOf()在 ShoppingCart 類別的範例中,編譯器會將 items 屬性智慧轉換為 MutableList<String> 型別,因此該 類別可以透過 add() 和 remove() 函式向購物車新增和移除項目。在類別外部,編譯器 會使用 public 屬性型別 List<String>,因此 API 使用者只能讀取 items 清單中的內容。
限制
若要使用明確支援欄位,其屬性以及支援欄位本身必須遵循特定規則。屬性 只有在符合以下條件時才能擁有明確支援欄位:
此外,支援欄位的型別必須是該屬性型別的子型別,並且具有 private 可見性。
你可以透過改用支援屬性來繞過這些限制。
支援屬性
如果明確支援欄位不符合你的使用案例,你可以嘗試使用稱為支援屬性 (backing property) 的編碼模式。
例如,當你的屬性需要自訂 getter 時:
class UserDirectory {
private val _users = mutableListOf(
"sarah",
"mike",
"emma"
)
val users: List<String>
get() = _users.sorted()
fun addUser(username: String) {
_users.add(username)
}
}
fun main() {
val directory = UserDirectory()
directory.addUser("alex")
println(directory.users)
// [alex, emma, mike, sarah]
}為支援屬性命名時請使用前導底線,以遵循 Kotlin 程式碼慣例。
在此範例中,UserDirectory 類別具有一個唯讀的 users 屬性,列出目錄中的每個使用者。 _users 變數是包含真實清單的 private 支援屬性。公開的 users 屬性的 getter 會在傳回項目之前對其進行排序。
編譯期常數
如果唯讀屬性的值在編譯期已知,請使用 const 修飾詞將其標記為編譯期常數。 編譯期常數會在編譯期內嵌,因此每個參照都會被替換為其常值。由於不需要呼叫 getter, 存取它們的效率更高:
// 檔案:AppConfig.kt
package com.example
// 編譯期常數
const val MAX_LOGIN_ATTEMPTS = 3編譯期常數必須符合以下需求:
編譯期常數仍然具有支援欄位,因此你可以使用反射與它們進行互動。
你也可以在註解中使用這些屬性:
const val SUBSYSTEM_DEPRECATED: String = "This subsystem is deprecated"
@Deprecated(SUBSYSTEM_DEPRECATED) fun processLegacyOrders() { ... }延遲初始化屬性與變數
通常,你必須在建構函式中初始化屬性。 然而,這並不總是方便的。例如,你可能會透過相依 注入或在單元測試的 setup 方法中初始化屬性。
為了處理這些情況,可以使用 lateinit 修飾詞標記該屬性:
public class OrderServiceTest {
lateinit var orderService: OrderService
@SetUp fun setup() {
orderService = OrderService()
}
@Test fun processesOrderSuccessfully() {
// 直接呼叫 orderService,無需檢查 null
// 或初始化
orderService.processOrder()
}
}你可以對宣告為以下形式的 var 屬性使用 lateinit 修飾詞:
- 頂層屬性。
- 區域變數。
- 類別主體內部的屬性。
對於類別屬性:
- 不能在主建構函數中宣告它們。
- 它們不能有自訂 getter 或 setter。
在所有情況下,該屬性或變數都必須是不可為 null 的,且不能是基本型別。
如果在初始化之前存取 lateinit 屬性,Kotlin 會擲出一個特定的例外,指出存取了未初始化的屬性:
class ReportGenerator {
lateinit var report: String
fun printReport() {
// 因在初始化之前存取而擲出例外
println(report)
}
}
fun main() {
val generator = ReportGenerator()
generator.printReport()
// Exception in thread "main" kotlin.UninitializedPropertyAccessException: lateinit property report has not been initialized
}若要檢查 lateinit var 是否已初始化,請在該屬性的參照上使用 isInitialized 屬性:
class WeatherStation {
lateinit var latestReading: String
fun printReading() {
// 檢查屬性是否已初始化
if (this::latestReading.isInitialized) {
println("Latest reading: $latestReading")
} else {
println("No reading available")
}
}
}
fun main() {
val station = WeatherStation()
station.printReading()
// No reading available
station.latestReading = "22°C, sunny"
station.printReading()
// Latest reading: 22°C, sunny
}只有在你的程式碼中已經可以存取該屬性時,才能對該屬性使用 isInitialized。該屬性必須宣告 在同一個類別、外層類別中,或是作為同一個檔案中的頂層屬性。
覆寫屬性
請參閱覆寫屬性。
委託屬性
為了重複使用邏輯並減少程式碼重複,你可以將取得與設定屬性的責任委託給 另一個物件。
委託存取子行為可以使屬性的存取子邏輯集中化,使其更容易重複使用。這種做法 在實作以下行為時非常有用:
- 延遲計算值。
- 透過指定的鍵從映射 (map) 中讀取。
- 存取資料庫。
- 當屬性被存取時通知監聽器。
你可以在程式庫中自行實作這些常見行為,或使用外部程式庫提供的現有委託。 如需更多資訊,請參閱委託屬性。
