アンダースコアの使い方
次に紹介するのは、アンダースコア演算子です。
分割宣言における不要な変数を表すアンダースコア
Kotlinには、分割宣言(Destructuring Declarations)という仕組みがあります。これは、オブジェクトが保持しているデータをそれぞれの変数に分割して代入するコードをまとめて記述できる仕組みです。例えば、名前と身長と体重を保持するデータクラスとしてBMIDataがあるとします。これはリスト6のようなコードとなります。
data class BMIData( val name: String, val weight: Double, val height: Double )
そして、そのBMIDataを引数として計算されたBMI値を表示するprintBMI()関数があるとします。すると関数内では、リスト7のように引数のbmiDataからそれぞれのデータを取得する必要があります。
fun printBMI(bmiData: BMIData) { val weight = bmiData.weight val height = bmiData.height val name = bmiData.name : }
このように、複数のデータがひとまとまりとなったオブジェクト(リスト7ではBMIDataオブジェクト)からそれぞれの値を取り出して変数に格納する場合、それぞれのデータごとに記述するのではなく、リスト8のようにまとめて記述することができます。これを、分割宣言(Destructuring Declarations)と言います。
fun printBMI(bmiData: BMIData) { val (name, weight, height) = bmiData : }
ここでname変数が不要の場合には、次のコードを記述してはダメです。
val (weight, height) = bmiData
この場合、nameの値が変数weightとして、weightの値が変数heightとして格納されてしまいます。このような事態を避けるために、分割宣言において不要な変数にアンダースコアが利用できるように、バージョン1.1でアップデートされました。この仕組みを利用すると、次のコードとなります。
val (_, weight, height) = bmiData
ラムダ式での不要な引数に利用できるアンダースコア
同じくバージョン1.1で導入されたアンダースコアの別の使い方が、ラムダ式での不要な引数への記述です。例えば、果物のidと名前が格納されたMutableMapオブジェクトであるfruitListがあるとして、forEach()メソッドを使ってループ処理させたいとします。その場合、forEach()メソッドの引数ラムダ式はリスト9のようなコードになります。
fruitList.forEach { (id, name)-> : }
MutableMapのforEach()メソッドのラムダ式の引数は、第1引数がキーを第2引数が値を格納するものを定義する必要があります。リスト9では、それぞれidとnameとしています。ここで、もし、第1引数であるidがラムダ式内で不要とした場合、idの代わりにアンダースコアを記述し、次のようなコードとすることができます。
fruitList.forEach { (_, name)-> : }
ジェネリクスの型推論に利用できるアンダースコア
バージョン1.1以降、このように利用されてきたアンダースコアが、バージョン1.7でさらにアップデートされ、ジェネリクスでの型推論に利用できるようになりました。例えば、リスト10のようなMutableMapデータがあるとします。
val taro = mutableMapOf<String, Any>( "name" to "田中太郎", "weight" to 67.2, "height" to 172.4, "age" to 35, )
JavaScriptのオブジェクトリテラルのような使い方をしたMutableMapデータのため、キーは文字列型で固定となっていますが、値に関しては、さまざまなデータ型が混在しています。このようなMutableMapデータから特定のデータ型のものでだけを抽出する関数として、mapFilterByValueType()を用意したとします。これは、リスト11のようなコードとなります。
inline fun <K, reified V> mapFilterByValueType(map: MutableMap<K, Any>): MutableMap<K, V> { val newMap = mutableMapOf<K, V>() map.forEach { (key, value) -> if(value is V) { // (*) newMap[key] = value } } return newMap }
この関数の特徴は、その関数シグネチャのジェネリクスにもあるように、引数のMutableMapのデータ型は<K, Any>である一方で、関数を利用する際にジェネリクスに、抽出する値のデータ型をVとして指定する点です。関数内のコードは、引数のmapをループ処理しながら、値のデータ型Vに合致するもののみを抽出するコードとなっています。
そして、この関数をリスト10のtaroに適用して、Double型のみの値を抽出する場合は、次のコードを記述するのが通常でした。
val doubleOfTaro = mapFilterByValueType<String, Double>(taro)
ところが、リスト11の関数定義を見てもわかるように、関数を利用する際のキーのデータ型は、引数のmapのキーのデータ型と同じKです。すると、引数として渡されるtaroのキーから関数利用のキーのデータ型は推論でき、わざわざStringと指定する必要がありません。このような場合、次のようにアンダースコアを利用して型推論を行うように、バージョン1.7でアップデートされました。
val doubleOfTaro = mapFilterByValueType<_, Double>(taro)
[NOTE]reified
リスト11の関数シグネチャのジェネリクスでは、<K, reified V>のように、型パラメータVにreifiedキーワードが使われています。このreifiedは、関数内でその型パラメータを判定などで利用する場合には付与しておく必要があります。例えば、(*)では「valueのデータ型がV」という条件でデータ型パラメータVを利用しています。そのため、型パラメータVにreifiedが付与されています。また、このreifiedを利用する関数は、inline関数である必要もあります。