枚举：为什么？ 什么时候？

Question

我是一名即将毕业的计算机科学专业的学生，​​在我的整个编码生涯中，我发现很少使用枚举的实例，除了典型情况下（例如代表标准纸牌的面孔）。

您是否知道在日常编码中使用枚举的任何巧妙方法？

为什么枚举如此重要？在什么情况下应该能够确定建立枚举是最好的方法？

Answer 1

通过简短示例，这些是enum ， EnumMap和EnumSet的主要参数。

enum的情况

从Java 6开始， java.util.Calendar是一个凌乱类的示例，该类可以从使用enum受益匪浅（除其他改进外）。

当前Calendar定义了以下常量（ 以及许多其他常量）：

// int constant antipattern from java.util.Calendar
public static final int JANUARY = 0;
public static final int FEBRUARY = 1;
...
public static final int SUNDAY = 1;
public static final int MONDAY = 2;
...

这些都是int ，即使它们显然表示不同的概念实体。

以下是一些严重的后果：

• 它很脆 ； 在需要时必须小心分配不同的编号。
  • 如果错误地将MONDAY = 0;设置MONDAY = 0; ， SUNDAY = 0; ，那么我们有MONDAY == SUNDAY
• 没有名称空间，没有类型安全性 ，因为一切都只是一个int ：
  • 我们可以设置setMonth(JANUARY) ，但是也可以设置setMonth(THURSDAY)或setMonth(42)
  • 谁知道set(int,int,int,int,int,int) （一个真正的方法！）的作用！

相比之下，我们可能会有类似这样的内容：

// Hypothetical enums for a Calendar library
enum Month {
   JANUARY, FEBRUARY, ...
}
enum DayOfWeek {
   SUNDAY, MONDAY, ...
}

现在，我们不必担心MONDAY == SUNDAY （永远不会发生！），并且由于Month和DayOfWeek是不同的类型，因此setMonth(MONDAY)不会编译。

此外，以下是一些前后代码：

// BEFORE with int constants
for (int month = JANUARY; month <= DECEMBER; month++) {
   ...
}

在这里，我们进行各种假设，例如JANUARY + 1 == FEBRUARY等。另一方面， enum对应项既更简洁，更易读，又做出更少的假设（因此，发生错误的机会也更少）：

// AFTER with enum
for (Month month : Month.values()) {
   ...
}

---

实例字段的情况

在Java中， enum是一class具有许多特殊的性质，而是一个class尽管如此，允许您根据需要来定义实例方法和字段。

考虑以下示例：

// BEFORE: with int constants
public static final int NORTH = 0;
public static final int EAST  = 1;
public static final int SOUTH = 2;
public static final int WEST  = 3;

public static int degreeFor(int direction) {
   return direction * 90; // quite an assumption!
   // must be kept in-sync with the int constants!
}

//...
for (int dir = NORTH; dir <= WEST; dir++) {
   ... degreeFor(dir) ...
}

另一方面，使用enum可以编写如下代码：

enum Direction {
   NORTH(0), EAST(90), SOUTH(180), WEST(270);
   // so obvious! so easy to read! so easy to write! so easy to maintain!

   private final int degree;
   Direction(int degree)      { this.degree = degree; }
   public int getDegree()     { return degree; }
}

//...
for (Direction dir : Direction.values()) {
   ... dir.getDegree() ...
}

实例方法的情况

考虑以下示例：

static int apply(int op1, int op2, int operator) {
   switch (operator) {
      case PLUS  : return op1 + op2;
      case MINUS : return op1 - op2;
      case ...
      default: throw new IllegalArgumentException("Unknown operator!");
   }
}

如前面的示例所示，Java中的enum可以具有实例方法，不仅如此，而且每个常量也可以具有自己的特定@Override 。 如下代码所示：

enum Operator {
    PLUS  { int apply(int op1, int op2) { return op1 + op2; } },
    MINUS { int apply(int op1, int op2) { return op1 - op2; } },
    ...
    ;
    abstract int apply(int op1, int op2);
}

---

EnumMap的情况

这是来自Effective Java 2nd Edition的引用：

永远不要从其ordinal()派生出与enum关联的值； 而是将其存储在实例字段中。 （ 第31项：使用实例字段代替序数 ）很少使用序数为数组建立索引：而是使用EnumMap 。 一般原则是应用程序程序员应该很少（如果有的话）使用Enum.ordinal 。 （ 项目33：使用EnumMap代替顺序索引 ）

从本质上讲，您可能会像这样：

// BEFORE, with int constants and array indexing
Employee[] employeeOfTheMonth = ...

employeeOfTheMonth[JANUARY] = jamesBond;

现在您可以拥有：

