JavaとKotlinにおけるヌル可能性

ヌル可能性 とは、変数がnull値を保持できる能力のことです。 変数がnullを含む場合、その変数を逆参照しようとするとNullPointerExceptionが発生します。 ヌルポインタ例外が発生する可能性を最小限に抑えるために、コードを書く方法はたくさんあります。

このガイドでは、JavaとKotlinにおけるヌル許容変数（nullになりうる変数）の扱い方の違いを説明します。 これは、JavaからKotlinへ移行し、本格的なKotlinスタイルでコードを書くのに役立ちます。

このガイドの最初の部分では、最も重要な違いであるKotlinにおけるヌル許容型のサポートと、 KotlinがJavaコードの型をどのように処理するかについて説明します。2番目の部分では、 関数呼び出しの結果の確認から始まり、いくつかの具体的なケースを検証して、特定の相違点を説明します。

Kotlinのヌル安全性についてさらに学ぶ。

ヌル許容型のサポート

KotlinとJavaの型システムにおける最も重要な違いは、Kotlinがヌル許容型を明示的にサポートしている点です。 これは、どの変数がnull値を保持できる可能性があるかを示す方法です。 変数がnullになりうる場合、その変数に対してメソッドを呼び出すのは安全ではありません。NullPointerExceptionを引き起こす可能性があるためです。 Kotlinはコンパイル時にそのような呼び出しを禁止し、これにより多くの潜在的な例外を防ぎます。 実行時には、ヌル許容型のオブジェクトと非ヌル許容型のオブジェクトは同じように扱われます。 ヌル許容型は非ヌル許容型のラッパーではありません。すべてのチェックはコンパイル時に実行されます。 これは、Kotlinでヌル許容型を扱う際の実行時オーバーヘッドがほとんどないことを意味します。

NOTE

「ほとんど」と述べているのは、組み込みチェックが生成されるものの、

そのオーバーヘッドはごくわずかだからです。

Javaでは、ヌルチェックを書かない場合、メソッドはNullPointerExceptionをスローする可能性があります。

// Java
int stringLength(String a) {
    return a.length();
}

void main() {
    stringLength(null); // Throws a `NullPointerException`
}

この呼び出しは以下の出力を持ちます。

java.lang.NullPointerException: Cannot invoke "String.length()" because "a" is null
    at test.java.Nullability.stringLength(Nullability.java:8)
    at test.java.Nullability.main(Nullability.java:12)
    at java.base/java.util.ArrayList.forEach(ArrayList.java:1511)
    at java.base/java.util.ArrayList.forEach(ArrayList.java:1511)

Kotlinでは、明示的にヌル許容型としてマークしない限り、すべての通常の型はデフォルトで非ヌル許容型です。 もしaがnullになることを想定しない場合、stringLength()関数を次のように宣言します。

// Kotlin
fun stringLength(a: String) = a.length

パラメータaはString型であり、Kotlinでは常にStringインスタンスを含み、nullを含むことはできないことを意味します。 Kotlinのヌル許容型は、疑問符?を付けてマークされます（例: String?）。 コンパイラがstringLength()のすべての引数がnullでないというルールを強制するため、aがStringである場合、実行時にNullPointerExceptionが発生する状況はありえません。

null値をstringLength(a: String)関数に渡そうとすると、コンパイル時エラーが発生し、 「Null can not be a value of a non-null type String」と表示されます。

この関数をnullを含む任意の引数で使用したい場合は、引数型String?の後に疑問符を付け、 関数本体内で引数の値がnullでないことを確認するためのチェックを行います。

// Kotlin
fun stringLength(a: String?): Int = if (a != null) a.length else 0

チェックが正常に通過すると、コンパイラは、コンパイラがチェックを実行するスコープ内で、その変数を非ヌル許容型のStringであるかのように扱います。

このチェックを実行しない場合、コードは以下のメッセージでコンパイルに失敗します。 「セーフコール演算子 (?.)または非ヌル表明 (!!.) 呼び出しのみが、String? 型のヌル許容レシーバで許可されています。」

同じことをより短く書くことができます。ヌルチェックとメソッド呼び出しを単一の操作に結合できるセーフコール演算子 ?. (If-not-null shorthand)を使用します。

// Kotlin
fun stringLength(a: String?): Int = a?.length ?: 0

プラットフォーム型

Javaでは、変数がnullになりうるか、またはnullになりえないかを示すアノテーションを使用できます。 そのようなアノテーションは標準ライブラリの一部ではありませんが、別途追加できます。 例えば、JetBrainsのアノテーション@Nullableや@NotNull (org.jetbrains.annotationsパッケージから) や、 Eclipseのアノテーション (org.eclipse.jdt.annotation) を使用できます。 Kotlinは、KotlinコードからJavaコードを呼び出す際に、そのようなアノテーションを認識し、 それらのアノテーションに従って型を扱います。

Javaコードにこれらのアノテーションがない場合、KotlinはJavaの型を_プラットフォーム型_として扱います。 しかし、Kotlinはそのような型に対するヌル可能性情報を持たないため、コンパイラはそれらに対するすべての操作を許可します。 ヌルチェックを実行するかどうかを決定する必要があります。なぜなら、

• Javaと同様に、nullに対して操作を実行しようとするとNullPointerExceptionが発生します。
• 通常、非ヌル許容型の値に対してヌルセーフな操作を実行した場合にコンパイラが行う冗長なヌルチェックのハイライトは行われません。

ヌル安全性とプラットフォーム型に関するKotlinからJavaの呼び出しについてさらに学びましょう。

確定非ヌル許容型のサポート

