Kotlin KoansでKotlin入門 第３３回：Properties

はじめに

公式の問題集「Kotlin Koans」を解きながらKotlinを学習します。

過去記事はこちら

• Introduction
  • 第０回：Kotlin Koansについて
  • 第１回：Simple Functions
  • 第２回：Named arguments
  • 第３回：Default arguments
  • 第４回：Triple-quoted strings
  • 第５回：String templates
  • 第６回：Nullable types
  • 第７回：Nothing type
  • 第８回：Lambdas
• Classes
  • 第９回：Data classes
  • 第１０回：Smart casts
  • 第１１回：Sealed classes
  • 第１２回：Rename on import
  • 第１３回：Extension functions
• Conventions
  • 第１４回：Comparison
  • 第１５回：Ranges
  • 第１６回：For loop
  • 第１７回：Operators overloading
  • 第１８回：Invoke
• Collections
  • 第１９回：Collections Introduction
  • 第２０回：Sort
  • 第２１回：Filter map
  • 第２２回：All, Any, and other predicates
  • 第２３回：Associate
  • 第２４回：Group By
  • 第２５回：Partition
  • 第２６回：FlatMap
  • 第２７回：Max min
  • 第２８回：Sum
  • 第２９回：Fold
  • 第３０回：Compound tasks
  • 第３１回：Sequences
  • 第３２回：Getting used to the new style

問題

Properties

Propertiesについて学びます。
PropertyWithCounterが割り当てられるたびにカウンタ・プロパティがインクリメントされるように、PropertyExample.propertyWithCounterにカスタム・セッターを追加してください。

修正前コード.kt

class PropertyExample() {
    var counter = 0
    var propertyWithCounter: Int? = null
        set
}

問題のポイント

Kotlinのクラスのプロパティは、varキーワードでmutableとして、またはvalキーワードでread-onlyとして宣言することができます。プロパティを使用するには、単にその名前で参照します。

fun copyAddress(address: Address): Address {
    val result = Address() // there's no 'new' keyword in Kotlin
    result.name = address.name // accessors are called
    result.street = address.street
    // ...
    return result
}

プロパティに対してカスタムアクセサを定義することができます。カスタムゲッターを定義すると、そのプロパティにアクセスするたびに呼び出されます（この方法で、コンピューテッドプロパティを実装することができます）。
以下は、カスタムゲッターの例です。

class Rectangle(val width: Int, val height: Int) {
    val area: Int // ゲッターの戻り値の型から推測できるので、プロパティの型は任意
        get() = this.width * this.height
}
// Width=3, height=4, area=12

カスタム・セッターを定義すると、プロパティに値を代入するたびに、初期化を除いて、そのセッターが呼び出されます。カスタム・セッターは次のようなものです。

var stringRepresentation: String
    get() = this.toString()
    set(value) {
        setDataFromString(value) // 文字列を解析し、他のプロパティに値を代入
    }

Backing fields

Kotlinでは、フィールドはプロパティの一部としてのみ使用され、その値をメモリ内に保持します。
フィールドを直接宣言することはできません。
しかし、プロパティがバッキングフィールドを必要とするとき、Kotlinは自動的にそれを提供します。
このバッキングフィールドはfield識別子を用いてアクセサで参照することができます。

var counter = 0 // イニシャライザはバッキングフィールドを直接割り当てます。
    set(value) {
        if (value >= 0)
            field = value
            // counter = value // 実際の名前 'counter' を使用するとエラー
    }

field識別子は、プロパティのアクセッサにおいてのみ使用することができます。

バッキングフィールドは、そのプロパティが少なくともひとつのアクセサのデフォルト実装を使用しているか、カスタムアクセッサがfield識別子を通じてそれを参照している場合に、そのプロパティに対して生成されます。

たとえば、次のような場合はバッキングフィールドは発生しません。

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

解答例

class PropertyExample() {
    var counter = 0
    var propertyWithCounter: Int? = null
        set(value) {
            field = value
            counter++
        }
}