// AFTER, with enum and EnumMap
Map<Month, Employee> employeeOfTheMonth = ...

employeeOfTheMonth.put(Month.JANUARY, jamesBond);

---

EnumSet的情况

例如，在C ++中经常使用两个int常数的幂来表示位集。 这依赖于按位运算 。 一个例子可能看起来像这样：

public static final int BUTTON_A = 1;
public static final int BUTTON_B = 2;
public static final int BUTTON_X = 4;
public static final int BUTTON_Y = 8;

int buttonState = BUTTON_A | BUTTON_X; // A & X are pressed!

if ((buttonState & BUTTON_B) != 0) {   // B is pressed...
   ...
}

使用enum和EnumSet ，可以看起来像这样：

enum Button {
  A, B, X, Y;
}

Set<Button> buttonState = EnumSet.of(Button.A, Button.X); // A & X are pressed!

if (buttonState.contains(Button.B)) { // B is pressed...
   ...
}

参考文献

• Java语言指南/枚举 -包含许多示例的完整处理

也可以看看

• 有效的Java第二版
  • 条款30：使用enum代替int常量
  • 条款31：使用实例字段代替普通字段
  • 项目32：使用EnumSet代替位字段
  • 项目33：使用EnumMap代替顺序索引

相关问题

• Java中的枚举。 好处？
• 有没有一种类似于C的方法来从Java枚举中获取项目编号？ -是的， ordinal() ，但是...
• 使用Enum的序数值来索引Java中的数组是否是不好的做法？ -很可能是！
• [java]每个枚举项的编号？ EnumSet的主要候选人！

Answer 2

在Java 1.5之前定义为String / int常量的内容，现在应定义为枚举。 例如，与其具有：

public class StatusConstants {
   public int ACTIVE = 1;
   public int SUSPENDED = 2;
   public int TEMPORARY_INACTIVE = 3;
   public int NOT_CONFIRMED = 4;
}

您现在有了一个更安全，更友好的开发人员：

public enum Status {
   ACTIVE, SUSPENDED, TEMPORARY_INACTIVE, NOT_CONFIRMED
}

对于具有多个选项的任何内容（包括状态，街道类型（str。，boul。，rd。等），用户访问级别（管理员，主持人，普通用户）等），同样适用。

检查此示例以获取更多示例和说明。

Answer 3

考虑一些简单的代码：

没有枚举：

 int OPT_A_ON = 1;
 int OPT_A_OFF = 0;

 int OPT_B_ON = 1;
 int OPT_B_OFF = 0;

 SetOption(OPT_A_ON, OPT_B_OFF);    // Declaration: SetOption(int, int)

看起来不错吧？ 除了SetOptions（）首先需要选项B，然后要选项A。这将很好地通过编译器，但是在运行时，将选项向后设置。

现在，使用枚举：

  enum OptA {On =1, Off = 0};
  enum OptB {On =1, Off = 0};

  SetOption(OptA.On, OptB.Off);// Declaration: SetOption(OptB, OptA)

现在我们犯了同样的错误，但是这次，由于枚举是不同的类型，因此该错误被编译器捕获。

（注意：我不是真正的Java程序员，所以请原谅语法错误）

Answer 4

我认为您在谈论的是枚举，而不是枚举。

枚举非常适合应用程序中可能使用“魔术字符串”或“魔术数字”的任何地方。

最容易理解它们的用法的区域是文件访问。 每种文件访问模式（读，写，追加）在枚举中表示。 如果您使用的是“魔术数字”，则可能会出现以下内容：

public static class Constants
{
    public static final int FILEMODE_READ = 1;
    public static final int FILEMODE_WRITE = 2;
    public static final int FILEMODE_APPEND = 3;
}

当您可以使用枚举更清楚，更简洁地表达意图时：

public enum FileMode
{
    Read,
    Write,
    Append
}

Answer 5

默认答案：所有Java开发人员都应明确阅读Effective Java Second Edition 。 有一章关于枚举

Answer 6

枚举非常适合表示事物的状态。 我经常使用如下枚举：

public enum PlayerState {
    WALKING, STANDING, JUMPING...
}

枚举和派生类之间始终要保持平衡。 为了给出一个简单的例子，考虑一下Cat类。 Cats有不同程度的敌意。 因此，我们可以使派生类为HostileCat ， FriendlyCat等。但是，猫， Lions ， Tigers等也有不同类型。突然，我们有了一大堆Cat对象。 因此，另一种解决方案是在Cat类中提供一个Hostility枚举，从而减少派生类的数量和总体复杂度。

Answer 7

正如Manuel Selva所建议的那样，请阅读Effective Java Second Edition ，同时还要阅读singleton部分。 使用枚举是拥有干净的单例对象的最简单方法 。