屬性(Property)與域(Field)

宣告屬性

Kotlin 中的類可以擁有屬性. 可以使用 var 關鍵字宣告為可變(mutable)屬性, 也可以使用 val 關鍵字宣告為只讀屬性.

public class Address { 
  public var name: String = ...
  public var street: String = ...
  public var city: String = ...
  public var state: String? = ...
  public var zip: String = ...
}

使用屬性時, 只需要簡單地通過屬性名來參照它, 和使用 Java 中的域變數(field)一樣:

fun copyAddress(address: Address): Address {
  val result = Address() // Kotlin 中沒有 'new' 關鍵字
  result.name = address.name // 將會呼叫屬性的訪問器方法
  result.street = address.street
  // ...
  return result
}

取值方法(Getter)與設值方法(Setter)

宣告屬性的完整語法是:

var <propertyName>: <PropertyType> [= <property_initializer
 
>]
  [<getter>]
  [<setter>]

其中的初始化器(initializer), 取值方法(getter), 以及設值方法(setter)都是可選的. 如果屬性型別可以通過初始化器自動推斷得到, 或者可以通過這個屬性覆蓋的基類成員屬性推斷得到, 則屬性型別的宣告也可以省略.

示例:

var allByDefault: Int? // 錯誤: 需要明確指定初始化器, 此處會隱含地使用預設的取值方法和設值方法
var initialized = 1 // 屬性型別為 Int, 使用預設的取值方法和設值方法

只讀屬性宣告的完整語法與可變屬性有兩點不同: 由 val

val simple: Int? // 屬性型別為 Int, 使用預設的取值方法, 屬性值必須在構造器中初始化
val inferredType = 1 // 屬性型別為 Int, 使用預設的取值方法

我們可以編寫自定義的訪問方法, 與普通的函式很類似, 訪問方法的位置就在屬性定義體之內. 下面是一個自定義取值方法的示例:

val isEmpty: Boolean
  get() = this.size == 0

自定義設值方法的示例如下:

var stringRepresentation: String
  get() = this.toString()
  set(value) {
    setDataFromString(value) // 解析字串內容, 並將解析得到的值賦給對應的其他屬性
  }

Kotlin 的程式設計慣例是, 設值方法的引數名稱為 value, 但如果你喜歡, 也可以選擇使用不同的名稱.

如果你需要改變屬性訪問方法的可見度, 或者需要對其添加註解, 但又不需要修改它的預設實現, 你可以定義這個方法, 但不定義它的實現體:

var setterVisibility: String = "abc"
  private set // 設值方法的可見度為 private, 並使用預設實現

var setterWithAnnotation: Any? = null
  @Inject set // 對設值方法新增 Inject 註解

屬性的後端域變數(Backing Field)

Kotlin 的類不能擁有域變數. 但是, 使用屬性的自定義訪問器時, 有時會需要後端域變數(backing field). 為了這種目的, Kotlin 提供了一種自動的後端域變數, 可以通過 field 識別符號來訪問:

var counter = 0 // 初始化給定的值將直接寫入後端域變數中
  set(value) {
    if (value >= 0)
      field = value
  }

field 識別符號只允許在屬性的訪問器函式內使用.

如果屬性 get/set 方法中的任何一個使用了預設實現, 或者在 get/set 方法的自定義實現中通過 field 識別符號訪問屬性, 那麼編譯器就會為屬性自動生成後端域變數.

比如, 下面的情況不會存在後端域變數:

val isEmpty: Boolean
  get() = this.size == 0

後端屬性(Backing Property)

如果你希望實現的功能無法通過這種 “隱含的後端域變數” 方案來解決, 你可以使用 後端屬性(backing property) 作為替代方案:

private var _table: Map<String, Int>? = null
public val table: Map<String, Int>
  get() {
    if (_table == null)
      _table = HashMap() // 型別引數可以自動推斷得到, 不必指定
    return _table ?: throw AssertionError("Set to null by another thread")
  }

不管從哪方面看, 這種方案都與 Java 中完全相同, 因為後端私有屬性的取值方法與設值方法都使用預設實現, 我們對這個屬性的訪問將被編譯器優化, 變為直接讀寫後端域變數, 因此不會發生不必要的函式呼叫, 導致效能損失.

編譯期常數值

如果屬性值在編譯期間就能確定, 則可以使用 const 修飾符, 將屬性標記為_編譯期常數值(compile time constants)_. 這類屬性必須滿足以下所有條件:

• 必須是頂級屬性, 或者是一個 object 的成員
• 值被初始化為 String 型別, 或基本型別(primitive type)
• 不存在自定義的取值方法

這類屬性可以用在註解內:

const val SUBSYSTEM_DEPRECATED: String = "This subsystem is deprecated"

@Deprecated(SUBSYSTEM_DEPRECATED) fun foo() { ... }

延遲初始化屬性(Late-Initialized Property)

通常, 如果屬性宣告為非 null 資料型別, 那麼屬性值必須在構造器內初始化. 但是, 這種限制很多時候會帶來一些不便. 比如, 屬性值可以通過依賴注入來進行初始化, 或者在單元測試程式碼的 setup 方法中初始化. 這種情況下, 你就無法在構造器中為屬性編寫一段非 null 值的初始化程式碼, 但你仍然希望在類內參照這個屬性時能夠避免 null 值檢查.

要解決這個問題, 你可以為屬性新增一個 lateinit 修飾符:

public class MyTest {
    lateinit var subject: TestSubject

    @SetUp fun setup() {
        subject = TestSubject()
    }

    @Test fun test() {
        subject.method()  // 直接訪問屬性
    }
}

這個修飾符只能用於 var 屬性, 而且只能是宣告在類主體部分之內的屬性(不可以是主構造器中宣告的屬性), 而且屬性不能有自定義的取值方法和設值方法. 屬性型別必須是非 null 的, 而且不能是基本型別.

在一個 lateinit 屬性被初始化之前訪問它, 會丟擲一個特別的異常, 這個異常將會指明被訪問的屬性, 以及它沒有被初始化這一錯誤.

屬性的覆蓋

參見 成員的覆蓋

委託屬性(Delegated Property)

最常見的屬性只是簡單地讀取(也有可能會寫入)一個後端域變數. 但是, 通過使用自定義的取值方法和設值方法, 我們可以實現屬性任意複雜的行為. 在這兩種極端情況之間, 還存在一些非常常見的屬性工作模式. 比如: 屬性值的延遲載入, 通過指定的鍵值(key)從 map 中讀取資料, 訪問資料庫, 屬性被訪問時通知監聽器, 等等.