为什么建议你使用枚举？

短命女 2023-10-06 11:51 32阅读 0赞

枚举是 JDK 1.5 新增的数据类型，使用枚举我们可以很好的描述一些特定的业务场景，比如一年中的春、夏、秋、冬，还有每周的周一到周天，还有各种颜色，以及可以用它来描述一些状态信息，比如错误码等。

枚举类型不止存在在 Java 语言中，在其它语言中也都能找到它的身影，例如 C\# 和 Python 等，但我发现在实际的项目中使用枚举的人很少，所以本文就来聊一聊枚举的相关内容，好让朋友们对枚举有一个大概的印象，这样在编程时起码还能想到有“枚举”这样一个类型。

本文的结构目录如下：![format_png][]

### 枚举的 7 种使用方法 ###

很多人不使用枚举的一个重要的原因是对枚举不够熟悉，那么我们就先从枚举的 7 种使用方法说起。

#### 用法一：常量 ####

在 JDK 1.5 之前，我们定义常量都是 `public static final...` ，但有了枚举，我们就可以把这些常量定义成一个枚举类了，实现代码如下：

public enum ColorEnum {  
      RED, GREEN, BLANK, YELLOW  
    }

#### 用法二：switch ####

将枚举用在 switch 判断中，使得代码可读性更高了，实现代码如下：

enum ColorEnum {
        GREEN, YELLOW, RED
    }
    public class ColorTest {
        ColorEnum color = ColorEnum.RED;
    
        public void change() {
            switch (color) {
                case RED:
                    color = ColorEnum.GREEN;
                    break;
                case YELLOW:
                    color = ColorEnum.RED;
                    break;
                case GREEN:
                    color = ColorEnum.YELLOW;
                    break;
            }
        }
    }

#### 用法三：枚举中增加方法 ####

我们可以在枚举中增加一些方法，让枚举具备更多的特性，实现代码如下：

public class EnumTest {
        public static void main(String[] args) {
            ErrorCodeEnum errorCode = ErrorCodeEnum.SUCCESS;
            System.out.println("状态码：" + errorCode.code() + 
                               " 状态信息：" + errorCode.msg());
        }
    }
    
    enum ErrorCodeEnum {
        SUCCESS(1000, "success"),
        PARAM_ERROR(1001, "parameter error"),
        SYS_ERROR(1003, "system error"),
        NAMESPACE_NOT_FOUND(2001, "namespace not found"),
        NODE_NOT_EXIST(3002, "node not exist"),
        NODE_ALREADY_EXIST(3003, "node already exist"),
        UNKNOWN_ERROR(9999, "unknown error");
    
        private int code;
        private String msg;
    
        ErrorCodeEnum(int code, String msg) {
            this.code = code;
            this.msg = msg;
        }
    
        public int code() {
            return code;
        }
    
        public String msg() {
            return msg;
        }
    
        public static ErrorCodeEnum getErrorCode(int code) {
            for (ErrorCodeEnum it : ErrorCodeEnum.values()) {
                if (it.code() == code) {
                    return it;
                }
            }
            return UNKNOWN_ERROR;
        }
    }

以上程序的执行结果为：

> 状态码：1000 状态信息：success

#### 用法四：覆盖枚举方法 ####

我们可以覆盖一些枚举中的方法用于实现自己的业务，比如我们可以覆盖 `toString()` 方法，实现代码如下：

public class EnumTest {
        public static void main(String[] args) {
            ColorEnum colorEnum = ColorEnum.RED;
            System.out.println(colorEnum.toString());
        }
    }
    
    enum ColorEnum {
        RED("红色", 1), GREEN("绿色", 2), BLANK("白色", 3), YELLOW("黄色", 4);
        //  成员变量
        private String name;
        private int index;
    
        //  构造方法
        private ColorEnum(String name, int index) {
            this.name = name;
            this.index = index;
        }
    
        //覆盖方法
        @Override
        public String toString() {
            return this.index + "：" + this.name;
        }
    }

以上程序的执行结果为：

> 1：红色

#### 用法五：实现接口 ####

枚举类可以用来实现接口，但不能用于继承类，因为枚举默认继承了 `java.lang.Enum` 类，在 Java 语言中允许实现多接口，但不能继承多个父类，实现代码如下：

