什么是java枚举?
原始的接口定义常量
public interface IConstants {
String MON = "Mon";
String TUE = "Tue";
String WED = "Wed";
String THU = "Thu";
String FRI = "Fri";
String SAT = "Sat";
String SUN = "Sun";
}
语法(定义)
创建枚举类型要使用 enum 关键字,隐含了所创建的类型都是 java.lang.Enum 类的子类(java.lang.Enum 是一个抽象类)。枚举类型符合通用模式 Class Enum<E extends Enum>,而 E 表示枚举类型的名称。枚举类型的每一个值都将映射到 protected Enum(String name, int ordinal) 构造函数中,在这里,每个值的名称都被转换成一个字符串,并且序数设置表示了此设置被创建的顺序。
/**
* 枚举测试类
* @author <a href="mailto:hemingwang0902@126.com">何明旺</a>
*/
public enum EnumTest {
MON, TUE, WED, THU, FRI, SAT, SUN;
}
这段代码实际上调用了7次 Enum(String name, int ordinal):
new Enum<EnumTest>("MON",0);
new Enum<EnumTest>("TUE",1);
new Enum<EnumTest>("WED",2);
... ...
遍历、switch 等常用操作
对enum进行遍历和switch的操作示例代码:
public class Test {
public static void main(String[] args) {
for (EnumTest e : EnumTest.values()) {
System.out.println(e.toString());
}
System.out.println("----------------我是分隔线------------------");
EnumTest test = EnumTest.TUE;
switch (test) {
case MON:
System.out.println("今天是星期一");
break;
case TUE:
System.out.println("今天是星期二");
break;
// ... ...
default:
System.out.println(test);
break;
}
}
}
输出结果:
MON
TUE
WED
THU
FRI
SAT
SUN
enum 对象的常用方法介绍
- int compareTo(E o)
- 比较此枚举与指定对象的顺序。
- Class getDeclaringClass()
- 返回与此枚举常量的枚举类型相对应的 Class 对象。
- String name()
- 返回此枚举常量的名称,在其枚举声明中对其进行声明。
- int ordinal()
- 返回枚举常量的序数(它在枚举声明中的位置,其中初始常量序数为零)。
- String toString()
- 返回枚举常量的名称,它包含在声明中。
- static <T extends Enum> T valueOf(Class enumType, String name)
- 返回带指定名称的指定枚举类型的枚举常量。
public class Test {
public static void main(String[] args) {
EnumTest test = EnumTest.TUE;
//compareTo(E o)
switch (test.compareTo(EnumTest.MON)) {
case -1:
System.out.println("TUE 在 MON 之前");
break;
case 1:
System.out.println("TUE 在 MON 之后");
break;
default:
System.out.println("TUE 与 MON 在同一位置");
break;
}
//getDeclaringClass()
System.out.println("getDeclaringClass(): " + test.getDeclaringClass().getName());
//name() 和 toString()
System.out.println("name(): " + test.name());
System.out.println("toString(): " + test.toString());
//ordinal(), 返回值是从 0 开始
System.out.println("ordinal(): " + test.ordinal());
}
}
输出结果:
TUE 在 MON 之后
getDeclaringClass(): com.hmw.test.EnumTest
name(): TUE
toString(): TUE
ordinal(): 1
给 enum 自定义属性和方法
给 enum 对象加一下 value 的属性和 getValue() 的方法:
public enum EnumTest {
MON(1), TUE(2), WED(3), THU(4), FRI(5), SAT(6) {
@Override
public boolean isRest() {
return true;
}
},
SUN(0) {
@Override
public boolean isRest() {
return true;
}
};
private int value;
private EnumTest(int value) {
this.value = value;
}
public int getValue() {
return value;
}
public boolean isRest() {
return false;
}
}
public class Test {
public static void main(String[] args) {
System.out.println("EnumTest.FRI 的 value = " + EnumTest.FRI.getValue());
}
}
输出结果:
EnumTest.FRI 的 value = 5
EnumSet,EnumMap 的应用
public class Test {
public static void main(String[] args) {
// EnumSet的使用
EnumSet<EnumTest> weekSet = EnumSet.allOf(EnumTest.class);
for (EnumTest day : weekSet) {
System.out.println(day);
}
// EnumMap的使用
EnumMap<EnumTest, String> weekMap = new EnumMap(EnumTest.class);
weekMap.put(EnumTest.MON, "星期一");
weekMap.put(EnumTest.TUE, "星期二");
Iterator<Entry<EnumTest, String>> iter = weekMap.entrySet().iterator()
// ... ...
while (iter.hasNext()) {
Entry<EnumTest, String> entry = iter.next();
System.out.println(entry.getKey().name() + ":" + entry.getValue());
}
}
}
原理分析
enum 的语法结构尽管和 class 的语法不一样,但是经过编译器编译之后产生的是一个class文件。该class文件经过反编译可以看到实际上是生成了一个类,该类继承了java.lang.Enum。EnumTest 经过反编译(javap com.hmw.test.EnumTest 命令)之后得到的内容如下:
public class com.hmw.test.EnumTest extends java.lang.Enum{
public static final com.hmw.test.EnumTest MON;
public static final com.hmw.test.EnumTest TUE;
public static final com.hmw.test.EnumTest WED;
public static final com.hmw.test.EnumTest THU;
public static final com.hmw.test.EnumTest FRI;
public static final com.hmw.test.EnumTest SAT;
public static final com.hmw.test.EnumTest SUN;
static {};
public int getValue();
public boolean isRest();
public static com.hmw.test.EnumTest[] values();
public static com.hmw.test.EnumTest valueOf(java.lang.String);
com.hmw.test.EnumTest(java.lang.String, int, int, com.hmw.test.EnumTest);
}
所以,实际上 enum 就是一个 class,只不过 java 编译器帮我们做了语法的解析和编译而已。
values()方法,在编译过程中产生
总结
可以把 enum 看成是一个普通的 class,它们都可以定义一些属性和方法,不同之处是:enum 不能使用 extends 关键字继承其他类,因为 enum 已经继承了 java.lang.Enum(java是单一继承)。
为什么要用java枚举?
需求背景
假设现在有两种订单类型:预订订单和非预订订单。
- 需求一: 方法submitOrder根据不同订单类型进行不同的处理。
- 需求二: 给一个对象: OrderResult设置订单类型。
实现方式
1.不使用枚举
public class EnumTest {
private static final int ORDER_TYPE1 = 1;
private static final int ORDER_TYPE2 = 2;
public void submitOrder(int orderType,OrderResult orderResult){
orderResult.setType(orderType);
if(orderType == ORDER_TYPE1){
System.out.println("订单类型1处理方法");
}else if(orderType == ORDER_TYPE2){
System.out.println("订单类型2处理方法");
}
}
public static void main(String[] args) {
EnumTest test = new EnumTest();
test.submitOrder(3, new OrderResult());
}
}
从代码中可以看到几点缺点:
- int参数不做类型检查,可以给上面的submitOrder方法传入任意int值
- 代码可读性低,如果没有文档或者源码,不知道给submitOrder传递的值的意义。
很多人在使用int枚举时,并没有像上例中将int值定义成static final。如果忘记定义变量为final则int枚举的值就可以被修改,如果忘记定义变量为static,就可能出现使用这个int值时,该int值还没有被初始化好。
2.枚举实现
public class EnumTest1 {
private enum ORDER_TYPE{
ORDER_TYPE1(1),ORDER_TYPE2(2);
private final int value;
private ORDER_TYPE(int value){
this.value = value;
}
}
public void submitOrder(ORDER_TYPE orderType,OrderResult orderResult){
orderResult.setType(orderType.value);
if(orderType == ORDER_TYPE.ORDER_TYPE1){
System.out.println("订单类型1处理方法");
}else if(orderType == ORDER_TYPE.ORDER_TYPE2){
System.out.println("订单类型2处理方法");
}
}
public static void main(String[] args) {
EnumTest1 test = new EnumTest1();
test.submitOrder(ORDER_TYPE.ORDER_TYPE1, new OrderResult());
}
}
- 编译器将对enum进行类型检查,类型不符合的编译器会直接报错。
- 相比与int枚举型直接传int数值的方式,enum传递enum类型对象的方式,代码可读性更高,传递的枚举类型一目了然。
- enum类型中的对象本身就是static final的。
误区
private enum ORDER_TYPE{
ORDER_TYPE1(1),ORDER_TYPE2(2);
private final int value;
private ORDER_TYPE(int value){
this.value = value;
}
}
enum本质也是一个类,所以方法ORDER_TYPE(int value)是这个枚举类型的构造函数,故每个枚举类型在初始化的时候需要给构造函数传递响应的值,如: ORDER_TYPE1(1)。
这种情况下,想得到枚举类型对应的int数值时可以通过ORDER_TYPE.ORDER_TYPE1.value获取。
有些人可能会直接使用enum中的ordinal()方法直接实现enum类型与int类型的关联。ordinal()方法返回的是enum类型在被定义时的序数,如:
ORDER_TYPE.ORDER_TYPE1.value.ordinal()返回值为0。所以获取枚举类型对应的int数值貌似也可以通过ORDER_TYPE.PRE_ORDER.value.ordinal()+1实现。
序数是很不可靠的东西,序数是可以改变的,假设有一天ORDER_TYPE的定义变了,需要增加几种类型,或者不小心换了ORDER_TYPE1和ORDER_TYPE2定义时的顺序,这时就会造成很严重的bug,而且不好发现,编译时,运行时都不会有报错