はじめに (対象読者・この記事でわかること)

このブログは、Java を学び始めた初心者から、既にオブジェクト指向でクラス設計を行っている中級者までを対象にしています。特に、Person クラスのようなシンプルなモデルに対して、フィールドの更新用メソッド（setter）を正しく追加したいと考えている方に向けた内容です。この記事を読むことで、以下のことができるようになります。

  • name フィールドを持つ Person クラスに、引数検証付きの setName メソッドを安全に実装できる
  • 実装時に陥りがちな NullPointerException や不変オブジェクト化の課題を回避できる
  • 綺麗なコードを書くためのアクセサメソッドのベストプラクティスを理解できる

プログラミング学習の過程で「setter を作りたいけど書き方が分からない」「バリデーションを入れたらどうすれば良いか悩んでいる」そんな疑問を抱いたことがある方のために、執筆の動機となった実務での経験も交えて解説します。

前提知識

この記事を読み進める上で、以下の知識があるとスムーズです。

  • Java の基本的な文法（クラス、フィールド、メソッドの定義）が理解できていること
  • IDE（IntelliJ IDEA や Eclipse）でのプロジェクト作成・ビルドができること

setNameメソッドの概要と必要性

Java のオブジェクト指向プログラミングでは、フィールドへの直接アクセスを制限し、メソッドを通じて状態を変更することが推奨されています。これを「カプセル化」と呼び、データの整合性や保守性を高める役割があります。Person クラスに name フィールドがある場合、外部から直接 person.name = "Alice" と書くよりも、person.setName("Alice") とメソッド経由で設定した方が次のような利点があります。

  1. バリデーションの一元化
    名前が空文字や null であってはならないといった制約を、setter 内にまとめて記述できます。
  2. 変更時の副作用管理
    名前が変更されたときにログを出力したり、関連する他のプロパティを自動更新したりするロジックを組み込めます。
  3. インターフェースの統一
    他のフィールドでも同様に setter を提供すれば、呼び出し側は「プロパティの設定はすべてメソッドを通す」という統一感のあるコードを書けます。

以上の理由から、setName メソッドは単なる代入文以上の価値を持ちます。次のセクションでは、実際に安全かつ拡張性のある実装方法をステップバイステップで紹介します。

setNameメソッドの実装手順

以下では、Person クラスに setName メソッドを追加する具体的な手順を解説します。例として、名前は必ず非空・非 null、かつ 1 文字以上 30 文字以内というバリデーションを実装します。また、将来的に不変オブジェクト（Immutable）化したいケースも考慮し、final キーワードの使用やコピーコンストラクタの作り方も併せて提示します。

ステップ1　クラス定義の確認とフィールドの修飾子設定

まずは現在の Person クラスを確認し、name フィールドの可視性を private にします。これにより外部から直接参照できなくなり、setter が唯一の変更手段になります。

Java

public class Person {
    private String name;   // 名前はプライベートにしてカプセル化

    // 既存のコンストラクタ
    public Person(String name) {
        this.name = name;
    }

    // 省略可能な getter
    public String getName() {
        return name;
    }
}

ポイントは以下の通りです。

  • private 修飾子：フィールドへの直接アクセスを防ぎ、クラス内部だけが変更できるようにします。
  • getter の提供：外部から名前を取得したい場合は getName を利用します。
  • コンストラクタでの初期化：setName を呼び出す前提で、コンストラクタでも同様のバリデーションロジックを流用できるようにしておくと一貫性が保てます。

ステップ2　バリデーションロジックの実装

次に、setName メソッド本体を作ります。バリデーションは共通化のため、プライベートメソッド validateName に切り出すとコードがすっきりします。

Java

public class Person {
    private String name;

    public Person(String name) {
        setName(name);   // コンストラクタからも同じバリデーションを通す
    }

    public String getName() {
        return name;
    }

    // 公開する setter
    public void setName(String name) {
        validateName(name);
        this.name = name;
    }

