美文网首页
Java的枚举类型用法介绍

Java的枚举类型用法介绍

作者: 莫生人 | 来源:发表于2021-06-28 11:37 被阅读0次

    背景

    在java语言中还没有引入枚举类型之前,表示枚举类型的常用模式是声明一组具有int常量的类。之前我们通常利用public final static 方法定义的代码如下,分别用1 表示春天,2表示夏天,3表示秋天,4表示冬天。

    public class Season {
        public static final int SPRING = 1;
        public static final int SUMMER = 2;
        public static final int AUTUMN = 3;
        public static final int WINTER = 4;
    }
    

    这种方法称作int枚举模式。可这种模式有什么问题呢,我们都用了那么久了,应该没问题的。通常我们写出来的代码都会考虑它的安全性、易用性和可读性。 首先我们来考虑一下它的类型安全性。当然这种模式不是类型安全的。比如说我们设计一个函数,要求传入春夏秋冬的某个值。但是使用int类型,我们无法保证传入的值为合法。代码如下所示:

    private String getChineseSeason(int season){
            StringBuffer result = new StringBuffer();
            switch(season){
                case Season.SPRING :
                    result.append("春天");
                    break;
                case Season.SUMMER :
                    result.append("夏天");
                    break;
                case Season.AUTUMN :
                    result.append("秋天");
                    break;
                case Season.WINTER :
                    result.append("冬天");
                    break;
                default :
                    result.append("地球没有的季节");
                    break;
            }
            return result.toString();
        }
    
        public void doSomething(){
            System.out.println(this.getChineseSeason(Season.SPRING));//这是正常的场景
            System.out.println(this.getChineseSeason(5));//这个却是不正常的场景,这就导致了类型不安全问题
        }
    

    程序getChineseSeason(Season.SPRING)是我们预期的使用方法。可getChineseSeason(5)显然就不是了,而且编译能通过,在运行时会出现什么情况,我们就不得而知了。这显然就不符合Java程序的类型安全。

    接下来我们来考虑一下这种模式的可读性。使用枚举的大多数场合,我都需要方便得到枚举类型的字符串表达式。如果将int枚举常量打印出来,我们所见到的就是一组数字,这是没什么太大的用处。我们可能会想到使用String常量代替int常量。虽然它为这些常量提供了可打印的字符串,但是它会导致性能问题,因为它依赖于字符串的比较操作,所以这种模式也是我们不期望的。 从类型安全性和程序可读性两方面考虑,int和String枚举模式的缺点就显露出来了。幸运的是,从Java1.5发行版本开始,就提出了另一种可以替代的解决方案,可以避免int和String枚举模式的缺点,并提供了许多额外的好处。那就是枚举类型(enum type)。接下来的章节将介绍枚举类型的定义、特征、应用场景和优缺点。

    定义

    枚举类型(enum type)是指由一组固定的常量组成合法的类型。Java中由关键字enum来定义一个枚举类型。下面就是java枚举类型的定义。

    public abstract class Enum<E extends Enum<E>> implements Comparable<E>, Serializable
    

    示例如下:

    public enum Season {
        SPRING, SUMMER, AUTUMN, WINER;
    }
    

    1.抽象类

    首先,抽象类不能被实例化,所以我们在java程序中不能使用new关键字来声明一个Enum,如果想要定义可以使用这样的语法:

    enum enumName{
        value1,value2
        method1(){}
        method2(){}
    }
    

    其次,看到抽象类,第一印象是肯定有类继承他。至少我们应该是可以继承他的,所以:

    public class testEnum extends Enum{
    }
    public class testEnum extends Enum<Enum<E>>{
    }
    public class testEnum<E> extends Enum<Enum<E>>{
    }
    

    尝试了以上三种方式之后,得出以下结论:Enum类无法被继承。
    为什么一个抽象类不让继承?enum定义的枚举是怎么来的?难道不是对Enum的一种继承吗?带着这些疑问我们来反编译以下代码:

    enum Color {RED, BLUE, GREEN}
    

    编译器将会把他转成如下内容:

    public final class Color extends Enum<Color> {
      public static final Color[] values() { return (Color[])$VALUES.clone(); }
      public static Color valueOf(String name) { ... }
    
      private Color(String s, int i) { super(s, i); }
    
      public static final Color RED;
      public static final Color BLUE;
      public static final Color GREEN;
    
      private static final Color $VALUES[];
    
      static {
        RED = new Color("RED", 0);
        BLUE = new Color("BLUE", 1);
        GREEN = new Color("GREEN", 2);
        $VALUES = (new Color[] { RED, BLUE, GREEN });
      }
    } 
    

    短短的一行代码,被编译器处理过之后竟然变得这么多,看来,enmu关键字是java提供给我们的一个语法糖啊。。。从反编译之后的代码中,我们发现,编译器不让我们继承Enum,但是当我们使用enum关键字定义一个枚举的时候,他会帮我们在编译后默认继承java.lang.Enum类,而不像其他的类一样默认继承Object类。且采用enum声明后,该类会被编译器加上final声明,故该类是无法继承的。 PS:由于JVM类初始化是线程安全的,所以可以采用枚举类实现一个线程安全的单例模式。

    2.实现Comparable和Serializable接口

    Enum实现了Serializable接口,可以序列化。 Enum实现了Comparable接口,可以进行比较,默认情况下,只有同类型的enum才进行比较(原因见后文),要实现不同类型的enum之间的比较,只能复写compareTo方法。

    3.泛型:<E extends Enum<E>>

    怎么理解<E extends Enum<E>>?

    首先,这样写只是为了让Java的API更有弹性,他主要是限定形态参数实例化的对象,故要求只能是Enum,这样才能对 compareTo 之类的方法所传入的参数进行形态检查。所以,我们完全可以不必去关心他为什么这么设计。

    为什么Java要这样定义Enum

    首先我们来科普一下enum:

    enum Color{
        RED,GREEN,YELLOW
    }
    enum Season{
        SPRING,SUMMER,WINTER
    }
    public class EnumTest{
        public static void main(String[] args) {
            System.out.println(Color.RED.ordinal());
            System.out.println(Season.SPRING.ordinal());
        }
    }
    

    代码中两处输出内容都是 0 ,因为枚举类型的默认的序号都是从零开始的。
    要理解这个问题,首先我们来看一个Enum类中的方法(暂时忽略其他成员变量和方法):

    public abstract class Enum<E extends Enum<E>> implements Comparable<E>, Serializable {
            private final int ordinal;
    
            public final int compareTo(E o) {
            Enum other = (Enum)o;
            Enum self = this;
            if (self.getClass() != other.getClass() && // optimization
                self.getDeclaringClass() != other.getDeclaringClass())
                throw new ClassCastException();
            return self.ordinal - other.ordinal;
        }
    }
    

    首先我们认为Enum的定义中没有使用Enum<E extends Enum<E>>,那么compareTo方法就要这样定义(因为没有使用泛型,所以就要使用Object,这也是Java中很多方法常用的方式):

    public final int compareTo(Object o) 
    

    当我们调用compareTo方法的时候依然传入两个枚举类型,在compareTo方法的实现中,比较两个枚举的过程是先将参数转化成Enum类型,然后再比较他们的序号是否相等。那么我们这样比较:

    Color.RED.compareTo(Color.RED);
    Color.RED.compareTo(Season.SPRING);
    

    如果在compareTo方法中不做任何处理的话,那么以上这段代码返回内容将都是true(因为Season.SPRING的序号和Color.RED的序号都是 0 )。但是,很明显, Color.RED和Season.SPRING并不相等。
    但是Java使用Enum<E extends Enum<E>>声明Enum,并且在compareTo的中使用E作为参数来避免了这种问题。 以上两个条件限制Color.RED只能和Color定义出来的枚举进行比较,当我们试图使用Color.RED.compareTo(Season.SPRING);这样的代码时,会报出这样的错误:

    The method compareTo(Color) in the type Enum<Color> is not applicable for the arguments (Season)
    

    他说明,compareTo方法只接受Enum<Color>类型。
    Java为了限定形态参数实例化的对象,故要求只能是Enum,这样才能对 compareTo之类的方法所传入的参数进行形态检查。 因为“红色”只有和“绿色”比较才有意义,用“红色”和“春天”比较毫无意义,所以,Java用这种方式一劳永逸的保证像compareTo这样的方法可以正常的使用而不用考虑类型。

    PS:在Java中,其实也可以实现“红色”和“春天”比较,因为Enum实现了Comparable接口,可以重写compareTo方法来实现不同的enum之间的比较。

    成员变量

    在Enum中,有两个成员变量,一个是名字(name),一个是序号(ordinal)。 序号是一个枚举常量,表示在枚举中的位置,从0开始,依次递增。

    private final String name;
    public final String name() {
        return name;
    }
    private final int ordinal;
    public final int ordinal() {
        return ordinal;
    }
    

    构造函数

    前面我们说过,Enum是一个抽象类,不能被实例化,但是他也有构造函数,从前面我们反编译出来的代码中,我们也发现了Enum的构造函数,在Enum中只有一个保护类型的构造函数:

    protected Enum(String name, int ordinal) {
        this.name = name;
        this.ordinal = ordinal;
    }
    

    文章开头反编译的代码中private Color(String s, int i) { super(s, i); }中的super(s, i);就是调用Enum中的这个保护类型的构造函数来初始化name和ordinal。

    其他方法

    Enum当中有以下这么几个常用方法,调用方式就是使用Color.RED.methodName(params...)的方式调用:

    public String toString() {
        return name;
    }
    
    public final boolean equals(Object other) {
        return this==other;
    }
    
    public final int hashCode() {
        return super.hashCode();
    }
    
    public final int compareTo(E o) {
        Enum other = (Enum)o;
        Enum self = this;
        if (self.getClass() != other.getClass() && // optimization
            self.getDeclaringClass() != other.getDeclaringClass())
            throw new ClassCastException();
        return self.ordinal - other.ordinal;
    }
    
    public final Class<E> getDeclaringClass() {
        Class clazz = getClass();
        Class zuper = clazz.getSuperclass();
        return (zuper == Enum.class) ? clazz : zuper;
    }
    
    public static <T extends Enum<T>> T valueOf(Class<T> enumType,String name) {
        T result = enumType.enumConstantDirectory().get(name);
        if (result != null)
            return result;
        if (name == null)
            throw new NullPointerException("Name is null");
        throw new IllegalArgumentException(
            "No enum constant " + enumType.getCanonicalName() + "." + name);
    }
    

    特点

    Java定义枚举类型的语句很简约。它有以下特点:

    1. 使用关键字enum;
    2. 类型名称,比如这里的Season;
    3. 一串允许的值,比如上面定义的春夏秋冬四季;
    4. 枚举可以单独定义在一个文件中,也可以嵌在其它Java类中;

    除了这样的基本要求外,用户还有一些其他选择:

    1. 枚举可以实现一个或多个接口(Interface);
    2. 可以定义新的变量;
    3. 可以定义新的方法;
    4. 可以定义根据具体枚举值而相异的类。

    应用场景

    以在背景中提到的类型安全为例,用枚举类型重写那段代码。代码如下:

    public enum Season {
        SPRING(1), SUMMER(2), AUTUMN(3), WINTER(4);
    
        private int code;
        private Season(int code){
            this.code = code;
        }
    
        public int getCode(){
            return code;
        }
    }
    public class UseSeason {
        /**
         * 将英文的季节转换成中文季节
         * @param season
         * @return
         */
        public String getChineseSeason(Season season){
            StringBuffer result = new StringBuffer();
            switch(season){
                case SPRING :
                    result.append("[中文:春天,枚举常量:" + season.name() + ",数据:" + season.getCode() + "]");
                    break;
                case AUTUMN :
                    result.append("[中文:秋天,枚举常量:" + season.name() + ",数据:" + season.getCode() + "]");
                    break;
                case SUMMER : 
                    result.append("[中文:夏天,枚举常量:" + season.name() + ",数据:" + season.getCode() + "]");
                    break;
                case WINTER :
                    result.append("[中文:冬天,枚举常量:" + season.name() + ",数据:" + season.getCode() + "]");
                    break;
                default :
                    result.append("地球没有的季节 " + season.name());
                    break;
            }
            return result.toString();
        }
    
        public void doSomething(){
            for(Season s : Season.values()){
                System.out.println(getChineseSeason(s));//这是正常的场景
            }
            //System.out.println(getChineseSeason(5));
            //此处已经是编译不通过了,这就保证了类型安全
        }
    
        public static void main(String[] arg){
            UseSeason useSeason = new UseSeason();
            useSeason.doSomething();
        }
    }
    

    这里有一个问题,为什么要将域添加到枚举类型中呢?目的是想将数据与它的常量关联起来。如1代表春天,2代表夏天。

    总结

    那么什么时候应该使用枚举呢?每当需要一组固定的常量的时候,如一周的天数、一年四季等。或者是在我们编译前就知道其包含的所有值的集合。Java 1.5的枚举能满足绝大部分程序员的要求的,它的简明,易用的特点是很突出的。

    用法

    用法一:常量

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

    用法二:switch

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

    用法三:向枚举中添加新方法

    public enum Color {  
        RED("红色", 1), GREEN("绿色", 2), BLANK("白色", 3), YELLO("黄色", 4);  
        // 成员变量  
        private String name;  
        private int index;  
        // 构造方法  
        private Color(String name, int index) {  
            this.name = name;  
            this.index = index;  
        }  
        // 普通方法  
        public static String getName(int index) {  
            for (Color c : Color.values()) {  
                if (c.getIndex() == index) {  
                    return c.name;  
                }  
            }  
            return null;  
        }  
        // get set 方法  
        public String getName() {  
            return name;  
        }  
        public void setName(String name) {  
            this.name = name;  
        }  
        public int getIndex() {  
            return index;  
        }  
        public void setIndex(int index) {  
            this.index = index;  
        }  
    }  
    

    用法四:覆盖枚举的方法

    public enum Color {  
        RED("红色", 1), GREEN("绿色", 2), BLANK("白色", 3), YELLO("黄色", 4);  
        // 成员变量  
        private String name;  
        private int index;  
        // 构造方法  
        private Color(String name, int index) {  
            this.name = name;  
            this.index = index;  
        }  
        //覆盖方法  
        @Override  
        public String toString() {  
            return this.index+"_"+this.name;  
        }  
    }
    

    用法五:实现接口

    public interface Behaviour {  
        void print();  
        String getInfo();  
    }  
    
    public enum Color implements Behaviour{  
        RED("红色", 1), GREEN("绿色", 2), BLANK("白色", 3), YELLO("黄色", 4);  
        // 成员变量  
        private String name;  
        private int index;  
        // 构造方法  
        private Color(String name, int index) {  
            this.name = name;  
            this.index = index;  
        }  
    
        //接口方法  
        @Override  
        public String getInfo() {  
            return this.name;  
        }  
    
        //接口方法  
        @Override  
        public void print() {  
            System.out.println(this.index+":"+this.name);  
        }  
    }  
    

    用法六:使用接口组织枚举

    public interface Food {  
        enum Coffee implements Food{  
            BLACK_COFFEE,DECAF_COFFEE,LATTE,CAPPUCCINO  
        }
        enum Dessert implements Food{  
            FRUIT, CAKE, GELATO  
        }  
    }
    

    相关文章

      网友评论

          本文标题:Java的枚举类型用法介绍

          本文链接:https://www.haomeiwen.com/subject/txmxultx.html