如何将方法标记为强制方法？

Question

假设您使用构建器模式创建一个名为 Person 的类，并假设 Builder 类包含方法 body()、head()、arms() 当然还有 build() 并且您认为方法 head() 和 build() 对于此类的用户来说是必需的。

如果可能的话，我们希望使用注释以某种方式将这些方法标记为强制方法。如果此类的用户尝试构建 Person 实例但忘记调用这些方法中的任何一个，我们希望收到某种警告 - 要么来自 java 编译器，要么来自 Eclipse 或 Maven，我们用它们来构建我们的实例。项目——任何一个都可以。

可以做吗？你会建议哪种方式？

Answer 1

下面是一个使用不同类型使某些部分成为强制性的示例（它也使您调用方法的顺序成为强制性的）：

package test;

import test.StepOne.StepThree;
import test.StepOne.StepTwo;
import test.StepOne.LastStep;

public class TestBuilder {

    public static void main(String[] args) {

        String person1 = PersonBuilder.newInstance().head("head").body("body").arm("arm").leg("leg").build();

        String person2 = PersonBuilder.newInstance().head("head").body("body").arm("arm").build();

    }

}

interface StepOne {

    // mandatory
    StepTwo head(String head);

    interface StepTwo {
        // mandatory
        StepThree body(String body);
    }

    interface StepThree {
        // mandatory
        LastStep arm(String arm);
    }

    // all methods in this interface are not mandatory
    interface LastStep {
        LastStep leg(String leg);
        String build();
    }

}

class PersonBuilder implements StepOne, StepTwo, StepThree, LastStep {

    String head;
    String body;
    String arm;
    String leg;

    static StepOne newInstance() {
        return new PersonBuilder();
    }

    private PersonBuilder() {
    }



    public StepTwo head(String head) {
        this.head = head;
        return this;
    }

    public LastStep arm(String arm) {
        this.arm = arm;
        return this;
    }

    public StepThree body(String body) {
        this.body = body;
        return this;
    }

    public LastStep leg(String leg) {
        this.leg = leg;
        return this;
    }

    public String build() {
        return head + body + arm + leg;
    }
}

---

Edit

OP 对这个答案印象深刻，以至于他在 博客。这是对构建器模式的巧妙采用，值得在这里引用完整的处理方法。

Answer 2

我相信正确使用构建器模式可以解决您遇到的问题。

我将创建类 PersonBuilder ，其中包含方法 setBody() 和 setArms() 以及所有其他可选参数设置方法。构建器的构造函数将采用所需的参数。然后方法 build() 将返回 Person 的新实例。

public class PersonBuilder
{
    private final Head head;
    private Body body;
    private Arms arms;

    public PersonBuilder(Head head)
    {
        this.head = head;
    }

    public void setBody(Body body)
    {
        this.body = body;
    }

    public void setArms(Arms arms)
    {
        this.arms = arms;
    }

    public Person build()
    {
        return new Person(head, body, arms);
    }
}

或者，您可以将 Head 参数传递给方法 build()，但我更喜欢将其传递到构造函数中。

Answer 3

编译器没办法。

您可以做的是从构建器未正确初始化的 build() 方法中抛出运行时异常（并在 Maven 测试阶段调用一个测试），

但您也可以使用 build(..) 接受一个 HeadDetails 对象。这样，如果不指定强制参数，就无法调用构建。

Answer 4

如果确实是强制性的并且在 build() 方法中返回 Person，为什么不在 build() 方法中调用 body()、head()、arms() 呢？

[编辑]

简短示例：

public class Builder {

private final String bodyProp;

private final String headProp;

private final String armsProp;

private String hearProps;

public Builder(String bodyProp, String headProp, String armsProp) {
    super();
    this.bodyProp = bodyProp; // check preconditions here (eg not null)
    this.headProp = headProp;
    this.armsProp = armsProp;
}

public void addOptionalHair(String hearProps) {
    this.hearProps = hearProps;
}

public Person build() {
    Person person = new Person();

    person.setBody(buildBody());
    // ...

    return person;
}



private Body buildBody() {
    // do something with bodyProp
    return new Body();
}


public static class Person {

    public void setBody(Body buildBody) {
        // ...
    }
}

public static class Body {
}
}

Answer 5

也许在 build() 内部，您可以检查是否已调用所有必需的方法。也许 Person 实例有一些由 build() 触发的内部健全性检查。

当然，这会检查运行时行为，并且不是您所描述的静态分析。

Answer 6

无法在 Person 的构造函数中调用这些方法吗？