百日筑基第三十九天-关于枚举的一切
枚举的用法
1 背景
在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
)。接下来的章节将介绍枚举类型的定义、特征、应用场景和优缺点。
2 定义
枚举类型(enum type
)是指由一组固定的常量组成合法的类型。Java
中由关键字enum
来定义一个枚举类型。下面就是java
枚举类型的定义。
public enum Season { SPRING, SUMMER, AUTUMN, WINTER; }
3 特点
Java
定义枚举类型的语句很简约。它有以下特点:
使用关键字
enum
类型名称,比如这里的
Season
一串允许的值,比如上面定义的春夏秋冬四季
枚举可以单独定义在一个文件中,也可以嵌在其它
Java
类中
除了这样的基本要求外,用户还有一些其他选择
枚举可以实现一个或多个接口(Interface)
可以定义新的变量
可以定义新的方法
可以定义根据具体枚举值而相异的类
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(); } }
[中文:春天,枚举常量:SPRING,数据:1] [中文:夏天,枚举常量:SUMMER,数据:2] [中文:秋天,枚举常量:AUTUMN,数据:3] [中文:冬天,枚举常量:WINTER,数据:4]
这里有一个问题,为什么我要将域添加到枚举类型中呢?目的是想将数据与它的常量关联起来。如1代表春天,2代表夏天。
5 总结
那么什么时候应该使用枚举呢?每当需要一组固定的常量的时候,如一周的天数、一年四季等。或者是在我们编译前就知道其包含的所有值的集合。Java 1.5的枚举能满足绝大部分程序员的要求的,它的简明,易用的特点是很突出的。
6 用法
用法一:常量
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 SE5提供了一种新的类型-Java的枚举类型,关键字enum可以将一组具名的值的有限集合创建为一种新的类型,而这些具名的值可以作为常规的程序组件使用,这是一种非常有用的功能。
要想看源码,首先得有一个类吧,那么枚举类型到底是什么类呢?是enum吗?答案很明显不是,enum就和class一样,只是一个关键字,他并不是一个类,那么枚举是由什么类维护的呢,我们简单的写一个枚举:
public enum t { SPRING,SUMMER; }
然后我们使用反编译,看看这段代码到底是怎么实现的,反编译后代码内容如下:
public final class T extends Enum { private T(String s, int i) { super(s, i); } public static T[] values() { T at[]; int i; T at1[]; System.arraycopy(at = ENUM$VALUES, 0, at1 = new T[i = at.length], 0, i); return at1; } public static T valueOf(String s) { return (T)Enum.valueOf(demo/T, s); } public static final T SPRING; public static final T SUMMER; private static final T ENUM$VALUES[]; static { SPRING = new T("SPRING", 0); SUMMER = new T("SUMMER", 1); ENUM$VALUES = (new T[] { SPRING, SUMMER }); } }
通过反编译代码我们可以看到,public final class T extends Enum,说明,该类是继承了Enum类的,同时final关键字告诉我们,这个类也是不能被继承的。
当我们使用enmu来定义一个枚举类型的时候,编译器会自动帮我们创建一个final类型的类继承Enum类,所以枚举类型不能被继承。
枚举与单例
使用枚举实现单例是众多实现单例的方法中最优的方法(大多数人认为这么认为,其次是双检锁),虽然还没有广泛采用。
我们简单对比下“双重校验锁”方式和枚举方式实现单例的代码。
“双重校验锁”实现单例:
public class Singleton { private volatile static Singleton singleton; private Singleton (){} public static Singleton getSingleton() { if (singleton == null) { synchronized (Singleton.class) { if (singleton == null) { singleton = new Singleton(); } } } return singleton; } }
枚举实现单例:
public enum Singleton { INSTANCE; public void whateverMethod() { } }
相比之下,你就会发现,枚举实现单例的代码会精简很多。
上面的双重锁校验的代码之所以很臃肿,是因为大部分代码都是在保证线程安全。为了在保证线程安全和锁粒度之间做权衡,代码难免会写的复杂些。但是,这段代码还是有问题的,因为他无法解决反序列化会破坏单例的问题。
枚举可解决线程安全问题
上面提到过。使用非枚举的方式实现单例,都要自己来保证线程安全,所以,这就导致其他方法必然是比较臃肿的。那么,为什么使用枚举就不需要解决线程安全问题呢?
其实,并不是使用枚举就不需要保证线程安全,只不过线程安全的保证不需要我们关心而已。也就是说,其实在“底层”还是做了线程安全方面的保证的。
那么,“底层”到底指的是什么?
定义枚举时使用enum和class一样,是Java中的一个关键字。就像class对应用一个Class类一样,enum也对应有一个Enum类。
通过将定义好的枚举反编译,我们就能发现,其实枚举在经过javac
的编译之后,会被转换成形如public final class T extends Enum
的定义。
而且,枚举中的各个枚举项同时通过static
来定义的。如:
public enum T { SPRING,SUMMER,AUTUMN,WINTER; }
反编译后代码为:
public final class T extends Enum { //省略部分内容 public static final T SPRING; public static final T SUMMER; public static final T AUTUMN; public static final T WINTER; private static final T ENUM$VALUES[]; static { SPRING = new T("SPRING", 0); SUMMER = new T("SUMMER", 1); AUTUMN = new T("AUTUMN", 2); WINTER = new T("WINTER", 3); ENUM$VALUES = (new T[] { SPRING, SUMMER, AUTUMN, WINTER }); } }
了解JVM的类加载机制的朋友应该对这部分比较清楚。static
类型的属性会在类被加载之后被初始化,当一个Java类第一次被真正使用到的时候静态资源被初始化、Java类的加载和初始化过程都是线程安全的(因为虚拟机在加载枚举的类的时候,会使用ClassLoader的loadClass方法,而这个方法使用同步代码块保证了线程安全)。所以,创建一个enum类型是线程安全的。
也就是说,我们定义的一个枚举,在第一次被真正用到的时候,会被虚拟机加载并初始化,而这个初始化过程是线程安全的。而我们知道,解决单例的并发问题,主要解决的就是初始化过程中的线程安全问题。
所以,由于枚举的以上特性,枚举实现的单例是天生线程安全的。
枚举可解决反序列化会破坏单例的问题
使用双重校验锁实现的单例其实是存在一定问题的,就是这种单例有可能被序列化锁破坏。
在序列化的时候Java仅仅是将枚举对象的name属性输出到结果中,反序列化的时候则是通过java.lang.Enum
的valueOf
方法来根据名字查找枚举对象。同时,编译器是不允许任何对这种序列化机制的定制的,因此禁用了writeObject
、readObject
、readObjectNoData
、writeReplace
和readResolve
等方法。
普通的Java类的反序列化过程中,会通过反射调用类的默认构造函数来初始化对象。所以,即使单例中构造函数是私有的,也会被反射给破坏掉。由于反序列化后的对象是重新new出来的,所以这就破坏了单例。
但是,枚举的反序列化并不是通过反射实现的。所以,也就不会发生由于反序列化导致的单例破坏问题。
总结
在所有的单例实现方式中,枚举是一种在代码写法上最简单的方式,之所以代码十分简洁,是因为Java给我们提供了enum
关键字,我们便可以很方便的声明一个枚举类型,而不需要关心其初始化过程中的线程安全问题,因为枚举类在被虚拟机加载的时候会保证线程安全的被初始化。
除此之外,在序列化方面,Java中有明确规定,枚举的序列化和反序列化是有特殊定制的。这就可以避免反序列化过程中由于反射而导致的单例被破坏问题。
Enum类
Java中定义枚举是使用enum关键字的,但是Java中其实还有一个java.lang.Enum类。这是一个抽象类,定义如下:
package java.lang; public abstract class Enum<E extends Enum<E>> implements Constable, Comparable<E>, Serializable { private final String name; private final int ordinal; }
这个类我们在日常开发中不会用到,但是其实我们使用enum定义的枚举,其实现方式就是通过继承Enum类实现的。
当我们使用enum来定义一个枚举类型的时候,编译器会自动帮我们创建一个final类型的类继承Enum类,所以枚举类型不能被继承。
Java枚举如何比较
java 枚举值比较用 == 和 equals 方法没啥区别,两个随便用都是一样的效果。
因为枚举 Enum 类的 equals 方法默认实现就是通过 == 来比较的;
类似的 Enum 的 compareTo 方法比较的是 Enum 的 ordinal 顺序大小;
类似的还有 Enum 的 name 方法和 toString 方法一样都返回的是 Enum 的 name 值。
switch对枚举的支持
Java 1.7 之前 switch 参数可用类型为 short、byte、int、char,枚举类型之所以能使用其实是编译器层面实现的
编译器会将枚举 switch 转换为类似
switch(s.ordinal()) { case Status.START.ordinal() }
形式,所以实质还是 int 参数类型,感兴趣的可以自己写个使用枚举的 switch 代码然后通过 javap -v 去看下字节码就明白了。