乐趣区

关于java:用好-Java-中的枚举让你的工作效率飞起来

送大家以下 java 学习材料,文末有支付形式


1. 概览

在本文中,咱们将看到什么是 Java 枚举,它们解决了哪些问题以及如何在实践中应用  Java 枚举实现一些设计模式。

enum 关键字在 java5 中引入,示意一种非凡类型的类,其总是继承 java.lang.Enum 类,更多内容能够自行查看其官网文档。

枚举在很多时候会和常量拿来比照,可能因为自身咱们大量理论应用枚举的中央就是为了代替常量。那么这种形式由什么劣势呢?

以这种形式定义的常量使代码更具可读性,容许进行编译时查看,事后记录可承受值的列表,并防止因为传入有效值而引起的意外行为。

上面示例定义一个简略的枚举类型 pizza 订单的状态,共有三种 ORDERED, READY, DELIVERED 状态:

package shuang.kou.enumdemo.enumtest;

publicenum PizzaStatus {
    ORDERED,
    READY,
    DELIVERED;
}

简略来说,咱们通过下面的代码防止了定义常量,咱们将所有和 pizza 订单的状态的常量都对立放到了一个枚举类型外面。

System.out.println(PizzaStatus.ORDERED.name());//ORDERED
System.out.println(PizzaStatus.ORDERED);//ORDERED
System.out.println(PizzaStatus.ORDERED.name().getClass());//class java.lang.String
System.out.println(PizzaStatus.ORDERED.getClass());//class shuang.kou.enumdemo.enumtest.PizzaStatus

2. 自定义枚举办法

当初咱们对枚举是什么以及如何应用它们有了根本的理解,让咱们通过在枚举上定义一些额定的 API 办法,将上一个示例晋升到一个新的程度:

publicclass Pizza {
    private PizzaStatus status;
    publicenum PizzaStatus {
        ORDERED,
        READY,
        DELIVERED;
    }

    public boolean isDeliverable() {if (getStatus() == PizzaStatus.READY) {returntrue;}
        returnfalse;
    }

    // Methods that set and get the status variable.
}

3. 应用 == 比拟枚举类型

因为枚举类型确保 JVM 中仅存在一个常量实例,因而咱们能够平安地应用“==”运算符比拟两个变量,如上例所示;此外,“==”运算符可提供编译时和运行时的安全性。

首先,让咱们看一下以下代码段中的运行时安全性,其中“==”运算符用于比拟状态,并且如果两个值均为 null 都不会引发 NullPointerException。相同,如果应用 equals 办法,将抛出 NullPointerException:

if(testPz.getStatus().equals(Pizza.PizzaStatus.DELIVERED));
if(testPz.getStatus() == Pizza.PizzaStatus.DELIVERED);

对于编译时安全性,咱们看另一个示例,两个不同枚举类型进行比拟,应用 equal 办法比拟后果确定为 true,因为 getStatus 办法的枚举值与另一个类型枚举值统一,但逻辑上应该为 false。这个问题能够应用 == 操作符防止。因为编译器会示意类型不兼容谬误:

if(testPz.getStatus().equals(TestColor.GREEN));
if(testPz.getStatus() == TestColor.GREEN);

4. 在 switch 语句中应用枚举类型

public int getDeliveryTimeInDays() {switch (status) {
        case ORDERED: return5;
        case READY: return2;
        case DELIVERED: return0;
    }
    return0;
}

5. 枚举类型的属性, 办法和构造函数

你能够通过在枚举类型中定义属性, 办法和构造函数让它变得更加弱小。

上面,让咱们扩大下面的示例,实现从比萨的一个阶段到另一个阶段的过渡,并理解如何解脱之前应用的 if 语句和 switch 语句:

publicclass Pizza {

    private PizzaStatus status;
    publicenum PizzaStatus {ORDERED (5){
            @Override
            public boolean isOrdered() {returntrue;}
        },
        READY (2){
            @Override
            public boolean isReady() {returntrue;}
        },
        DELIVERED (0){
            @Override
            public boolean isDelivered() {returntrue;}
        };

        privateint timeToDelivery;

        public boolean isOrdered() {returnfalse;}

        public boolean isReady() {returnfalse;}

        public boolean isDelivered(){returnfalse;}

        public int getTimeToDelivery() {return timeToDelivery;}

        PizzaStatus (int timeToDelivery) {this.timeToDelivery = timeToDelivery;}
    }

    public boolean isDeliverable() {returnthis.status.isReady();
    }

    public void printTimeToDeliver() {
        System.out.println("Time to delivery is" +
          this.getStatus().getTimeToDelivery());
    }

    // Methods that set and get the status variable.
}

