パラメータクラスの必須、任意項目はクラスのコンストラクタとしてどう作ればよいか？

Question

こんにちは、Javaでとあるメソッドに渡す、パラメータクラスみたいなのを作ろうとしています。
その場合に、パラメータには必須項目と任意項目があり、クラスの設計として何が最善かを教えていただければと思います。

class Parameter {
    private String a;    // 必須
    private String b;    // 任意
    private String c;    // 任意

}

このようなインスタンス変数があるとして、変数のセット方法は

• １．全てクラスのコンストラクタで求める

  public Parameter(String, String, String);
    // a,b,cはゲッターのみ定義

• ２．必須項目のみクラスのコンストラクタで求める

  public Parameter(String);
    // aはゲッターのみ定義,b,cはゲッター/セッターを定義

• ３．全てセッターを定義し、必須も任意項目もプログラマにセットさせる

  public Parameter();
    // 全てゲッター/セッターを定義

が考えられると思います。

通常、パラメータクラスはどの方法が良いのか教えていただければと思います。

Answer 1

私個人の考えですが、まずメンバはこうします。

class Parameter {
    private String a;    // 必須
    private Optional<String> b;    // 任意
    private Optional<String> c;    // 任意
}

任意の部分はOptionalにしておくことで「存在しないかもしれないこと」を明示的にします。
その上で「必須項目のみのコンストラクタ」と、「任意項目も含めたコンストラクタ」の2種類を用意します。

// 必須項目のみ
Parameter(String a) {
    this(a, null, null);
}
// 任意項目も受け付ける 入れないものはnullに設定させる
Parameter(String a, String b, String c) {
    this.a = Objects.requireNonNull(a); // 必須なので、nullが入らないようチェック
    this.b = Optional.ofNullable(b);
    this.c = Optional.ofNullable(c);
}

あなたのコードの中で3は最悪だと思います。aが必須である保証がなされません。
あとセッターは不要だと思います。

nullを使いたくないということであれば、ファクトリメソッドという手もあります。ただ、どれを入れないかでメソッドが増えてしまいますが。

// この後のファクトリメソッドで作成することを前提とするため、コンストラクタを非公開にする
private Parameter(String a, String b, String c) {
    this.a = a;
    this.b = Optional.ofNullable(b);
    this.c = Optional.ofNullable(c);
}

public static Parameter of(String a, String b, String c) {
    Objects.requireNonNull(a);
    return new Parameter(a, b, c);
}

public static Parameter of(String a) {
    return of(a, null, null);
}

public static Parameter withB(String a, String b) {
    return of(a, b, null);
}

public static Parameter withC(String a, String c) {
    return of(a, null, c);
}

###追記
改めてOptionalについて調べてみたら、Optionalは返り値に使うことを想定していて、メンバに使うのは望ましくないとのことだったので改造

class Parameter {
    private String a;    // 必須
    private String b;    // 任意
    private String c;    // 任意

    private Parameter(String a, String b, String c) {
        this.a = a;
        this.b = b;
        this.c = c;
    }

    public static Parameter of(String a, String b, String c) {
        Objects.requireNonNull(a);
        return new Parameter(a, b, c);
    }

    public static Parameter of(String a) {
        return of(a, null, null);
    }

    public static Parameter withB(String a, String b) {
        return of(a, b, null);
    }

    public static Parameter withC(String a, String c) {
        return of(a, null, c);
    }

    public String getA() {
        return a;
    }

    public Optional<String> getB() {
        return Optional.ofNullable(b);
    }

    public Optional<String> getC() {
        return Optional.ofNullable(c);
    }
}

Comments

[swordone]

今更だが、Builderパターンを使うのが良さそう。

Answer 2

私なら1の全てをコンストラクタで定義する。を選ぶかと思います。ケースバイケースだと思いますので、他の方の回答も参考になさってください。

• まず3は選びません。プログラマがこのクラスを外から使う時に、必須の変数に気付く可能性が限りなく小さくなってしまうからです。基本的には呼び出し元から呼び出したクラスの中の設計を意識させないことが重要だと思います。使用者が、Parameter()を呼び出して使用したところ必須のパラメータがないことで不具合が起きるということが頻繁に起こり得ます。
• 次に、1と3ですが、setterを定義すると言うことは、Parameter()が初期化されたのちに変数を変更できる余地を与えることになります。もしもクラスを初期化したのちに変数を変更する可能性や必要性がないのであれば、全てコンストラクタで定義した方が良いかと思います。

Answer 3

＊後出しになりますが、、この質問をした経緯です。

３はもともとあり得ないと思っていましたが、パターンとしてあり得るという事で書いていました。１，２ともいずれも以下の悩みがありました。

１．は、第二引数を入力したくない場合、nullを入れなくてはならないというところ。

２．は、必須項目と任意項目で任意項目はセッターでセットというのはどうなのか？ということころ

なるべくならデータはイミュータブルに近い方が良いのではないかと考えていたところ２．はあり得ない

ご回答にありましたように、基本的にはコンストラクタで解決するとして、任意項目でnullを許容するのは致し方ないということろでしょうか。解決としては以下に考えました

1.必須項目のみと、必須項目と任意項目のコンストラクタを用意（swordoneさんの提案です）