イディオム

Kotlinで頻繁に使用される、さまざまなイディオムのコレクションです。お気に入りのイディオムがあれば、プルリクエストを送って貢献してください。

DTO (POJO/POCO) の作成

data class Customer(val name: String, val email: String)

上記のコードは、以下の機能を持つCustomerクラスを提供します:

• すべてのプロパティに対するゲッター (およびvarの場合のセッター)
• equals()
• hashCode()
• toString()
• copy()
• すべてのプロパティに対するcomponent1()、component2()など (「データクラス」を参照)

関数パラメータのデフォルト値

fun foo(a: Int = 0, b: String = "") { ... }

リストのフィルタリング

val positives = list.filter { x -> x > 0 }

または、さらに短く書くこともできます:

val positives = list.filter { it > 0 }

JavaとKotlinのフィルタリングの違いについて学習してください。

コレクション内の要素の存在チェック

if ("[email protected]" in emailsList) { ... }

if ("[email protected]" !in emailsList) { ... }

文字列補間

println("Name $name")

JavaとKotlinの文字列結合の違いについて学習してください。

標準入力の安全な読み込み

// 文字列を読み込み、入力が整数に変換できない場合はnullを返します。例: Hi there!
val wrongInt = readln().toIntOrNull()
println(wrongInt)
// null

// 整数に変換できる文字列を読み込み、整数を返します。例: 13
val correctInt = readln().toIntOrNull()
println(correctInt)
// 13

詳細については、「標準入力の読み込み」を参照してください。

インスタンスチェック

when (x) {
    is Foo -> ...
    is Bar -> ...
    else   -> ...
}

読み取り専用リスト

val list = listOf("a", "b", "c")

読み取り専用マップ

val map = mapOf("a" to 1, "b" to 2, "c" to 3)

マップエントリへのアクセス

println(map["key"])
map["key"] = value

マップまたはペアのリストの走査

for ((k, v) in map) {
    println("$k -> $v")
}

kとvは、nameやageなど、任意の便利な名前にすることができます。

範囲の反復処理

for (i in 1..100) { ... }  // 終端を含む範囲: 100を含む
for (i in 1..<100) { ... } // 終端を含まない範囲: 100を含まない
for (x in 2..10 step 2) { ... }
for (x in 10 downTo 1) { ... }
(1..10).forEach { ... }

遅延プロパティ

val p: String by lazy { // 値は最初のアクセス時にのみ計算されます
    // compute the string
}

拡張関数

fun String.spaceToCamelCase() { ... }

"Convert this to camelcase".spaceToCamelCase()

シングルトンの作成

object Resource {
    val name = "Name"
}

型安全な値のためのインライン値クラスの使用

@JvmInline
value class EmployeeId(private val id: String)

@JvmInline
value class CustomerId(private val id: String)

誤ってEmployeeIdとCustomerIdを混同した場合、コンパイルエラーが発生します。

@JvmInlineアノテーションはJVMバックエンドでのみ必要です。

抽象クラスのインスタンス化

abstract class MyAbstractClass {
    abstract fun doSomething()
    abstract fun sleep()
}

fun main() {
    val myObject = object : MyAbstractClass() {
        override fun doSomething() {
            // ...
        }

        override fun sleep() { // ...
        }
    }
    myObject.doSomething()
}

nullでない場合の省略記法

val files = File("Test").listFiles()

println(files?.size) // filesがnullでない場合、サイズが出力されます

nullでない場合またはnullの場合の省略記法

val files = File("Test").listFiles()

// 単純なフォールバック値の場合:
println(files?.size ?: "empty") // filesがnullの場合、"empty"が出力されます

// コードブロックでより複雑なフォールバック値を計算するには、`run`を使用します
val filesSize = files?.size ?: run { 
    val someSize = getSomeSize()
    someSize * 2
}
println(filesSize)

nullの場合に式を実行