上面这段代码展现它是如何 work 的:

@Test
public void givenPizaOrder_whenReady_thenDeliverable() {Pizza testPz = new Pizza();
    testPz.setStatus(Pizza.PizzaStatus.READY);
    assertTrue(testPz.isDeliverable());
}

6.EnumSet and EnumMap

6.1. EnumSet

EnumSet 是一种专门为枚举类型所设计的 Set 类型。

HashSet 相比,因为应用了外部位向量示意,因而它是特定 Enum 常量集的十分无效且紧凑的示意模式。

它提供了类型平安的代替办法,以代替传统的基于 int 的“位标记”,使咱们可能编写更易读和易于保护的简洁代码。

EnumSet 是抽象类,其有两个实现:RegularEnumSetJumboEnumSet,抉择哪一个取决于实例化时枚举中常量的数量。

在很多场景中的枚举常量汇合操作(如:取子集、减少、删除、containsAllremoveAll 批操作)应用 EnumSet 十分适合;如果须要迭代所有可能的常量则应用Enum.values()

publicclass Pizza {

    privatestatic EnumSet<PizzaStatus> undeliveredPizzaStatuses =
      EnumSet.of(PizzaStatus.ORDERED, PizzaStatus.READY);

    private PizzaStatus status;

    publicenum PizzaStatus {...}

    public boolean isDeliverable() {returnthis.status.isReady();
    }

    public void printTimeToDeliver() {
        System.out.println("Time to delivery is" +
          this.getStatus().getTimeToDelivery() + "days");
    }

    public static List<Pizza> getAllUndeliveredPizzas(List<Pizza> input) {return input.stream().filter((s) -> undeliveredPizzaStatuses.contains(s.getStatus()))
            .collect(Collectors.toList());
    }

    public void deliver() {if (isDeliverable()) {PizzaDeliverySystemConfiguration.getInstance().getDeliveryStrategy()
              .deliver(this);
            this.setStatus(PizzaStatus.DELIVERED);
        }
    }

    // Methods that set and get the status variable.
}

上面的测试演示了展现了 EnumSet 在某些场景下的弱小性能:

@Test
public void givenPizaOrders_whenRetrievingUnDeliveredPzs_thenCorrectlyRetrieved() {List<Pizza> pzList = new ArrayList<>();
    Pizza pz1 = new Pizza();
    pz1.setStatus(Pizza.PizzaStatus.DELIVERED);

    Pizza pz2 = new Pizza();
    pz2.setStatus(Pizza.PizzaStatus.ORDERED);

    Pizza pz3 = new Pizza();
    pz3.setStatus(Pizza.PizzaStatus.ORDERED);

    Pizza pz4 = new Pizza();
    pz4.setStatus(Pizza.PizzaStatus.READY);

    pzList.add(pz1);
    pzList.add(pz2);
    pzList.add(pz3);
    pzList.add(pz4);

    List<Pizza> undeliveredPzs = Pizza.getAllUndeliveredPizzas(pzList);
    assertTrue(undeliveredPzs.size() == 3);
}

6.2. EnumMap

EnumMap是一个专门化的映射实现,用于将枚举常量用作键。与对应的 HashMap 相比,它是一个高效紧凑的实现,并且在外部示意为一个数组:

EnumMap<Pizza.PizzaStatus, Pizza> map;

让咱们疾速看一个实在的示例,该示例演示如何在实践中应用它:

publicstatic EnumMap<PizzaStatus, List<Pizza>>
  groupPizzaByStatus(List<Pizza> pizzaList) {
    EnumMap<PizzaStatus, List<Pizza>> pzByStatus =
      new EnumMap<PizzaStatus, List<Pizza>>(PizzaStatus.class);

    for (Pizza pz : pizzaList) {PizzaStatus status = pz.getStatus();
        if (pzByStatus.containsKey(status)) {pzByStatus.get(status).add(pz);
        } else {List<Pizza> newPzList = new ArrayList<Pizza>();
            newPzList.add(pz);
            pzByStatus.put(status, newPzList);
        }
    }
    return pzByStatus;
}

