我可以在Java Enum上使用构建器模式吗?

时间:2013-03-14 10:30:09

标签: java enums builder

我正在重写一些代码,我已经决定了重新创建类的方法,因为有固定数量的工作表,我将它们创建为枚举。这是基于构建器模式与伸缩构造器的可读性的决定。

代码我抓住了一些.xls文件,添加了标题(并从其他.xls文件中读取了一些文件),也许还有一些子表格。然后,它以特定的方式将各种这些工作表合并在一起,以在主要的Excel工作簿上制作选项卡。我的问题是,某些工作簿选项卡使用不同数量的工作表作为参数。我正在尝试应用构建器模式。这是我想写的代码:

public enum workBookSheet {
    mySheet1("Name1","mainSheet1.xls",true,1).addSubSheet("pathToSubSheet1.xls"),
    mySheet2("Name2","mainSheet2.xls",true,2).addHeaderSheet("pathToHeaders.xls").addSubsheet("pathtoSubSheet2.xls");

    private String tabName;
    private String mainSheetName;
    private Boolean available;
    private Integer order;
    private String subSheetName;
    private String headerSheetName;

    private workBookSheet(String tabName, String mainSheetName, Boolean available, Integer order){
        this.tabName = tabName;
        this.mainSheetName = mainSheetName;
        this.available = available;
        this.order = order;
    }
    public workBookSheet addSubSheet(String subSheetName){
        this.subSheetName = subSheetName;
        return this;
    }
    public workBookSheet addHeaderSheet(String headerSheetName){
        this.headerSheetName = headerSheetName;
        return this;
    }

}

java给我的错误似乎是说Java期望我的枚举声明(顶部的'枚举构造函数'的逗号分隔列表)只包含其中的构造函数,而不是其他方法。我可以将这些方法移到下面的“构建器”方法中,无需投诉。

public void buildSheets(){
    mySheet1.addSubSheet("pathToSubSheet1.xls");
    mySheet2.addHeaderSheet("pathToHeaders.xls").addSubSheet("pathtoSubSheet2.xls");
}

这是在枚举上实现构建器模式的唯一方法吗?它确实需要我运行一个单独的方法,这不是太麻烦。虽然我确实觉得我打破了这种模式(我想,如果这种方法有效,那就不是一件坏事。)

N.B我好好看看是否有其他人在网上或其他地方提出这个问题。我发现的最接近的是关于Enums和Factories的问题,但这并没有完全回答我的问题。另外我知道这不是构建器模式,因为我没有单独的类,然后接受创建新枚举的build()方法。我想这是我初始设计中问题的根源,但我对Java相对较新。

那么有没有更好的方法在Java枚举上使用构建器模式?或者我的“足够接近”了吗?

3 个答案:

答案 0 :(得分:21)

虽然它并不严格符合建造者模式,但简短的答案是肯定的。排序。

缺少的部分无法调用.build()来实例化枚举常量,因为build()不能使用new。但是你可以从构建器模式中获得很多好处。让我们面对它,你不能使用静态工厂方法,并且枚举常量的内联子类化很奇怪。

以下是使用国家/地区枚举的示例。

package app;

import org.apache.commons.lang.StringUtils;
import javax.annotation.Nullable;
import java.util.EnumSet;
import java.util.Set;
import static app.Language.*;
import static com.google.common.base.Preconditions.*;

enum Language {
    ITALIAN,
    ENGLISH,
    MALTESE
}

public enum Country {

    ITALY(new Builder(1, "Italy").addLanguage(ITALIAN)),
    MALTA(new Builder(2, "Malta").addLanguages(MALTESE, ENGLISH, ITALIAN).setPopulation(450_000));

    final private int id;
    final private String name;
    final private Integer population;
    final private Set<Language> languages;

    private static class Builder {

        private int id;
        private String name;
        private Integer population;
        private Set<Language> languages = EnumSet.noneOf(Language.class);

        public Builder(int id, String name) {
            checkArgument(!StringUtils.isBlank(name));

            this.id = id;
            this.name = name;
        }

        public Builder setPopulation(int population) {
            checkArgument(population > 0);

            this.population = population;
            return this;
        }

        public Builder addLanguage(Language language) {
            checkNotNull(language);

            this.languages.add(language);
            return this;
        }

        public Builder addLanguages(Language... language) {
            checkNotNull(language);

            this.languages.addAll(languages);
            return this;
        }
    }

    private Country(Builder builder) {

        this.id = builder.id;
        this.name = builder.name;
        this.population = builder.population;
        this.languages = builder.languages;

        checkState(!this.languages.isEmpty());
    }

    public int getId() {
        return id;
    }

    public String getName() {
        return name;
    }

    @Nullable
    public Integer getPopulation() {
        return population;
    }

    public Set<Language> getLanguages() {
        return languages;
    }
}

如果您有构建常量的常用方法,甚至可以在构建器中放置静态工厂方法。

所以这不是布洛赫的建造者,但它非常接近。

答案 1 :(得分:4)

您可以使用实例块(通常错误地称为“双括号初始化器”)来使用任意代码自定义构造:

public enum workBookSheet {

    mySheet1("Name1", "mainSheet1.xls", true, 1) {{
        addSubSheet("pathToSubSheet1.xls");
    }},
    mySheet2("Name2", "mainSheet2.xls", true, 2) {{
        // you can use the fluent interface:
        addHeaderSheet("pathToHeaders.xls").addSubSheet("pathtoSubSheet2.xls");
        // but I would prefer coding separate statements:
        addHeaderSheet("pathToHeaders.xls");
        addSubSheet("pathtoSubSheet2.xls");
    }};

    // rest of your class the same...
}

使用此语法可以解决enum所施加的限制,但仍然具有构建器/流畅模式的简洁性,便利性和灵活性。

答案 2 :(得分:1)

mySheet1, mySheet2等是枚举常量,它遵循8.9.1部分中定义的JLS语法

  

EnumConstant:   Annotationsopt Identifier Argumentsopt ClassBodyopt

因此,您可以通过参数列表(传递给构造函数的参数)跟随枚举常量,但是在声明它时不能在枚举常量上调用方法。最多可以为它添加一个类体。

除此之外,构建枚举实例的构建器模式的使用是有问题的,因为通常在具有大量实例(字段值的组合)时使用构建器模式,而与用于少数实例的枚举的概念形成对比实例