Edit Page

イディオム

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の違いを学ぶには、 JavaとKotlinのフィルタリングを参照のこと。

コレクションの中に要素があるかの確認

if ("john@example.com" in emailsList) { ... }

if ("jane@example.com" !in emailsList) { ... }

文字列補完

println("Name $name")

JavaとKotlinの違いを学ぶには、 JavaとKotlinの文字列の連結を参照のこと。

インスタンスのチェック

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)

mapのエントリへのアクセス

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

mapやlistのペアを巡回する

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

k, vはどんな名前でも構いません。たとえば nameage とかでもOK。

範囲の反復

for (i in 1..100) { ... }  // 右閉区間: 100を含む
for (i in 1..<100) { ... } // 右開区間のrange: 100を含まない
for (x in 2..10 step 2) { ... }
for (x in 10 downTo 1) { ... }
(1..10).forEach { ... }

遅延評価プロパティ

val p: String by lazy { // 値は最初のアクセスの時だけ計算される
    // 文字列を計算
}

拡張関数(extension functions)

fun String.spaceToCamelCase() { ... }

"Convert this to camelcase".spaceToCamelCase()

シングルトンの作成

object Resource {
    val name = "Name"
}

abstract classのインスタンシエート

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

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

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

if not nullの省略記法

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

println(files?.size) // filesがnullで無ければサイズが出力される

if-not-null-elseの省略記法

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)

if null文の実行

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

空かもしれないコレクションから最初の要素を取る

val emails = ... // 空かもしれないコレクション
val mainEmail = emails.firstOrNull() ?: ""

if not null文の実行

val data = ...

data?.let {
    ... // nullでなければこのブロックを実行する
}

nullableな値がnullでない時だけ変換

val value = ...

val mapped = value?.let { transformValue(it) } ?: defaultValue 
// valueかtransformValueの結果が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)
    }

    // 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) { // 100pxの四角形を描く
    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)

NullableなBoolean

val b: Boolean? = ...
if (b == true) {
    ...
} else {
    // `b`はfalseかnull
}

2つの値のスワップ

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

コードが未完成だとマークする(TODO)

Kotlinの標準ライブラリにはTODO()関数があり、これはいつもNotImplementedErrorをthrowします。 戻りの型はNothingなので、どのような型が期待される所でも使用出来ます。 また、理由を示す引数を受け取るオーバーロード版もあります。

fun calcTaxes(): BigDecimal = TODO("会計部からのフィードバック待ち")

IntelliJ IDEAのkotlinプラグインはTODO()の意味を理解し、TODOツールウィンドウに自動的にコードの位置を追加してくれます。

この次は?