public class EnumTest {
        public static void main(String[] args) {
            ColorEnum colorEnum = ColorEnum.RED;
            colorEnum.print();
            System.out.println("颜色：" + colorEnum.getInfo());
        }
    }
    
    interface Behaviour {
        void print();
    
        String getInfo();
    }
    
    enum ColorEnum implements Behaviour {
        RED("红色", 1), GREEN("绿色", 2), BLANK("白色", 3), YELLOW("黄色", 4);
        private String name;
        private int index;
    
        private ColorEnum(String name, int index) {
            this.name = name;
            this.index = index;
        }
    
        @Override
        public void print() {
            System.out.println(this.index + "：" + this.name);
        }
    
        @Override
        public String getInfo() {
            return this.name;
        }
    }

以上程序的执行结果为：

> 1：红色
> 
> 颜色：红色

#### 用法六：在接口中组织枚举类 ####

我们可以在一个接口中创建多个枚举类，用它可以很好的实现“多态”，也就是说我们可以将拥有相同特性，但又有细微实现差别的枚举类聚集在一个接口中，实现代码如下：

public class EnumTest {
        public static void main(String[] args) {
            // 赋值第一个枚举类
            ColorInterface colorEnum = ColorInterface.ColorEnum.RED;
            System.out.println(colorEnum);
            // 赋值第二个枚举类
            colorEnum = ColorInterface.NewColorEnum.NEW_RED;
            System.out.println(colorEnum);
        }
    }
    
    interface ColorInterface {
        enum ColorEnum implements ColorInterface {
            GREEN, YELLOW, RED
        }
        enum NewColorEnum implements ColorInterface {
            NEW_GREEN, NEW_YELLOW, NEW_RED
        }
    }

以上程序的执行结果为：

> RED
> 
> NEW\_RED

#### 用法七：使用枚举集合 ####

在 Java 语言中和枚举类相关的，还有两个枚举集合类 `java.util.EnumSet` 和 `java.util.EnumMap`，使用它们可以实现更多的功能。

使用 `EnumSet` 可以保证元素不重复，并且能获取指定范围内的元素，示例代码如下：

import java.util.ArrayList;
    import java.util.EnumSet;
    import java.util.List;
    
    public class EnumTest {
        public static void main(String[] args) {
            List<ColorEnum> list = new ArrayList<ColorEnum>();
            list.add(ColorEnum.RED);
            list.add(ColorEnum.RED);  // 重复元素
            list.add(ColorEnum.YELLOW);
            list.add(ColorEnum.GREEN);
            // 去掉重复数据
            EnumSet<ColorEnum> enumSet = EnumSet.copyOf(list);
            System.out.println("去重：" + enumSet);
    
            // 获取指定范围的枚举（获取所有的失败状态）
            EnumSet<ErrorCodeEnum> errorCodeEnums = EnumSet.range(ErrorCodeEnum.ERROR, ErrorCodeEnum.UNKNOWN_ERROR);
            System.out.println("所有失败状态：" + errorCodeEnums);
        }
    }
    
    enum ColorEnum {
        RED("红色", 1), GREEN("绿色", 2), BLANK("白色", 3), YELLOW("黄色", 4);
        private String name;
        private int index;
    
        private ColorEnum(String name, int index) {
            this.name = name;
            this.index = index;
        }
    }
    
    enum ErrorCodeEnum {
        SUCCESS(1000, "success"),
        ERROR(2001, "parameter error"),
        SYS_ERROR(2002, "system error"),
        NAMESPACE_NOT_FOUND(2003, "namespace not found"),
        NODE_NOT_EXIST(3002, "node not exist"),
        NODE_ALREADY_EXIST(3003, "node already exist"),
        UNKNOWN_ERROR(9999, "unknown error");
    
        private int code;
        private String msg;
    
        ErrorCodeEnum(int code, String msg) {
            this.code = code;
            this.msg = msg;
        }
    
        public int code() {
            return code;
        }
    
        public String msg() {
            return msg;
        }
    }

以上程序的执行结果为：

> 去重：\[RED, GREEN, YELLOW\]
> 
> 所有失败状态：\[ERROR, SYS\_ERROR, NAMESPACE\_NOT\_FOUND, NODE\_NOT\_EXIST, NODE\_ALREADY\_EXIST, UNKNOWN\_ERROR\]

