Java 枚举指南

最后更新：2024年1月5日

作者： baeldung

核心 Java

Enums
参考资料

学习

Scala
Kotlin

使用 OpenRewrite 安全且自动地重构 Java 代码。

手动重构大型代码库既缓慢、有风险，又容易拖延。OpenRewrite 应运而生。这个用于大规模、自动化代码转换的开源框架可以帮助团队安全、一致地进行现代化改造。

每个月，OpenRewrite 的创建者和维护者 Moderne 都会举办现场、实践培训课程——一个面向初学者，一个面向经验丰富的用户。您将了解配方的运作方式、如何将其应用于项目，以及如何自信地进行代码现代化改造。

参加下一次课程，带来您的问题，并学习如何自动化通常会占用您 sprint 时间的工作。

回归测试是发布流程中的重要步骤，以确保新代码不会破坏现有功能。随着代码库的不断发展，我们希望频繁运行这些测试，以便尽早发现任何问题。

确保这些测试以自动化的方式频繁运行的最佳方法当然是将其包含在 CI/CD 管道中。 这样，每次向仓库提交代码时，回归测试将自动执行。

在本教程中，我们将学习如何使用 Selenium 创建回归测试，然后使用 GitHub Actions 将它们包含在我们的管道中，在 LambdaTest 云网格上运行

>> 如何使用 GitHub Actions 运行 Selenium 回归测试

1. 概述

在本教程中，我们将学习什么是 Java 枚举，它们解决了什么问题，以及如何实际应用其设计模式。

检查 Java 中枚举值是否存在

学习在 Java 中搜索枚举的各种方法。

更多信息 →

Java 中扩展枚举

学习如何在 Java 中扩展枚举。

更多信息 →

EnumMap 指南

学习如果你还没有使用 EnumMap，你应该使用它的原因。

更多信息 →

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 方法来确定不同类型的枚举相等。这是因为枚举的值和 getStatus 方法巧合相同；但是，从逻辑上讲，比较应该为 false。我们通过使用“==”运算符来避免这个问题。

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

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 相比，它是一种非常高效且紧凑的特定 Set 的 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.
}

执行以下测试展示了 EnumSet 实现 Set 接口的强大功能

@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;
}

执行以下测试展示了 EnumMap 实现 Map 接口的强大功能

@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. 单例模式

通常，使用单例模式实现一个类相当复杂。枚举提供了一种快速简便的实现单例的方法。

此外，由于枚举类在底层实现了 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 类，看看使用 lambda 和 Stream API 后，getAllUndeliveredPizzas() 和 groupPizzaByStatus() 方法变得多么简洁

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. 枚举的 JSON 表示

使用 Jackson 库，可以将枚举类型表示为 POJO，就像它们是普通 Java 对象一样。在下面的代码片段中，我们将看到如何使用 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 – Serialize Enums as JSON Objects。

10. 结论

在本文中，我们探讨了 Java 枚举，从语言基础知识到更高级和有趣的实际用例。

支持本文的代码可在 GitHub 上获取。一旦你以 Baeldung Pro 会员身份登录，就开始学习并在项目上进行编码。

使用 Spring Boot 进行 RESTful API 开发

学习 Spring Security

学习 Spring

学习 Spring Data JPA

查看所有课程

学习 JUnit

学习 Maven

学习 Hibernate JPA

学习 Mockito

学习 Java Streams 和 Lambdas

学习 Java 基础

完整存档

Baeldung 电子书

关于 Baeldung

1. 概述

更多阅读

检查 Java 中枚举值是否存在

Java 中扩展枚举

EnumMap 指南

2. 自定义枚举方法

3. 使用“==”运算符比较枚举类型

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

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

6. EnumSet 和 EnumMap

6.1. EnumSet

6.2. EnumMap

7. 使用枚举实现设计模式

7.1. 单例模式

7.2. 策略模式

8. Java 8 和枚举

9. 枚举的 JSON 表示

10. 结论