第３５回：Delegates example

はじめに

公式の問題集「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
  • 第３４回：Lazy property

問題

Delegates example

デリゲートプロパティについて学び、デリゲートを使ってプロパティを遅延させます。

修正前コード.kt

class LazyProperty(val initializer: () -> Int) {
    val lazyValue: Int by TODO()
}

問題のポイント

一般的なプロパティの中には、必要な都度手動で実装してもよいものがありますが、一度実装してライブラリに追加し、後で再利用する方が便利です。例えば

• レイジープロパティ：最初のアクセス時のみ値が計算される。
• Observableプロパティ：このプロパティの変更についてリスナーに通知される。
• 各プロパティに対して個別のフィールドを用意するのではなく、マップにプロパティを格納する。

これらの（そして他の）ケースをカバーするために、Kotlinはデリゲートプロパティをサポートしています。

class Example {
    var p: String by Delegate()
}

構文としては、val/var <プロパティ名>:<Type> by <expression>です。
byの後の式はデリゲートです。なぜなら、プロパティに対応するget()とset()は、そのgetValue()とsetValue()メソッドにデリゲートされることになるからです。
プロパティのデリゲートはインターフェースを実装する必要はありませんが、getValue()（varsの場合はsetValue()）を提供する必要があります。

import kotlin.reflect.KProperty

class Delegate {
    operator fun getValue(thisRef: Any?, property: KProperty<*>): String {
        return "$thisRef, thank you for delegating '${property.name}' to me!"
    }

    operator fun setValue(thisRef: Any?, property: KProperty<*>, value: String) {
        println("$value has been assigned to '${property.name}' in $thisRef.")
    }
}

Delegateのインスタンスに委譲されたpから読み込むとき、DelegateのgetValue()関数が呼び出されます。
その第一引数にはpを読み込んだオブジェクトが、第二引数にはp自身の説明（例えば、名前を取る）が入ります。

val e = Example()
println(e.p) // Example@33a17727, thank you for delegating 'p' to me!

同様に、pに代入する場合は、setValue()関数が呼び出されます。
最初の2つのパラメータは同じもので、3つ目のパラメータには代入される値が格納されます。

e.p = "NEW"
// NEW has been assigned to 'p' in Example@33a17727.

Lazy properties

Kotlinの標準ライブラリは、いくつかの便利な種類のデリゲートのためのファクトリーメソッドを提供します。
lazy() はラムダを受け取り、Lazy のインスタンスを返す関数で、遅延プロパティを実装するためのデリゲートとして使用することができます。
get() の最初の呼び出しは、lazy() に渡されたラムダを実行し、その結果を記憶しています。それ以降の get() の呼び出しは、単に記憶された結果を返します。

val lazyValue: String by lazy {
    println("computed!")
    "Hello"
}

fun main() {
    println(lazyValue)
    println(lazyValue)
}
// computed!
// Hello
// Hello

解答例

class LazyProperty(val initializer: () -> Int) {
    val lazyValue: Int by lazy(initializer)
}