`EnumMap` 与 `HashMap` 类似，不过它是一个专门为枚举设计的 `Map` 集合，相比 `HashMap` 来说它的性能更高，因为它内部放弃使用链表和红黑树的结构，采用数组作为数据存储的结构。

`EnumMap` 基本使用示例如下：

import java.util.EnumMap;
    
    public class EnumTest {
        public static void main(String[] args) {
            EnumMap<ColorEnum, String> enumMap = new EnumMap<>(ColorEnum.class);
            enumMap.put(ColorEnum.RED, "红色");
            enumMap.put(ColorEnum.GREEN, "绿色");
            enumMap.put(ColorEnum.BLANK, "白色");
            enumMap.put(ColorEnum.YELLOW, "黄色");
            System.out.println(ColorEnum.RED + ":" + enumMap.get(ColorEnum.RED));
        }
    }
    
    enum ColorEnum {
        RED, GREEN, BLANK, YELLOW;
    }

以上程序的执行结果为：

> RED:红色

#### 使用注意事项 ####

阿里《Java开发手册》对枚举的相关规定如下，我们在使用时需要稍微注意一下。

> 【强制】所有的枚举类型字段必须要有注释，说明每个数据项的用途。
> 
> 【参考】枚举类名带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。说明：枚举其实就是特殊的常量类，且构造方法被默认强制是私有。正例：枚举名字为 ProcessStatusEnum 的成员名称：SUCCESS / UNKNOWN\_REASON。

### 假如不使用枚举 ###

在枚举没有诞生之前，也就是 JDK 1.5 版本之前，我们通常会使用 `int` 常量来表示枚举，实现代码如下：

public static final int COLOR_RED = 1;
    public static final int COLOR_BLUE = 2;
    public static final int COLOR_GREEN = 3;

但是使用 `int` 类型可能存在两个问题：

第一， `int` 类型本身并不具备安全性，假如某个程序员在定义 `int` 时少些了一个 `final` 关键字，那么就会存在被其他人修改的风险，而反观枚举类，它“天然”就是一个常量类，不存在被修改的风险（原因详见下半部分）；

第二，使用 `int` 类型的语义不够明确，比如我们在控制台打印时如果只输出 1...2...3 这样的数字，我们肯定不知道它代表的是什么含义。

![format_png 1][]

那有人就说了，那就使用常量字符呗，这总不会还不知道语义吧？实现示例代码如下：

public static final String COLOR_RED = "RED";
    public static final String COLOR_BLUE = "BLUE";
    public static final String COLOR_GREEN = "GREEN";

但是这样同样存在一个问题，有些初级程序员会不按套路出牌，他们可能会直接使用字符串的值进行比较，而不是直接使用枚举的字段，实现示例代码如下：

public class EnumTest {
        public static final String COLOR_RED = "RED";
        public static final String COLOR_BLUE = "BLUE";
        public static final String COLOR_GREEN = "GREEN";
        public static void main(String[] args) {
            String color = "BLUE";
            if ("BLUE".equals(color)) {
                System.out.println("蓝色");
            }
        }
    }

这样当我们修改了枚举中的值，那程序就凉凉了。

### 枚举使用场景 ###

枚举的常见使用场景是单例，它的完整实现代码如下：

public class Singleton {
        // 枚举类型是线程安全的，并且只会装载一次
        private enum SingletonEnum {
            INSTANCE;
            // 声明单例对象
            private final Singleton instance;
            // 实例化
            SingletonEnum() {
                instance = new Singleton();
            }
            private Singleton getInstance() {
                return instance;
            }
        }
        // 获取实例（单例对象）
        public static Singleton getInstance() {
            return SingletonEnum.INSTANCE.getInstance();
        }
        private Singleton() {
        }
        // 类方法
        public void sayHi() {
            System.out.println("Hi,Java.");
        }
    }
    class SingletonTest {
        public static void main(String[] args) {
            Singleton singleton = Singleton.getInstance();
            singleton.sayHi();
        }
    }

因为枚举只会在类加载时装载一次，所以它是线程安全的，这也是《Effective Java》作者极力推荐使用枚举来实现单例的主要原因。

### 知识扩展 ###

#### 枚举为什么是线程安全的？ ####

这一点要从枚举最终生成的字节码说起，首先我们先来定义一个简单的枚举类：

