Kotlinメモ: safe call (?.) や elvis operator (?:)、let で null をうまく扱う

2019-09-24

null を扱うさまざまな演算子・関数

Kotlin には、null をうまく扱うための便利な演算子や関数が用意されています。代表的なものに下記があります。

オブジェクト?.メソッド (safe call)
- オブジェクトが null でないならメソッドを呼び出す。null なら null を返す。
式1 ?: 式2 (Elvis operator)
- 式1が null でないならその値、null なら式2を評価する
オブジェクト!! (not-null assertion / unsafe dereference)
- nullable なオブジェクトを not-null なオブジェクトとして参照する。万が一 null だった場合は NullPoiterException が発生する。

使用例

オブジェクトが null じゃない場合のみメソッドを呼び出す／プロパティを参照する

logger?.log("Hello")

logger 変数が null でない場合のみ log() メソッドを実行します。 null の場合は何も行いません。

val label = book?.title

book 変数が null でない場合に title プロパティの値を取得します。 book 変数が null の場合は null が返されます。

オブジェクトが null だった場合にデフォルト値を設定／処理を打ち切る

val title = book?.title ?: "Unknown title"

book 変数が null でない場合は book.title の値を、null である場合は “Unknown title” を title に代入します。

book	book.title	結果
null	─	“Unknown title”
not null	null	“Unknown title”
not null	not null	book.title

下記も似たような使い方ですが、値が取得できないときにデフォルト値を設定する代わりに、return したり、例外を投げて処理を打ち切っています。

val title = book?.title ?: return
val title = book?.title ?: throw Error("Book must have a title")

オブジェクトが null のときに一連の処理を行う

val title = book.title ?: run {
    log("Could not display the book because of lack of title")
    return
}

あるオブジェクトやそのプロパティが null だった場合にのみ一連の処理を行いたい場合は、elvis operator (?:) と run を組み合わせて使用します。上記では、book は null でないことを想定していますが、book 自体が null であるケースも想定するのであれば、book?.title ?: run {} と、safe call を組み合わせれば OK です。

オブジェクトが null でないときに一連の処理を行う

// var book: Book? = null

book?.let {
    // let の中では it で non-null な book を参照できる
    println(it.title)
    println(it.author)
}

safe call (?.) と let 関数を組み合わせた safe call let と呼ばれているイディオムです。上記の例では、変数 book が null でない場合に book のプロパティを参照する処理を実行します。 book が null でない場合にメソッドを 1 つだけ呼び出したい場合は、単純に safe call で book?.foo() とすればよいのですが、上記のように連続してオブジェクトを参照したい場合や、そのオブジェクト自体をパラメータとして別の関数に渡したい場合などに利用します。別の関数のパラメータとして渡したい場合は次のように簡潔に記述することができます。

book?.let(display::showBookCover)

これは、下記のように記述するのと同じです。

book?.let { display.showBookCover(it) }

（コラム）let はラムダ式の評価結果を返すことに注意

let の戻り値の振る舞いをきちんと理解していないと、思わぬ不具合の元になります。次の safe call let イディオムを見てください。

book?.let(logger::printTitle) ?: logger.showError();

あるいは、下記でも同様。

book?.let { logger.printTitle(it) } ?: logger.showError();

このコードは、book が null でない場合に printTitle(book) を実行し、null である場合に showError() を実行するコードのように見えます。しかし、let() は実行したラムダ式の評価結果を返すため、printTitle(book) が null を返した場合にも showError() が実行されてしまいます。

この振る舞いはきっと意図したものとは異なります。素直に下記のように書くべきかもしれません。

if (book != null) {
    logger.printTitle(book)
} else {
    logger.showError()
}

2019-09-24