JavaでOptionalを活用したNull安全設計

この記事は BABY JOB Advent Calendar 2024 の 15 日目の記事です。

はじめに

プログラムにおけるnullの扱いは、長年にわたり多くのエラーの原因となってきました。これは10億ドルの誤り^[1]とも言われるほど、多くのシステムに悪影響を与えてきました。

この課題を解決するため、近年のプログラミング言語（例：Kotlin、TypeScriptなど）ではNull安全が言語仕様として取り入れられています。これらの言語では、型システムでnullを許容する場合と許容しない場合を明示的に区別することで、開発者が安全にコードを記述できる仕組みを提供しています。

一方、JavaではNull安全性を言語レベルで保証する仕組みがなく、Optional型のような標準ライブラリや開発者の工夫に依存しています。本記事では、このOptional型をクラスフィールドに適用し、JavaにおけるNull安全性を向上させる方法について詳しく解説します。

また、本記事の設計はドメイン駆動設計やオニオンアーキテクチャに基づいています。

Null安全とは

Null安全とは、プログラムにおいてnull値が原因でエラー（特にNullPointerException）が発生しないように、nullの取り扱いをコンパイラや言語機能で強制する仕組みのことです。

Null安全を実現するためには、以下の要素が含まれます。

• コンパイル時チェック: nullを許容しない型と許容する型を区別し、nullを許容しない型にnullを代入しようとするとコンパイルエラーが発生します。
• Nullが許容される場合の意図の明示: nullを扱う場合、型の中で明示的にnullが許容されることを示します。（例：Kotlinの String? など）

こうした仕組みにより、エラーの回避、コードの可読性向上、バグの早期発見、設計変更への耐性といったメリットが得られます。しかし、JavaはNull安全を強制しないため、開発者がnullの取り扱いに注意を払う必要があります。

JavaではこのNull安全性を向上させるためにOptional型が用意されていますが、通常はメソッドの戻り値にのみ使用されることが一般的です^[2]。しかし、Optional型をフィールドに適用することで得られる利点もあります。以下では、その利点と具体的な活用方法を解説します。

Optional型をフィールドに使用する

Optional型をフィールドに使用することで、意図の明確化と設計の一貫性が期待できます。Optional型を使用することで、フィールドが必須かオプションかを明示的に区別でき、コードの可読性が向上します。

• 必須フィールド: @NonNullで必ず値が存在することを保証します。
• オプションフィールド: Optional型として定義し、値が存在しない可能性があることを明示します。また、@NonNullで必ずOptionalインスタンスが存在することを保証します。

Javaではフィールドにnullを入れることができるため、Lombokの@NonNullアノテーションを使用して、nullの使用を抑制します。

コード例

import lombok.AllArgsConstructor;
import lombok.NonNull;
import java.util.Optional;

@AllArgsConstructor
class Product {
    @NonNull Long id;
    @NonNull String name;
    @NonNull Optional<String> description;
}

この例では、descriptionがOptional型として定義されており、「商品の説明が存在しない場合がある」という設計意図が明確に示されています。これにより、descriptionフィールドを使用する際に、値が存在しない可能性を考慮したコードを書くことができます。

ただし、Optional型はSerializableではないため、そのままではJPAなどのライブラリを使用できないという制約があります。

Optional型はSerializableではない

Optional型はSerializableではないため、JPAなどのORMでエンティティのプロパティとしてOptionalを使用すると、マッピングに問題が発生します。そのため、インフラ層ではJPA用のエンティティモデルとドメイン層のモデルを分離し、マッピング処理を行います。

エンティティモデルのコード例

import jakarta.persistence.Column;
import jakarta.persistence.Entity;
import jakarta.persistence.Id;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;

import java.util.Optional;

@Entity(name = "product")
@AllArgsConstructor
@NoArgsConstructor
@Getter
@Accessors(fluent = true)
public class ProductEntity {
    @Id @Column(nullable = false)
    Long id;
    @Column(nullable = false)
    String name;
    @Column(nullable = true)
    String description;
}

マッピング処理のコード例

public static ProductEntity toEntity(Product product) {
    return new ProductEntity(
        product.id(),
        product.name(),
        product.description().orElse(null)
    );
}

public static Product toDomainModel(ProductEntity entity) {
    return new Product(
        entity.id(),
        entity.name(),
        Optional.ofNullable(entity.description())
    );
}

このようにドメイン層のモデルとインフラ層のモデルを分離することで、ビジネスロジックの中心部分であるドメイン層をNull安全に保つことが可能です。

まとめ

Optional型をフィールドに使用することで、JavaのNull安全性を大幅に向上させることができます。これにより、以下のような利点が得られます。

• 必須フィールドとオプションフィールドを明確に区別できる。
• Nullに依存しない設計を実現し、コードの可読性と保守性が向上する。

一方で、Optional型はSerializableではないため、JPAなどのORMを利用する場合にはモデル分離が必要です。このような設計を採用することで、ドメイン層におけるビジネスロジックの安全性と柔軟性を確保できます。

Optional型のフィールド使用は、JavaでNull安全な設計を目指す開発者にとっての選択肢の一つとなります。

参考情報

• Null安全性
• Tired of Null Pointer Exceptions? Consider Using Java SE 8's "Optional"!
• OptionalがSerializableではない話と使い方まとめ
• ヌルポインタ
• アントニー・ホーア

脚注

1. この表現は、nullの概念を導入したアントニー・ホーア氏が、自身の発言でnull参照を「それは10億ドルにも相当する私の誤りだ。」と認めたことに由来します

2. Optionalはメソッドの戻り値としての使用を目的に設計されました