上面的测试演示了展现了 EnumMap 在某些场景下的弱小性能:

@Test
public void givenPizaOrders_whenGroupByStatusCalled_thenCorrectlyGrouped() {List<Pizza> pzList = new ArrayList<>();
    Pizza pz1 = new Pizza();
    pz1.setStatus(Pizza.PizzaStatus.DELIVERED);

    Pizza pz2 = new Pizza();
    pz2.setStatus(Pizza.PizzaStatus.ORDERED);

    Pizza pz3 = new Pizza();
    pz3.setStatus(Pizza.PizzaStatus.ORDERED);

    Pizza pz4 = new Pizza();
    pz4.setStatus(Pizza.PizzaStatus.READY);

    pzList.add(pz1);
    pzList.add(pz2);
    pzList.add(pz3);
    pzList.add(pz4);

    EnumMap<Pizza.PizzaStatus,List<Pizza>> map = Pizza.groupPizzaByStatus(pzList);
    assertTrue(map.get(Pizza.PizzaStatus.DELIVERED).size() == 1);
    assertTrue(map.get(Pizza.PizzaStatus.ORDERED).size() == 2);
    assertTrue(map.get(Pizza.PizzaStatus.READY).size() == 1);
}

7. 通过枚举实现一些设计模式

7.1 单例模式

通常,应用类实现 Singleton 模式并非易事,枚举提供了一种实现单例的简便办法。

《Effective Java》和《Java 与模式》都十分举荐这种形式,应用这种形式形式实现枚举能够有什么益处呢?

《Effective Java》

这种办法在性能上与私有域办法相近,然而它更加简洁,无偿提供了序列化机制,相对避免屡次实例化,即便是在面对简单序列化或者反射攻打的时候。尽管这种办法还没有宽泛采纳,然而单元素的枚举类型曾经成为实现 Singleton 的最佳办法。—-《Effective Java 中文版 第二版》

《Java 与模式》

《Java 与模式》中,作者这样写道,应用枚举来实现单实例管制会更加简洁,而且无偿地提供了序列化机制,并由 JVM 从根本上提供保障,相对避免屡次实例化,是更简洁、高效、平安的实现单例的形式。

上面的代码段显示了如何应用枚举实现单例模式:

publicenum PizzaDeliverySystemConfiguration {
    INSTANCE;
    PizzaDeliverySystemConfiguration() {
        // Initialization configuration which involves
        // overriding defaults like delivery strategy
    }

    private PizzaDeliveryStrategy deliveryStrategy = PizzaDeliveryStrategy.NORMAL;

    public static PizzaDeliverySystemConfiguration getInstance() {return INSTANCE;}

    public PizzaDeliveryStrategy getDeliveryStrategy() {return deliveryStrategy;}
}

如何应用呢?请看上面的代码:

PizzaDeliveryStrategy deliveryStrategy = PizzaDeliverySystemConfiguration.getInstance().getDeliveryStrategy();

通过 PizzaDeliverySystemConfiguration.getInstance() 获取的就是单例的 PizzaDeliverySystemConfiguration

7.2 策略模式

通常,策略模式由不同类实现同一个接口来实现的。

这也就意味着增加新策略意味着增加新的实现类。应用枚举,能够轻松实现此工作,增加新的实现意味着只定义具备某个实现的另一个实例。

上面的代码段显示了如何应用枚举实现策略模式:

publicenum PizzaDeliveryStrategy {
    EXPRESS {
        @Override
        public void deliver(Pizza pz) {System.out.println("Pizza will be delivered in express mode");
        }
    },
    NORMAL {
        @Override
        public void deliver(Pizza pz) {System.out.println("Pizza will be delivered in normal mode");
        }
    };

    public abstract void deliver(Pizza pz);
}

Pizza减少上面的办法:

public void deliver() {if (isDeliverable()) {PizzaDeliverySystemConfiguration.getInstance().getDeliveryStrategy()
          .deliver(this);
        this.setStatus(PizzaStatus.DELIVERED);
    }
}

