関数の引数の名前指定
本連載は、Kotlinのバージョン1.1から2.0までのアップデート内容を、テーマごとにバージョン横断で紹介する連載です。今回は、関数をテーマに、その変更点を紹介していきます。まずは、関数の引数の名前指定に関するアップデートです。
Kotlinの関数の引数のデフォルト値
Kotlinには、関数という仕組みが存在します。JVM言語の大元となるJavaには関数がないので、関数はKotlinの大きな特徴のひとつと言えます。とはいえ、クラス内に記述しないだけで、その定義構文はメソッドと同じです。ただし、Javaにはない仕組みがいくつかあります。
まず、引数のデフォルト値を設定できます。例えば、リスト1のような関数定義です。
fun createLandmark(name: String, lat: Double = 0.0, lon: Double = 0.0, note: String = "") { : }
リスト1の関数createLandmark()には、name、lat、lon、noteの4個の引数が定義されており、そのうち、name以外には=で値が記述されています。この値が、引数のデフォルト値となり、デフォルト値が定義されている引数に関しては、関数呼出の際に引数を省略できるといった特徴があります。
例えば、リスト2の2行のcreateLandmark()の実行は、どちらも問題なく動作します。(1)ではすべての引数を渡している一方で、(2)では必須引数のnameのみを渡しています。その場合は、latとlonはともに0、noteは空文字("")として処理されます。
createLandmark("日本のへそ公園", 35.0, 135.0, "兵庫にある。") // (1) createLandmark("ナル島") // (2)
名前を指定して引数を渡す方法
Kotlinで関数を呼び出す際、名前を指定することもできます。その場合、引数の渡す順序は任意となり、定義順である必要がなくなります。例えば、リスト3の実行コードです。
createLandmark(note = "兵庫にある", name = "日本のへそ公園", lon = 135.0, lat = 35.0)
引数名を指定して引数を渡す関数実行は、引数が省略できる際に真価を発揮します。必要な引数のみを順序に関係なく渡せるのです。例えば、リスト4の実行コードです。このコードでは、必須引数の第1引数nameはともかく、第2引数と第4引数を省略して、第3引数のlonを渡しています。こういった飛び飛びの引数渡しは、名前を指定しない限りは不可能です。
createLandmark(name = "ポンティアナ", lon = 109.3)
定義順を保持したまま名前を指定
ここまで紹介した2種の引数の渡し方は、混在させることが可能です。すなわち、定義順に引数を渡しながら、名前を指定する方法です。例えば、リスト5のコードです。
createLandmark("アンタナナリボ", lat = -18.93, lon = 47.52, "マダガスカルの首都。") // (1) createLandmark("グリニッジ", lat = 51.477) // (2) createLandmark(name = "グリニッジ", 51.477) // (3)
リスト5では、(1)ですべての引数を定義順に渡しながら、latとlonだけ引数名を指定しています。こうすることで、どの値がどの引数かが一目瞭然です。もちろん、デフォルト値が指定されている場合は引数を省略できるので、(2)と(3)では、lonとnoteを省略して、第1引数nameと第2引数のlatのみを渡しています。
実は、これらのコードのうち(1)や(3)のコードが問題なく実行できるようになったのはバージョン1.4からです。それまでは、(2)のように「引数名を指定せずに引数を渡す場合は、最初に引数名を指定する引数よりも前のものでなければならない」といった決まりがありました。この制約に従うならば、リスト5の(1)は次のコードである必要がありました。1.4でこの制約がなくなりました。
createLandmark("アンタナナリボ", lat = -18.93, lon = 47.52, note = "マダガスカルの首都。")