    // バリデーションを担当するプライベートメソッド
    private void validateName(String name) {
        if (name == null) {
            throw new IllegalArgumentException("名前は null にできません。");
        }
        if (name.isBlank()) {
            throw new IllegalArgumentException("名前は空文字にできません。");
        }
        if (name.length() > 30) {
            throw new IllegalArgumentException("名前は30文字以内で入力してください。");
        }
        // 必要に応じて正規表現で文字種チェックも追加可能
    }
}

実装のポイント

  • IllegalArgumentException の使用：不正な引数が渡されたことを明示的に通知し、呼び出し側に例外処理を促します。
  • isBlank() の活用：Java 11 以降で利用できる便利メソッドで、空白文字だけの文字列も除外できます。
  • コンストラクタから setName を呼び出す：オブジェクト生成時のバリデーション漏れを防ぎ、単一のロジックに集約できます。

ハマった点やエラー解決

実装中に遭遇しやすい問題として、以下のようなケースがあります。

発生した問題 原因 解決策
NullPointerException が name.isBlank() で発生 name が null のまま isBlank() を呼び出した null チェックを最初に行い、IllegalArgumentException を投げる
IDE が setName が未使用と警告 コンストラクタや他のクラスから呼び出していない 実際のアプリケーションコードで person.setName("Bob") を呼び出すか、テストコードで使用例を示す
バリデーションを追加した後、古いインスタンスが不整合状態になる setName を実装せずにフィールドを直接変更していた フィールドを private にした上で、全ての更新を setName 経由に統一する

具体的な解決例

問題：validateName 内で name.isBlank() が NullPointerException を起こす
対策：if (name == null) を最初に配置し、例外を投げることで isBlank() の呼び出しを防止しました。

Java

private void validateName(String name) {
    if (name == null) {
        throw new IllegalArgumentException("名前は null にできません。");
    }
    // ここからは null ではないことが保証される
    if (name.isBlank()) {
        throw new IllegalArgumentException("名前は空文字にできません。");
    }
    // ...
}

解決策のまとめ

  • 順序を守る：null チェック → 空白チェック → 文字数チェックの順に行うと、例外の原因が特定しやすくなります。
  • 例外メッセージは具体的に：開発者がデバッグしやすいように、何が問題かを明示したメッセージを設定します。
  • テストコードで検証：JUnit などのテストフレームワークを使い、正常系・異常系の両方を網羅的にテストしましょう。

JUnit テスト例

Java

import static org.junit.jupiter.api.Assertions.*;
import org.junit.jupiter.api.Test;

class PersonTest {

    @Test
    void setName_正常系() {
        Person p = new Person("Alice");
        p.setName("Bob");
        assertEquals("Bob", p.getName());
    }

    @Test
    void setName_空文字_例外が出る() {
        Person p = new Person("Alice");
        Exception e = assertThrows(IllegalArgumentException.class, () -> p.setName(""));
        assertEquals("名前は空文字にできません。", e.getMessage());
    }

    @Test
    void setName_null_例外が出る() {
        Person p = new Person("Alice");
        Exception e = assertThrows(IllegalArgumentException.class, () -> p.setName(null));
        assertEquals("名前は null にできません。", e.getMessage());
    }
}

テストを走らせることで、実装したバリデーションが意図通りに機能しているか自動的に確認できます。

まとめ

本記事では、Java の Person クラスに対して安全な setName メソッドを追加する手順と、実装時に注意すべきポイントを解説しました。

  • カプセル化 によりフィールドへの直接アクセスを防ぎ、バリデーションや副作用を一元管理できる
  • バリデーションロジック をプライベートメソッドに切り出すことで可読性と再利用性が向上する
  • 例外処理とテスト を組み合わせることで、開発時のバグを早期に検出できる

この記事を通じて、読者は「setter メソッドの正しい書き方」と「実務で頻出するバリデーションの実装テクニック」を身につけられたはずです。次回は、同様の手法で Person クラスを不変オブジェクト化する方法や、Builder パターンを用いた柔軟なインスタンス生成について取り上げる予定です。

参考資料