val values = ...
val email = values["email"] ?: throw IllegalStateException("Email is missing!")

空の可能性があるコレクションの最初のアイテムの取得

val emails = ... // 空の可能性がある
val mainEmail = emails.firstOrNull() ?: ""

JavaとKotlinで空の可能性があるコレクションの最初のアイテムを取得する方法の違いについて学習してください。

nullでない場合に実行

val value = ...

value?.let {
    ... // nullでない場合にこのブロックを実行
}

nullでない場合にnullableな値をマッピング

val value = ...

val mapped = value?.let { transformValue(it) } ?: defaultValue 
// valueまたは変換結果がnullの場合、defaultValueが返されます。

when文でのreturn

fun transform(color: String): Int {
    return when (color) {
        "Red" -> 0
        "Green" -> 1
        "Blue" -> 2
        else -> throw IllegalArgumentException("Invalid color param value")
    }
}

try-catch式

fun test() {
    val result = try {
        count()
    } catch (e: ArithmeticException) {
        throw IllegalStateException(e)
    }

    // Working with result
}

if式

val y = if (x == 1) {
    "one"
} else if (x == 2) {
    "two"
} else {
    "other"
}

Unitを返すメソッドのビルダー形式の使用法

fun arrayOfMinusOnes(size: Int): IntArray {
    return IntArray(size).apply { fill(-1) }
}

単一式関数

fun theAnswer() = 42

これは以下と同等です:

fun theAnswer(): Int {
    return 42
}

これは他のイディオムと効果的に組み合わせることで、より短いコードになります。例えば、when式と組み合わせる場合:

fun transform(color: String): Int = when (color) {
    "Red" -> 0
    "Green" -> 1
    "Blue" -> 2
    else -> throw IllegalArgumentException("Invalid color param value")
}

オブジェクトインスタンス上の複数のメソッドの呼び出し (with)

class Turtle {
    fun penDown()
    fun penUp()
    fun turn(degrees: Double)
    fun forward(pixels: Double)
}

val myTurtle = Turtle()
with(myTurtle) { //100ピクセルの四角形を描画
    penDown()
    for (i in 1..4) {
        forward(100.0)
        turn(90.0)
    }
    penUp()
}

オブジェクトのプロパティの構成 (apply)

val myRectangle = Rectangle().apply {
    length = 4
    breadth = 5
    color = 0xFAFAFA
}

これは、オブジェクトのコンストラクタにないプロパティを設定する際に便利です。

Java 7のtry-with-resources

val stream = Files.newInputStream(Paths.get("/some/file.txt"))
stream.buffered().reader().use { reader ->
    println(reader.readText())
}

ジェネリック型情報を必要とするジェネリック関数

//  public final class Gson {
//     ...
//     public <T> T fromJson(JsonElement json, Class<T> classOfT) throws JsonSyntaxException {
//     ...

inline fun <reified T: Any> Gson.fromJson(json: JsonElement): T = this.fromJson(json, T::class.java)

2つの変数の交換

var a = 1
var b = 2
a = b.also { b = a }

未完了コードのマーク付け (TODO)

Kotlinの標準ライブラリには、常にNotImplementedErrorをスローするTODO()関数があります。 その戻り値の型はNothingであるため、期待される型に関わらず使用できます。 理由パラメータを受け入れるオーバーロードもあります:

fun calcTaxes(): BigDecimal = TODO("Waiting for feedback from accounting")

IntelliJ IDEAのKotlinプラグインはTODO()のセマンティクスを理解しており、TODOツールウィンドウにコードポインタを自動的に追加します。

次のステップ

• イディオム的なKotlinスタイルを使用してAdvent of Codeのパズルを解く。
• JavaとKotlinで文字列の一般的なタスクを実行する方法を学ぶ。
• JavaとKotlinでコレクションの一般的なタスクを実行する方法を学ぶ。
• JavaとKotlinでnull可能性を扱う方法を学ぶ。