如何应用呢?请看上面的代码:

@Test
public void givenPizaOrder_whenDelivered_thenPizzaGetsDeliveredAndStatusChanges() {Pizza pz = new Pizza();
    pz.setStatus(Pizza.PizzaStatus.READY);
    pz.deliver();
    assertTrue(pz.getStatus() == Pizza.PizzaStatus.DELIVERED);
}

8. Java 8 与枚举

Pizza 类能够用 Java 8 重写,您能够看到办法 lambda 和 Stream API 如何使 getAllUndeliveredPizzas()groupPizzaByStatus() 办法变得如此简洁:

getAllUndeliveredPizzas():

public static List<Pizza> getAllUndeliveredPizzas(List<Pizza> input) {return input.stream().filter((s) -> !deliveredPizzaStatuses.contains(s.getStatus()))
        .collect(Collectors.toList());
}

groupPizzaByStatus() :

publicstatic EnumMap<PizzaStatus, List<Pizza>>
  groupPizzaByStatus(List<Pizza> pzList) {EnumMap<PizzaStatus, List<Pizza>> map = pzList.stream().collect(
      Collectors.groupingBy(Pizza::getStatus,
      () -> new EnumMap<>(PizzaStatus.class), Collectors.toList()));
    return map;
}

9. Enum 类型的 JSON 表现形式

应用 Jackson 库,能够将枚举类型的 JSON 示意为 POJO。上面的代码段显示了能够用于同一目标的 Jackson 批注:

@JsonFormat(shape = JsonFormat.Shape.OBJECT)
publicenum PizzaStatus {ORDERED (5){
        @Override
        public boolean isOrdered() {returntrue;}
    },
    READY (2){
        @Override
        public boolean isReady() {returntrue;}
    },
    DELIVERED (0){
        @Override
        public boolean isDelivered() {returntrue;}
    };

    privateint timeToDelivery;

    public boolean isOrdered() {returnfalse;}

    public boolean isReady() {returnfalse;}

    public boolean isDelivered(){returnfalse;}

    @JsonProperty("timeToDelivery")
    public int getTimeToDelivery() {return timeToDelivery;}

    private PizzaStatus (int timeToDelivery) {this.timeToDelivery = timeToDelivery;}
}

咱们能够按如下形式应用 PizzaPizzaStatus

Pizza pz = new Pizza();
pz.setStatus(Pizza.PizzaStatus.READY);
System.out.println(Pizza.getJsonString(pz));

生成 Pizza 状态以以下 JSON 展现:

{
  "status" : {
    "timeToDelivery" : 2,
    "ready" : true,
    "ordered" : false,
    "delivered" : false
  },
  "deliverable" : true
}

无关枚举类型的 JSON 序列化 / 反序列化(包含自定义)的更多信息,请参阅 Jackson- 将枚举序列化为 JSON 对象。

10. 总结

本文咱们探讨了 Java 枚举类型,从基础知识到高级利用以及理论利用场景,让咱们感触到枚举的弱小性能。

11. 补充

咱们在下面讲到了,咱们能够通过在枚举类型中定义属性, 办法和构造函数让它变得更加弱小。

上面我通过一个理论的例子展现一下,当咱们调用短信验证码的时候可能有几种不同的用处,咱们在上面这样定义:

publicenum PinType {REGISTER(100000, "注册应用"),
    FORGET_PASSWORD(100001, "遗记明码应用"),
    UPDATE_PHONE_NUMBER(100002, "更新手机号码应用");

    privatefinalint code;
    privatefinal String message;

    PinType(int code, String message) {
        this.code = code;
        this.message = message;
    }

    public int getCode() {return code;}

    public String getMessage() {return message;}

    @Override
    public String toString() {
        return"PinType{" +
                "code=" + code +
                ", message='" + message + '\'' +
                '}';
    }
}

理论应用:

System.out.println(PinType.FORGET_PASSWORD.getCode());
System.out.println(PinType.FORGET_PASSWORD.getMessage());
System.out.println(PinType.FORGET_PASSWORD.toString());

Output:

100001
遗记明码应用
PinType{code=100001, message='遗记明码应用'}

这样的话,在理论应用起来就会非常灵活不便!

退出移动版