Java枚举类型简介

2018-03-27 2603 words 6 minutes

Contents

1. 概述

在本教程中，我们将了解 Java 枚举是什么，它们解决了哪些问题，以及如何在实践中使用它们的一些设计模式。 **Java 5 首次引入了enum关键字。**它表示一种特殊类型的类，它总是扩展java.lang.Enum类。有关使用的官方文档，我们可以前往文档。

以这种方式定义的常量使代码更具可读性，允许编译时检查，预先记录接受值的列表，并避免由于传入无效值而导致的意外行为。

这是一个定义披萨订单状态的快速简单的枚举示例；订单状态可以是ORDERED、READY或DELIVERED：

public enum PizzaStatus {
    ORDERED,
    READY, 
    DELIVERED; 
}

此外，枚举带有许多有用的方法，如果我们使用传统的公共静态最终常量，我们将需要编写这些方法。

2. 自定义枚举方法

现在我们对枚举是什么以及如何使用它们有了基本的了解，我们将通过在枚举上定义一些额外的 API 方法，将前面的示例提升到一个新的水平：

public class Pizza {
    private PizzaStatus status;
    public enum PizzaStatus {
        ORDERED,
        READY,
        DELIVERED;
    }
    public boolean isDeliverable() {
        if (getStatus() == PizzaStatus.READY) {
            return true;
        }
        return false;
    }
    
    // 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);

至于编译时安全性，让我们看一个示例，我们将通过使用equals方法进行比较来确定不同类型的枚举是否相等。这是因为 enum 和getStatus方法的值恰好是相同的；但是，从逻辑上讲，比较应该是错误的。我们通过使用“==”运算符来避免这个问题。

编译器会将比较标记为不兼容错误：

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

4. 在 Switch 语句中使用枚举类型

我们也可以在switch语句中使用枚举类型：

public int getDeliveryTimeInDays() {
    switch (status) {
        case ORDERED: return 5;
        case READY: return 2;
        case DELIVERED: return 0;
    }
    return 0;
}

5. 枚举中的字段、方法和构造函数

我们可以在枚举类型中定义构造函数、方法和字段，这使得它们非常强大。

接下来，让我们通过实现从披萨订单的一个阶段到另一个阶段的转换来扩展上面的示例。我们将看到如何摆脱之前使用的if和switch语句：

public class Pizza {
    private PizzaStatus status;
    public enum PizzaStatus {
        ORDERED (5){
            @Override
            public boolean isOrdered() {
                return true;
            }
        },
        READY (2){
            @Override
            public boolean isReady() {
                return true;
            }
        },
        DELIVERED (0){
            @Override
            public boolean isDelivered() {
                return true;
            }
        };
        private int timeToDelivery;
        public boolean isOrdered() {return false;}
        public boolean isReady() {return false;}
        public boolean isDelivered(){return false;}
        public int getTimeToDelivery() {
            return timeToDelivery;
        }
        PizzaStatus (int timeToDelivery) {
            this.timeToDelivery = timeToDelivery;
        }
    }
    public boolean isDeliverable() {
        return this.status.isReady();
    }
    public void printTimeToDeliver() {
        System.out.println("Time to delivery is " + 
          this.getStatus().getTimeToDelivery());
    }
    
    // Methods that set and get the status variable.
}

下面的测试片段演示了它是如何工作的：

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

6. EnumSet和EnumMap

6.1. EnumSet

EnumSet是一个专门的Set实现，旨在与Enum类型一起使用。

与HashSet相比，由于使用了内部位向量表示，它是一组特定Enum常量的非常有效和紧凑的表示。它还为传统的基于int的“位标志”提供了一种类型安全的替代方案，使我们能够编写更易读和更易于维护的简洁代码。

EnumSet是一个抽象类，它有两个实现，RegularEnumSet和JumboEnumSet，其中一个是根据实例化时枚举中常量的数量来选择的。

因此，在大多数情况下（如子集、添加、删除和批量操作，如containsAll和removeAll），只要我们想使用枚举常量集合，最好使用这个集合，如果我们使用*Enum.values()*只想遍历所有可能的常量。

在下面的代码片段中，我们可以看到如何使用EnumSet创建常量子集：

public class Pizza {
    private static EnumSet<PizzaStatus> undeliveredPizzaStatuses =
      EnumSet.of(PizzaStatus.ORDERED, PizzaStatus.READY);
    private PizzaStatus status;
    public enum PizzaStatus {
        ...
    }
    public boolean isDeliverable() {
        return this.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.
}

执行以下测试演示了Set接口的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是一种专门的Map实现，旨在与枚举常量一起用作键。与其对应的HashMap 相比，它是一种高效且紧凑的实现，内部表示为数组：

EnumMap<Pizza.PizzaStatus, Pizza> map;

让我们看一个如何在实践中使用它的示例：

public static 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;
}

执行以下测试演示了Map接口的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. 单例模式

通常，使用单例模式实现一个类是非常重要的。枚举提供了一种实现单例的快速简便的方法。

此外，由于 enum 类在底层实现了Serializable接口，因此该类被 JVM 保证为单例。这与传统实现不同，在传统实现中，我们必须确保在反序列化期间不会创建新实例。

在下面的代码片段中，我们看到了如何实现单例模式：

public enum 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;
    }
}

7.2. 策略模式

传统上，策略模式是通过具有由不同类实现的接口来编写的。

添加新策略意味着添加新的实现类。使用枚举，我们可以用更少的努力来实现这一点，并且添加一个新的实现意味着简单地定义另一个具有一些实现的实例。

下面的代码片段展示了如何实现策略模式：

public enum 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 和枚举

我们可以在 Java 8 中重写Pizza类，看看getAllUndeliveredPizzas()和groupPizzaByStatus()方法如何通过使用 lambda 和Stream API 变得如此简洁：

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

public static 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)
public enum PizzaStatus {
    ORDERED (5){
        @Override
        public boolean isOrdered() {
            return true;
        }
    },
    READY (2){
        @Override
        public boolean isReady() {
            return true;
        }
    },
    DELIVERED (0){
        @Override
        public boolean isDelivered() {
            return true;
        }
    };
    private int timeToDelivery;
    public boolean isOrdered() {return false;}
    public boolean isReady() {return false;}
    public boolean isDelivered(){return false;}
    @JsonProperty("timeToDelivery")
    public int getTimeToDelivery() {
        return timeToDelivery;
    }
    private PizzaStatus (int timeToDelivery) {
        this.timeToDelivery = timeToDelivery;
    }
}

我们可以使用Pizza和PizzaStatus如下：

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对象。