2022.10.07

開発技術

ビルダーパターンはどんな時に使われるか

#Java

デザインパターンとは
ビルダーパターンについて
ビルダーパターンのサンプルコード
ビルダーパターンのまとめ

デザインパターンとは

【エンジニア募集中】フルリモート可◎、売上/従業員数9年連続UP、平均残業8時間、有給取得率90％、年休124日以上 etc.　　詳細はこちらから＞

デザインパターンは、経験豊富なソフトウェア開発者の試行錯誤により得られた、ベストプラクティスです。その中でもGoF(Gang of Four)と呼ばれる4人の共著者によるパターンが特に有名であり、こららのデザインパターンを有効に活用することで開発者に様々なメリットがあります。

デザインパターンにはソフトウェア開発における2つの大きな目的があります。

・エンジニア同士の共通言語
デザインパターンの用語を理解した開発者同士であれば、より容易に互いのアイデアを比較し、議論し合うことが可能です。

・ベストプラクティス
デザインパターンは先人たちの試行錯誤の結晶です。若いエンジニアはデザインパターンを学ぶことで車輪の再発明を行うことなく、素早く優れたコード設計を学ぶことができます。

ビルダーパターンについて

Builderパターンを定義すると、「複雑なオブジェクトの構築をその表現から分離して、同じ構築プロセスで複数の異なる表現を作成できるようにする」ことです。

かなり小難しい表現となってしまいましたが、例えば以下のような場合に役立ちます。

・コンストラクタの引数が多い
・コンストラクタに設定する引数が任意のものが多い

上記の場合を一般的な書き方をするとこうなります(Javaでの記述)。

class Hero {
  String name;
  String sex;
  int age;
  int hp;
  int mp;
  int strength;
  int defense;

 Hero(String name, String sex, int age, int hp, int mp, int strength, int defense) {
   if (name == null || sex == null) throw new NullPointerException();

   this.name = name;
   this.sex = sex;
   this.age = age;
   this.hp = hp;
   this.mp = mp;
   this.strength = strength;
   this.defense = defense;
 }
}

class Hero {

String name;

String sex;

int age;

int hp;

int mp;

int strength;

int defense;

Hero(String name, String sex, int age, int hp, int mp, int strength, int defense) {

if (name == null || sex == null) throw new NullPointerException();

this.name = name;

this.sex = sex;

this.age = age;

this.hp = hp;

this.mp = mp;

this.strength = strength;

this.defense = defense;

}

インスタンスの生成は以下

Hero hero = new Hero("太郎", "男性", 25, 100, 150, 80, 120);

				1

						Hero hero = new Hero("太郎", "男性", 25, 100, 150, 80, 120);

引数が多く、値の受け渡しのミスが多くなってしまいそうです。
また、任意の値も引数として渡さなければならず、記述の無駄が多くなってしまいそうですね。

ビルダーパターン(Effective Java)を利用した場合、インスタンスの生成は以下のようになります。

Hero hero = new Hero.Builder("太郎", "男性").age().hp(100).stregth(80).build();

				1

						Hero hero = new Hero.Builder("太郎", "男性").age().hp(100).stregth(80).build();

対象のフィールドを明確に指定できており、わかりやすくなりました。
また、任意のフィールドは設定したい場合のみ記述すればよいのでコードの無駄も減ります。

肝心のビルダーパターンを用いたクラスの記述方法は以下のようになります。

class Hero {
  String name;
  String sex;
  int age;
  int hp;
  int mp;
  int strength;
  int defense;

    static class Builder {
        private String name;
        private String sex;
        private int age;
        private int hp;
        private int mp;
        private int strength;
        private int defense;

        Builder(String name, String sex) {
            this.name = name;
            this.sex = sex;
        }

        Builder age(int age) {
            this.age = age;
            return this;
        }

        Builder hp(int hp) {
            this.hp = hp;
            return this;
        }

        Builder mp(int mp) {
            this.mp = mp;
            return this;
        }

        Builder strength(int strength) {
            this.strength = strength;
            return this;
        }

        Builder defense(int defense) {
            this.defense = defense;
            return this;
        }

        People build() {
            if (name == null || sex == null) {
                throw new NullPointerException();
            }
            return new Hero(this);
        }
  }

  private Hero(Builder builder) {
      this.name = builder.name;
      this.sex = sex;
      this.age = builder.age;
      this.hp = builder.hp;
      this.mp = builder.mp;
      this.strength = builder.strength;
      this.defense = builder.defense;
  }

  String hello() {
      //...
  }
}

class Hero {

String name;

String sex;

int age;

int hp;

int mp;

int strength;

int defense;

static class Builder {

private String name;

private String sex;

private int age;

private int hp;

private int mp;

private int strength;

private int defense;

Builder(String name, String sex) {

this.name = name;

this.sex = sex;

}

Builder age(int age) {

this.age = age;

return this;

}

Builder hp(int hp) {

this.hp = hp;

return this;

}

Builder mp(int mp) {

this.mp = mp;

return this;

}

Builder strength(int strength) {

this.strength = strength;

return this;

}

Builder defense(int defense) {

this.defense = defense;

return this;

}

People build() {

if (name == null || sex == null) {

throw new NullPointerException();

}

return new Hero(this);

}

private Hero(Builder builder) {

this.name = builder.name;

this.sex = sex;

this.age = builder.age;

this.hp = builder.hp;

this.mp = builder.mp;

this.strength = builder.strength;

this.defense = builder.defense;

}

String hello() {

//...

}

static内部クラスを利用して実装しています。

ビルダーパターンのサンプルコード

下記は筆者が実際にビルダーパターンを用いたクラスのインスタンスを生成するコードを書いたときのコードです。

サブスクリプションインスタンスの生成を行っています。

SubscriptionCreateParams subscriptionCreateParams = new SubscriptionCreateParams.Builder().setAutomaticTax(automaticTax)
                    .setCustomer(stripeCustomerObj.getId()).setTrialEnd(trialEnd).addItem(item).build();

1 2	SubscriptionCreateParams subscriptionCreateParams = new SubscriptionCreateParams.Builder().setAutomaticTax(automaticTax) .setCustomer(stripeCustomerObj.getId()).setTrialEnd(trialEnd).addItem(item).build();