public enum ColorEnumTest {
        RED, GREEN, BLANK, YELLOW;
    }

然后我们再将上面的那段代码编译为字节码，具体内容如下：

public final class ColorEnumTest extends java.lang.Enum<ColorEnumTest> {
      public static final ColorEnumTest RED;
      public static final ColorEnumTest GREEN;
      public static final ColorEnumTest BLANK;
      public static final ColorEnumTest YELLOW;
      public static ColorEnumTest[] values();
      public static ColorEnumTest valueOf(java.lang.String);
      static {};
    }

从上述结果可以看出枚举类最终会被编译为被 `final` 修饰的普通类，它的所有属性也都会被 `static` 和 `final` 关键字修饰，所以枚举类在项目启动时就会被 JVM 加载并初始化，而这个执行过程是线程安全的，所以枚举类也是线程安全的类。

> 小贴士：代码反编译的过程是先用 javac 命令将 java 代码编译字节码（.class），再使用 javap 命令查看编译的字节码。

#### 枚举比较小技巧 ####

我们在枚举比较时使用 == 就够了，因为枚举类是在程序加载时就创建了（它并不是 `new` 出来的），并且枚举类不允许在外部直接使用 `new` 关键字来创建枚举实例，所以我们在使用枚举类时本质上只有一个对象，因此在枚举比较时使用 == 就够了。

并且我们在查看枚举的 `equlas()` 源码会发现，它的内部其实还是直接调用了 == 方法，源码如下：

public final boolean equals(Object other) {
        return this==other;
    }

### 总结 ###

本文我们介绍了枚举类的 7 种使用方法：常量、switch、枚举中添加方法、覆盖枚举方法、实现接口、在接口中组织枚举类和使用枚举集合等，然后讲了如果不使用枚举类使用 `int` 类型和 `String` 类型存在的一些弊端：语义不够清晰、容易被修改、存在被误用的风险，所以我们在适合的环境下应该尽量使用枚举类。并且我们还讲了枚举类的使用场景——单例，以及枚举类为什么是安全的，最后我们讲了枚举比较的小技巧，希望本文对你有帮助。

##### 查看 & 鸣谢 #####

https://www.iteye.com/blog/softbeta-1185573

最后的话原创不易，都看到这了，点个「在看」再走呗，这是对我最大的支持与鼓励，谢谢你！PS：公众号最近改版了，朋友们设置星标，防止错过干货。
    
    往期推荐

[漫画：Java如何实现热更新？][Java]

[阿里《Java开发手册》中的 1 个bug！][Java_ 1 _bug]

关注下方二维码，每天都有干货！

![format_png 2][]

**点亮“在看”，助我写出更多好文！**![format_png 3][]

[format_png]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy9Icld3Nlp1WENzaHM5OVFpY0NzYWozWTY3aWFOYkVDaHpuOTlrR0kwdU1RdWU3UFNQZ3R3VDdwYmpDb2VIMHR5enc5NmZnRjFiaWNXWUswUURXQkFKOTdpY3cvNjQw?x-oss-process=image/format,png
[format_png 1]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy9Icld3Nlp1WENzaHM5OVFpY0NzYWozWTY3aWFOYkVDaHpueTJWN3NaNUxpYWlhZzJ3UXpramF2Q3NNMFlJcnV6N3BlYmd6eVJITUxpY1RaandpYXpMclBnSnhUdy82NDA?x-oss-process=image/format,png
[Java]: https://blog.csdn.net/sufu1065/article/details/106866462
[Java_ 1 _bug]: https://blog.csdn.net/sufu1065/article/details/106581253
[format_png 2]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X2pwZy9zWnlBSnRpYWVzV2NqajRZNmIyUnNZampPNGNtc0E3OXZKY2RyY080RDZxb2t6V1l6NjQ4S2ZQVFNsSWhCeWVKbGZzQmtLaWFzWHR4a2JSTFRUSUxRcGlidy82NDA?x-oss-process=image/format,png
[format_png 3]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X2dpZi9ub3oyancyaFBsV2lhQ3JHdUp4QmljVTVtY2liM1FhcERMeW82ZUtuTlZtOWRQVFY0WjFTaWNITHRyQ0N3T0c5Z2JsTUJGbEtmN3A5Y3Z3TDZ3SWtaSnZhbWcvNjQw?x-oss-process=image/format,png