Kotlin最新アップデートまとめ ──委譲プロパティやインラインクラスに関するアップデート

【最新Kotlinアップデート解説】バージョン1.1からの変更点総まとめ　第4回

　本連載は、Kotlinのバージョン1.1から2.0までのアップデート内容を、テーマごとにバージョン横断で紹介する連載です。前回と今回は、クラスやインターフェースに関する変更点を紹介しています。前回は、sealedやdata、および、プロパティに関する変更点を紹介しました。今回は、委譲プロパティとインラインクラスに関する変更点を紹介します。

委譲プロパティに関する変更点（1）

　本連載は、Kotlinのバージョン1.1から2.0までのアップデート内容を、テーマごとにバージョン横断で紹介する連載です。前回と今回は、クラスやインターフェース、オブジェクトに関する変更点を紹介しています。そのうち、今回の最初に紹介するのは「委譲プロパティ」に関する変更点です。

委譲プロパティとは

　委譲プロパティ（Delegated Properties）とは、そのアクセサ、すなわちデータ本体の生成、格納処理を再利用するための仕組みです。

　例えば、リスト1の（3）のコードです。

［リスト1］委譲プロパティの例

class EntryData {
  var entryCode: String? = null  // (1)
  @Deprecated("非推奨です。代わりにentryCodeを利用してください。")  // (2)
  var code by this::entryCode  // (3)
}

　リスト1の（3）では、通常のプロパティ宣言に続けてbyキーワードが見られます。このbyの次に記述したものが委譲先（英語ではa delegate）となり、委譲元のプロパティは委譲先と同内容となります。

　リスト1の（3）では、this::entryCodeという記述になっており、これは（1）のプロパティentryCodeのことを表します。結果、codeプロパティは、entryCodeと同一の内容となります。

　実際に、次のコードでcodeに代入した値である「A338」は、そのままentryCodeの値となります。逆も然りです。

val entryData = EntryData()
entryData.code = "A338"

　委譲プロパティの活用方法のひとつは、リスト1のようにあるプロパティを非推奨としたい場合です。リスト1の（2）にあるように、codeプロパティを非推奨とし、@Deprecatedアノテーションを付与しています。とはいえ、そのcodeプロパティが利用されても正しく動作するように、その内容を新しいプロパティであるentryCodeと同一するように委譲を利用しています。

他のプロパティを委譲先とする場合の記述方法

　このように、他のプロパティをそのまま自分のプロパティと同一とする、つまり、委譲する場合は、委譲先が（1）トップレベルプロパティ、（2）自クラス内の他のプロパティ、（3）他のクラスのプロパティによってbyの次の記述方法がリスト2のように変わります。

［リスト2］他のプロパティを委譲先とするコードパターン

var delegatedFromTopCode by ::topCode  // (1)
var delegatedFromSameCode by this::sameClassCode  // (2)
var delegatedFromOtherClass by otherClass::otherClassCode  // (3)

　トップレベルプロパティの場合は、（1）のように::プロパティ名の前に何も記述しません。自クラスの他のプロパティの場合は（2）のようにthisを、他のクラスのプロパティの場合は（3）のようにそのクラスのインスタンス変数を記述します。

委譲先としてアクセサを自作する場合

　実は、このように他のプロパティを委譲先とする仕組みは、バージョン1.4で導入された仕組みです。それまでは、委譲先としてアクセサが定義されたクラスを自作する必要がありました。

　例えば、リスト3のコードです。

［リスト3］委譲先クラスの例

class ConnectionFactory<Owner> {  // (1)
  operator fun getValue(thisRef: Owner, property: KProperty<*>): Connection {  // (2)
    connectionの生成処理
    return connection
  }
}

　リスト3は、データベースなどのデータソースへの接続オブジェクト（Connectionオブジェクト）プロパティの委譲先となるクラスです。クラス名はConnectionFactoryとしていますが、なんでもかまいません。

　そのクラスの中で、getValue()演算子とsetValue()演算子をオーバーライドします。ただし、委譲元プロパティとしてvalプロパティを想定している場合は、setValue()演算子の定義は不要です。リスト3では、委譲元であるConnectionプロパティはvalプロパティを想定しているので、（2）のようにgetValue()演算子のみオーバーライドしています。なお、演算子のオーバーライドなので、必ずoperatorキーワードを記述しておく必要があります。

　getValue()演算子とsetValue()演算子のそれぞれの引数と戻り値を表1にまとめておきます。なお、表1のデータ型Ownerは、委譲元プロパティが所属するクラス、もしくはそのスーパークラスであり、Vは委譲元プロパティのデータ型そのものです。

表1：getValue()とsetValue()の引数と戻り値

演算子	引数	戻り値
getValue()	thisRef: Owner 委譲元プロパティが所属するインスタンス property: KProperty<*> プロパティのメタデータ	生成されたプロパティの本体
setValue()	thisRef: Owner 委譲元プロパティが所属するインスタンス property: KProperty<*> プロパティのメタデータ value: V セットするプロパティの値	なし

　リスト3のデータ型Ownerに関して補足しておくと、そもそも委譲元プロパティが所属するクラスが何かは、このConnectionFactoryからは把握できません。

　そこで（1）のようにクラス宣言のジェネリクスとして定義しておきます。こうすることで、このクラスを利用する際に自動的にデータ型が渡ってくることになります。

　そういった利用コードは、リスト4のようになります。byの次にConnectionFactoryのインスタンス生成コードを記述するだけです。ジェネリクスの記述も不要です。このコードだけで、_connectionプロパティを呼び出すたびに、リスト3の（2）のgetValue()が実行されて、Connectionオブジェクトが生成、リターンされ、_connectionプロパティに格納されるようになります。

［リスト4］ConnectionFactoryを委譲先とするコード例

class DataProvider {
  private val _connection: Connection by ConnectionFactory()
    :
}

［NOTE］標準ライブラリ中の委譲先

　Kotlinには、Delegates.observable()とDelegates.vetoable()、lazy()という委譲先が標準ライブラリとして用意されています。誌面の都合上詳細は割愛しますが、Delegates.observable()はプロパティにデータが格納された直後に処理を実行したい場合、Delegates.vetoable()は同様に直前に処理を実行したい場合、lazy()はプロパティの本体データの生成をプロパティが利用される段階まで遅らせることができるものです。