2017.06.13

【Java】Builderパターンを使って実装しようぜ！

mokabuu

NO MORE テレスコーピングパターン＆JavaBeansパターン
以下はかの明書「Effective Java」を参考にしたものになります。

/**
*テレスコーピングパターン
*/
public class NutritionFacts {
    private final int servingSize; // (ml) 必須
    private final int servings; // (容器あたり）必須
    private final int categroes; // オプション
    private final int fat; // オプション
    private final int sodium; // オプション
    private final int carbohydrate // オプション
  
    public NutritionFacts(int servingSize, int servings) {
        this(servingSize, servings, 0, 0, 0, 0);
    }
    public NutritionFacts(int servingSize, int servings, int calories) {
        this(servingSize, servings, calories, 0, 0, 0);
    }
    public NutritionFacts(int servingSize, int servings, int calories, int fat) {
        this(servingSize, servings, calories, fat, 0, 0);
    }
    public NutritionFacts(int servingSize, int servings, int calories, int fat, int sodium) {
        this(servingSize, servings, calories, fat, sodium, 0);
    }
    public NutritionFacts(int servingSize, int servings, int calories, int fat, int sodium, int carbohydrate) {
        this.servigsSize = servingsSize;
        this.servigs = servings;
        this.calories = calories;
        this.fat = fat;
        this.sodium = sodium;
        this.carbohydrate = carbohydrate;
    }
}

/**
*JavaBeansパターン
*/
public class NutritionFacts {
    private int servingSize = -1; // 必須
    private int servings = -1; // 必須
    private int calories = 0;
    private int fat = 0;
    private int sodium = 0;
    private int carbohydrate = 0;
 
    public NutritionFacts() { }
 
    public void setServingSize(int val) { servingSize = val; }
    public void setServings(int val) { servings = val; }
    public void setCalories(int val) { calories = val; }
    public void setFat(int val) { fat = val; }
    public void setSodium(int val) { sodium = val; }
    public void setCarbohydrate(int val) { carbohydrate = val; }
}

今回はこの２つの実装方針(主に２つめ)がなぜJavaとしてダメなのか記事をつらつらと書き連ねたいと思います。

※ちなみにテレスコーピングパターンがNGな理由は、フィールド変数が増えた時に可読性が落ちて死ぬからです。

ここはサイゼリア
ここはサイゼリアです。
あなたは友人とお昼ご飯に来ました。

いつも通りドリンクバーでジュースを汲みます。

さて。
ここでJavaBeansパターンだと事件が起きるのです。

あなたがトイレに立って目を離した隙に友人はこんなことができちゃうんです。

1	`yourCoke.setSodium(1000);`

なんとコーラに1000mgの塩がもられてしまいました。

これは事件ですよね。
中学生ぐらいまでなら笑って許せますが、20歳をすぎた大人がこれやってきたらマジで許せません。

そうなんです。
JavaBeansパターンで実装してしまうと、あなたが目を離した隙に中身を書き換えられてしまうんです。

本来は美味しいはずのジュースも、勝手に中の成分が書き換えられてただの罰ゲームドリンクになってしまいかねません。楽しみにしていたクリームソーダがこんなことになってしかうかも・・・！

1	`yourCreamSoda.setServingSize(0);`

飲み干されました。

そこでBuilderパターン
そこでこのように実装すると安全なわけです。

/**
*Builderパターン
*/
public class NutritionFacts {
    private final int servingSize; // (ml) 必須
    private final int servings; // (容器あたり）必須
    private final int calories; // オプション
    private final int fat; // オプション
    private final int sodium; // オプション
    private final int carbohydrate; // オプション
 
    public static class Builder {
        // 必須
        private final int servingSize;
        private final int servings;
 
        // オプション
        private int calories = 0;
        private int fat = 0;
        private int carbohydrate = 0;
        private int sodium = 0;
 
        public Builder(int servingSize, int servings) {
            this.servingSize = servingSize;
            this.servings = servings;
        }
 
        public Builder setCalories(int val) {
            calories = val;
            return this;
        }
        public Builder setFat(int val) {
            fat = val;
            return this;
        }
        public Builder setSodium(int val) {
            sodium = val;
            return this;
        }
        public Builder setCarbohydrate(int val) {
            carbohydrate = val;
            return this;
        }
 
        public NutritionFacts build() {
            return new NutritionFacts(this);
        }
    }
 
    private NutritionFacts(Builder builder) {
        this.servingSize = builder.servingSize;
        this.servings = builder.servings;
        this.calories = builder.calories;
        this.fat = builder.fat;
        this.sodium = builder.sodium;
        this.carbohydrate = builder.carbohydrate;
    }
}

コーラを汲む際に以下のように実装してあげると、その後なかみを書き換えられることがないためとっても安全です。

NutritionFacts coke = new NutritionFacts.Builder(240, 8)
                        .calories(100)
                        .sodium(35)
                        .calories(27)
                        .build();