Kotlinでは、引数として@NotNullを含むJavaメソッドをオーバーライドしたい場合、Kotlinの確定非ヌル許容型が必要です。

例えば、Javaの次のload()メソッドを考えてみましょう。

import org.jetbrains.annotations.*;

public interface Game<T> {
  public T save(T x) {}
  @NotNull
  public T load(@NotNull T x) {}
}

Kotlinでload()メソッドを正常にオーバーライドするには、T1を確定非ヌル許容型 (T1 & Any) として宣言する必要があります。

interface ArcadeGame<T1> : Game<T1> {
  override fun save(x: T1): T1
  // T1 is definitely non-nullable
  override fun load(x: T1 & Any): T1 & Any
}

確定非ヌル許容型であるジェネリック型についてさらに学びましょう。

関数呼び出しの結果の確認

ヌルチェックが必要となる最も一般的な状況の1つは、関数呼び出しから結果を取得するときです。

以下の例では、OrderとCustomerという2つのクラスがあります。OrderはCustomerインスタンスへの参照を持っています。 findOrder()関数はOrderクラスのインスタンスを返しますが、注文が見つからない場合はnullを返します。 目的は、取得した注文の顧客インスタンスを処理することです。

Javaのクラスを次に示します。

//Java
record Order (Customer customer) {}

record Customer (String name) {}

Javaでは、関数を呼び出し、必要なプロパティの逆参照に進むために、結果に対してif-not-nullチェックを行います。

// Java
Order order = findOrder();

if (order != null) {
    processCustomer(order.getCustomer());
}

上記のJavaコードを直接Kotlinコードに変換すると、次のようになります。

// Kotlin
data class Order(val customer: Customer)

data class Customer(val name: String)

val order = findOrder()

// Direct conversion
if (order != null){
    processCustomer(order.customer)
}

セーフコール演算子 ?. (If-not-null shorthand)を、標準ライブラリのスコープ関数のいずれかと組み合わせて使用します。 通常、これにはlet関数が使用されます。

// Kotlin
val order = findOrder()

order?.let {
    processCustomer(it.customer)
}

同じもののより短いバージョンを次に示します。

// Kotlin
findOrder()?.customer?.let(::processCustomer)

ヌルの代わりにデフォルト値

nullのチェックは、ヌルチェックが成功した場合にデフォルト値を設定することと組み合わせてよく使用されます。

ヌルチェックを含むJavaコード:

// Java
Order order = findOrder();
if (order == null) {
    order = new Order(new Customer("Antonio"))
}

Kotlinで同じことを表現するには、エルビス演算子 (If-not-null-else shorthand)を使用します。

// Kotlin
val order = findOrder() ?: Order(Customer("Antonio"))

値またはヌルを返す関数

Javaでは、リスト要素を扱う際に注意が必要です。要素を使用しようとする前に、常にインデックスに要素が存在するかどうかを確認する必要があります。

// Java
var numbers = new ArrayList<Integer>();
numbers.add(1);
numbers.add(2);

System.out.println(numbers.get(0));
//numbers.get(5) // Exception!

Kotlinの標準ライブラリには、null値を返す可能性があるかどうかを名前に示す関数がよく提供されています。 これは特にコレクションAPIで一般的です。

fun main() {
    // Kotlin
    // The same code as in Java:
    val numbers = listOf(1, 2)
    
    println(numbers[0])  // Can throw IndexOutOfBoundsException if the collection is empty
    //numbers.get(5)     // Exception!

    // More abilities:
    println(numbers.firstOrNull())
    println(numbers.getOrNull(5)) // null
}

集計操作

最大の要素を取得する必要がある場合、または要素がない場合にnullを取得する必要がある場合、Javaでは Stream APIを使用します。

// Java
var numbers = new ArrayList<Integer>();
var max = numbers.stream().max(Comparator.naturalOrder()).orElse(null);
System.out.println("Max: " + max);

Kotlinでは、集計操作を使用します。

// Kotlin
val numbers = listOf<Int>()
println("Max: ${numbers.maxOrNull()}")

JavaとKotlinにおけるコレクションについてさらに学びましょう。

型を安全にキャストする

型を安全にキャストする必要がある場合、Javaではinstanceof演算子を使用し、その後それがうまくいったかどうかをチェックします。

// Java
int getStringLength(Object y) {
    return y instanceof String x ? x.length() : -1;
}

void main() {
    System.out.println(getStringLength(1)); // Prints `-1`
}

Kotlinで例外を避けるには、失敗時にnullを返すセーフキャスト演算子as?を使用します。

// Kotlin
fun main() {
    println(getStringLength(1)) // Prints `-1`
}

fun getStringLength(y: Any): Int {
    val x: String? = y as? String // null
    return x?.length ?: -1 // Returns -1 because `x` is null
}

NOTE

上記のJavaの例では、getStringLength()関数はプリミティブ型intの結果を返します。

nullを返すようにするには、_ボックス化された_型Integerを使用できます。

しかし、そのような関数に負の値を返させ、その値をチェックする方がリソース効率が良いです。

いずれにせよチェックは行いますが、この方法では追加のボックス化は実行されません。

次は何をしますか？

• 他のKotlinイディオムを参照してください。
• Java-to-Kotlin (J2K) コンバーターを使用して、既存のJavaコードをKotlinに変換する方法を学びましょう。
• その他の移行ガイドを確認してください。
  • JavaとKotlinにおける文字列
  • JavaとKotlinにおけるコレクション

お気に入りのイディオムがあれば、プルリクエストを送ってぜひ私たちと共有してください！