Java Builderクラスのサブクラス化
このドブス博士の記事 、および特にBuilderパターンを指定すると、Builderをサブクラス化するケースをどのように処理できますか？ GMOラベル付けを追加するサブクラスを作成する例の簡略版を使用すると、単純な実装は次のようになります。
public class NutritionFacts {
private final int calories;
public static class Builder {
private int calories = 0;
public Builder() {}
public Builder calories(int val) { calories = val; return this; }
public NutritionFacts build() { return new NutritionFacts(this); }
}
protected NutritionFacts(Builder builder) {
calories = builder.calories;
}
}
サブクラス：
public class GMOFacts extends NutritionFacts {
private final boolean hasGMO;
public static class Builder extends NutritionFacts.Builder {
private boolean hasGMO = false;
public Builder() {}
public Builder GMO(boolean val) { hasGMO = val; return this; }
public GMOFacts build() { return new GMOFacts(this); }
}
protected GMOFacts(Builder builder) {
super(builder);
hasGMO = builder.hasGMO;
}
}
これで、次のようなコードを作成できます。
GMOFacts.Builder b = new GMOFacts.Builder();
b.GMO(true).calories(100);
しかし、順序が間違っていると、すべて失敗します。
GMOFacts.Builder b = new GMOFacts.Builder();
b.calories(100).GMO(true);
問題は、もちろんNutritionFacts.BuilderがNutritionFacts.BuilderではなくGMOFacts.Builderを返すことです。したがって、この問題をどのように解決するのでしょうか、または使用するより良いパターンがありますか？
注： 同様の質問に対するこの回答 は、上記のクラスを提供します。私の質問は、Builder呼び出しが正しい順序であることを確認する問題に関するものです。
ジェネリックを使用して解決できます。これは "不思議な繰り返しの一般的なパターン" と呼ばれると思います
基本クラスビルダーメソッドの戻り値の型を汎用引数にします。
public class NutritionFacts {
private final int calories;
public static class Builder<T extends Builder<T>> {
private int calories = 0;
public Builder() {}
public T calories(int val) {
calories = val;
return (T) this;
}
public NutritionFacts build() { return new NutritionFacts(this); }
}
protected NutritionFacts(Builder<?> builder) {
calories = builder.calories;
}
}
次に、派生クラスビルダーを汎用引数として使用して、ベースビルダーをインスタンス化します。
public class GMOFacts extends NutritionFacts {
private final boolean hasGMO;
public static class Builder extends NutritionFacts.Builder<Builder> {
private boolean hasGMO = false;
public Builder() {}
public Builder GMO(boolean val) {
hasGMO = val;
return this;
}
public GMOFacts build() { return new GMOFacts(this); }
}
protected GMOFacts(Builder builder) {
super(builder);
hasGMO = builder.hasGMO;
}
}
記録のためだけに、
unchecked or unsafe operations警告
@dimadimaと@Thomas N.のreturn (T) this;ステートメントについては、次の解決策が特定の場合に適用されます。
abstractをジェネリック型（この場合はT extends Builder）を宣言するビルダーにし、次のようにprotected abstract T getThis()抽象メソッドを宣言します。
public abstract static class Builder<T extends Builder<T>> {
private int calories = 0;
public Builder() {}
/** The solution for the unchecked cast warning. */
public abstract T getThis();
public T calories(int val) {
calories = val;
// no cast needed
return getThis();
}
public NutritionFacts build() { return new NutritionFacts(this); }
}
詳細については、 http://www.angelikalanger.com/GenericsFAQ/FAQSections/ProgrammingIdioms.html#FAQ205 を参照してください。
ブログ投稿 に基づいて、このアプローチではすべての非リーフクラスが抽象的であり、すべてのリーフクラスがfinalである必要があります。
public abstract class TopLevel {
protected int foo;
protected TopLevel() {
}
protected static abstract class Builder
<T extends TopLevel, B extends Builder<T, B>> {
protected T object;
protected B thisObject;
protected abstract T createObject();
protected abstract B thisObject();
public Builder() {
object = createObject();
thisObject = thisObject();
}
public B foo(int foo) {
object.foo = foo;
return thisObject;
}
public T build() {
return object;
}
}
}
次に、このクラスとそのビルダーを拡張するいくつかの中間クラスがあります。
public abstract class SecondLevel extends TopLevel {
protected int bar;
protected static abstract class Builder
<T extends SecondLevel, B extends Builder<T, B>> extends TopLevel.Builder<T, B> {
public B bar(int bar) {
object.bar = bar;
return thisObject;
}
}
}
そして最後に、任意の親のすべてのビルダーメソッドを任意の順序で呼び出すことができる具象リーフクラス：
public final class LeafClass extends SecondLevel {
private int baz;
public static final class Builder extends SecondLevel.Builder<LeafClass,Builder> {
protected LeafClass createObject() {
return new LeafClass();
}
protected Builder thisObject() {
return this;
}
public Builder baz(int baz) {
object.baz = baz;
return thisObject;
}
}
}
次に、階層内の任意のクラスから、任意の順序でメソッドを呼び出すことができます。
public class Demo {
LeafClass leaf = new LeafClass.Builder().baz(2).foo(1).bar(3).build();
}
calories()メソッドをオーバーライドして、拡張ビルダーを返すこともできます。 Javaが 共変戻り型 をサポートするため、これはコンパイルされます。
public class GMOFacts extends NutritionFacts {
private final boolean hasGMO;
public static class Builder extends NutritionFacts.Builder {
private boolean hasGMO = false;
public Builder() {
}
public Builder GMO(boolean val)
{ hasGMO = val; return this; }
public Builder calories(int val)
{ super.calories(val); return this; }
public GMOFacts build() {
return new GMOFacts(this);
}
}
[...]
}
「継承よりも合成を優先する」に準拠するBuilderパターンに従ってクラスを作成する別の方法もあります。
親クラスBuilderが継承するインターフェースを定義します。
public interface FactsBuilder<T> {
public T calories(int val);
}
NutritionFactsの実装はほぼ同じです（Builderが 'FactsBuilder'インターフェイスを実装する場合を除く）：
public class NutritionFacts {
private final int calories;
public static class Builder implements FactsBuilder<Builder> {
private int calories = 0;
public Builder() {
}
@Override
public Builder calories(int val) {
return this;
}
public NutritionFacts build() {
return new NutritionFacts(this);
}
}
protected NutritionFacts(Builder builder) {
calories = builder.calories;
}
}
子クラスのBuilderは、同じインターフェースを拡張する必要があります（異なるジェネリック実装を除く）：
public static class Builder implements FactsBuilder<Builder> {
NutritionFacts.Builder baseBuilder;
private boolean hasGMO = false;
public Builder() {
baseBuilder = new NutritionFacts.Builder();
}
public Builder GMO(boolean val) {
hasGMO = val;
return this;
}
public GMOFacts build() {
return new GMOFacts(this);
}
@Override
public Builder calories(int val) {
baseBuilder.calories(val);
return this;
}
}
NutritionFacts.BuilderはGMOFacts.Builder（baseBuilderと呼ばれる）内のフィールドであることに注意してください。 FactsBuilderインターフェイスから実装されたメソッドは、同じ名前のbaseBuilderのメソッドを呼び出します。
@Override
public Builder calories(int val) {
baseBuilder.calories(val);
return this;
}
GMOFacts(Builder builder)のコンストラクターにも大きな変更があります。コンストラクターの親クラスコンストラクターへの最初の呼び出しは、適切なNutritionFacts.Builderを渡す必要があります。
protected GMOFacts(Builder builder) {
super(builder.baseBuilder);
hasGMO = builder.hasGMO;
}
GMOFactsクラスの完全な実装：
public class GMOFacts extends NutritionFacts {
private final boolean hasGMO;
public static class Builder implements FactsBuilder<Builder> {
NutritionFacts.Builder baseBuilder;
private boolean hasGMO = false;
public Builder() {
}
public Builder GMO(boolean val) {
hasGMO = val;
return this;
}
public GMOFacts build() {
return new GMOFacts(this);
}
@Override
public Builder calories(int val) {
baseBuilder.calories(val);
return this;
}
}
protected GMOFacts(Builder builder) {
super(builder.baseBuilder);
hasGMO = builder.hasGMO;
}
}
複数のビルダー継承の完全な3レベルの例は次のようになります：
（ビルダーのコピーコンストラクターのあるバージョンについては、以下の2番目の例を参照）
最初のレベル-親（潜在的に抽象）
import lombok.ToString;
@ToString
@SuppressWarnings("unchecked")
public abstract class Class1 {
protected int f1;
public static class Builder<C extends Class1, B extends Builder<C, B>> {
C obj;
protected Builder(C constructedObj) {
this.obj = constructedObj;
}
B f1(int f1) {
obj.f1 = f1;
return (B)this;
}
C build() {
return obj;
}
}
}
セカンドレベル
import lombok.ToString;
@ToString(callSuper=true)
@SuppressWarnings("unchecked")
public class Class2 extends Class1 {
protected int f2;
public static class Builder<C extends Class2, B extends Builder<C, B>> extends Class1.Builder<C, B> {
public Builder() {
this((C) new Class2());
}
protected Builder(C obj) {
super(obj);
}
B f2(int f2) {
obj.f2 = f2;
return (B)this;
}
}
}
第三レベル
import lombok.ToString;
@ToString(callSuper=true)
@SuppressWarnings("unchecked")
public class Class3 extends Class2 {
protected int f3;
public static class Builder<C extends Class3, B extends Builder<C, B>> extends Class2.Builder<C, B> {
public Builder() {
this((C) new Class3());
}
protected Builder(C obj) {
super(obj);
}
B f3(int f3) {
obj.f3 = f3;
return (B)this;
}
}
}
そして使用例
public class Test {
public static void main(String[] args) {
Class2 b1 = new Class2.Builder<>().f1(1).f2(2).build();
System.out.println(b1);
Class2 b2 = new Class2.Builder<>().f2(2).f1(1).build();
System.out.println(b2);
Class3 c1 = new Class3.Builder<>().f1(1).f2(2).f3(3).build();
System.out.println(c1);
Class3 c2 = new Class3.Builder<>().f3(3).f1(1).f2(2).build();
System.out.println(c2);
Class3 c3 = new Class3.Builder<>().f3(3).f2(2).f1(1).build();
System.out.println(c3);
Class3 c4 = new Class3.Builder<>().f2(2).f3(3).f1(1).build();
System.out.println(c4);
}
}
ビルダーのコピーコンストラクターを備えたもう少し長いバージョン：
最初のレベル-親（潜在的に抽象）
import lombok.ToString;
@ToString
@SuppressWarnings("unchecked")
public abstract class Class1 {
protected int f1;
public static class Builder<C extends Class1, B extends Builder<C, B>> {
C obj;
protected void setObj(C obj) {
this.obj = obj;
}
protected void copy(C obj) {
this.f1(obj.f1);
}
B f1(int f1) {
obj.f1 = f1;
return (B)this;
}
C build() {
return obj;
}
}
}
セカンドレベル
import lombok.ToString;
@ToString(callSuper=true)
@SuppressWarnings("unchecked")
public class Class2 extends Class1 {
protected int f2;
public static class Builder<C extends Class2, B extends Builder<C, B>> extends Class1.Builder<C, B> {
public Builder() {
setObj((C) new Class2());
}
public Builder(C obj) {
this();
copy(obj);
}
@Override
protected void copy(C obj) {
super.copy(obj);
this.f2(obj.f2);
}
B f2(int f2) {
obj.f2 = f2;
return (B)this;
}
}
}
第三レベル
import lombok.ToString;
@ToString(callSuper=true)
@SuppressWarnings("unchecked")
public class Class3 extends Class2 {
protected int f3;
public static class Builder<C extends Class3, B extends Builder<C, B>> extends Class2.Builder<C, B> {
public Builder() {
setObj((C) new Class3());
}
public Builder(C obj) {
this();
copy(obj);
}
@Override
protected void copy(C obj) {
super.copy(obj);
this.f3(obj.f3);
}
B f3(int f3) {
obj.f3 = f3;
return (B)this;
}
}
}
そして使用例
public class Test {
public static void main(String[] args) {
Class3 c4 = new Class3.Builder<>().f2(2).f3(3).f1(1).build();
System.out.println(c4);
// Class3 builder copy
Class3 c42 = new Class3.Builder<>(c4).f2(12).build();
System.out.println(c42);
Class3 c43 = new Class3.Builder<>(c42).f2(22).f1(11).build();
System.out.println(c43);
Class3 c44 = new Class3.Builder<>(c43).f3(13).f1(21).build();
System.out.println(c44);
}
}
角かっこ1つまたは3つに目を突く必要がない場合、または気に入らない場合...うーん...つまり... cough ...チームの他のメンバーは、不思議な繰り返しジェネリックパターンをすぐに理解します。これを行うことができます。
public class TestInheritanceBuilder {
public static void main(String[] args) {
SubType.Builder builder = new SubType.Builder();
builder.withFoo("FOO").withBar("BAR").withBaz("BAZ");
SubType st = builder.build();
System.out.println(st.toString());
builder.withFoo("BOOM!").withBar("not getting here").withBaz("or here");
}
}
による支援
public class SubType extends ParentType {
String baz;
protected SubType() {}
public static class Builder extends ParentType.Builder {
private SubType object = new SubType();
public Builder withBaz(String baz) {
getObject().baz = baz;
return this;
}
public Builder withBar(String bar) {
super.withBar(bar);
return this;
}
public Builder withFoo(String foo) {
super.withFoo(foo);
return this;
}
public SubType build() {
// or clone or copy constructor if you want to stamp out multiple instances...
SubType tmp = getObject();
setObject(new SubType());
return tmp;
}
protected SubType getObject() {
return object;
}
private void setObject(SubType object) {
this.object = object;
}
}
public String toString() {
return "SubType2{" +
"baz='" + baz + '\'' +
"} " + super.toString();
}
}
および親タイプ：
public class ParentType {
String foo;
String bar;
protected ParentType() {}
public static class Builder {
private ParentType object = new ParentType();
public ParentType object() {
return getObject();
}
public Builder withFoo(String foo) {
if (!"foo".equalsIgnoreCase(foo)) throw new IllegalArgumentException();
getObject().foo = foo;
return this;
}
public Builder withBar(String bar) {
getObject().bar = bar;
return this;
}
protected ParentType getObject() {
return object;
}
private void setObject(ParentType object) {
this.object = object;
}
public ParentType build() {
// or clone or copy constructor if you want to stamp out multiple instances...
ParentType tmp = getObject();
setObject(new ParentType());
return tmp;
}
}
public String toString() {
return "ParentType2{" +
"foo='" + foo + '\'' +
", bar='" + bar + '\'' +
'}';
}
}
キーポイント：
- オブジェクトをビルダーにカプセル化し、継承により親タイプに保持されているオブジェクトのフィールドを設定できないようにします
- スーパーへの呼び出しは、スーパータイプビルダーメソッドに追加されたロジック（存在する場合）がサブタイプで保持されるようにします。
- 欠点は、親クラスでの偽のオブジェクト作成です...しかし、それをクリーンアップする方法については以下を参照してください
- アップサイドは一目で理解しやすく、プロパティを転送する冗長なコンストラクターはありません。
- ビルダーオブジェクトにアクセスする複数のスレッドがある場合...私はあなたではないことをうれしく思います:)。
編集：
偽のオブジェクトの作成を回避する方法を見つけました。まず、これを各ビルダーに追加します。
private Class whoAmI() {
return new Object(){}.getClass().getEnclosingMethod().getDeclaringClass();
}
次に、各ビルダーのコンストラクターで：
if (whoAmI() == this.getClass()) {
this.obj = new ObjectToBuild();
}
コストは、new Object(){}匿名内部クラスの追加のクラスファイルです
できることの1つは、クラスごとに静的ファクトリメソッドを作成することです。
NutritionFacts.newBuilder()
GMOFacts.newBuilder()
この静的ファクトリーメソッドは、適切なビルダーを返します。 GMOFacts.BuilderをNutritionFacts.Builderに拡張することができますが、これは問題ではありません。ここでの問題は、可視性に対処することです...
次のIEEEの貢献 Javaの洗練されたFluent Builder は、問題に対する包括的なソリューションを提供します。
元の質問を継承不足と準不変性の2つのサブ問題に分析し、これら2つのサブ問題の解決方法を示します。 Javaの従来のビルダーパターンでコードを再利用すると、継承のサポートに関する問題が発生します。
2つの正式な型パラメーターを受け入れる親の抽象ジェネリックビルダークラスを作成しました。 1つ目はbuild（）によって返されるオブジェクトのタイプ、2つ目は各オプションのパラメーターセッターによって返されるタイプです。以下は、説明のための親クラスと子クラスです。
**Parent**
public abstract static class Builder<T, U extends Builder<T, U>> {
// Required parameters
private final String name;
// Optional parameters
private List<String> outputFields = null;
public Builder(String pName) {
name = pName;
}
public U outputFields(List<String> pOutFlds) {
outputFields = new ArrayList<>(pOutFlds);
return getThis();
}
/**
* This helps avoid "unchecked warning", which would forces to cast to "T" in each of the optional
* parameter setters..
* @return
*/
abstract U getThis();
public abstract T build();
/*
* Getters
*/
public String getName() {
return name;
}
}
**Child**
public static class Builder extends AbstractRule.Builder<ContextAugmentingRule, ContextAugmentingRule.Builder> {
// Required parameters
private final Map<String, Object> nameValuePairsToAdd;
// Optional parameters
private String fooBar;
Builder(String pName, Map<String, String> pNameValPairs) {
super(pName);
/**
* Must do this, in case client code (I.e. JavaScript) is re-using
* the passed in for multiple purposes. Doing {@link Collections#unmodifiableMap(Map)}
* won't caught it, because the backing Map passed by client prior to wrapping in
* unmodifiable Map can still be modified.
*/
nameValuePairsToAdd = new HashMap<>(pNameValPairs);
}
public Builder fooBar(String pStr) {
fooBar = pStr;
return this;
}
@Override
public ContextAugmentingRule build() {
try {
Rule r = new ContextAugmentingRule(this);
storeInRuleByNameCache(r);
return (ContextAugmentingRule) r;
} catch (RuleException e) {
throw new IllegalArgumentException(e);
}
}
@Override
Builder getThis() {
return this;
}
}
これは私のニーズを満足させました。