enum 的全称为 enumeration, 是 JDK 1.5 中引入的新特性,存放在 java.lang 包中。
下面是我在使用 enum 过程中的一些经验和总结,主要包括如下内容:
1. 原始的接口定义常量
2. 语法(定义)
7. enum 的原理分析
8. 总结
原始的接口定义常量
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>>
,而 E
表示枚举类型的名称。枚举类型的每一个值都将映射到protected Enum(String name, int ordinal)
构造函数中,在这里,每个值的名称都被转换成一个字符串,并且序数设置表示了此设置被创建的顺序。
package
com.hmw.test;
/**
* 枚举测试类
* @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<E>
getDeclaringClass()
返回与此枚举常量的枚举类型相对应的 Class 对象。
String
name()
返回此枚举常量的名称,在其枚举声明中对其进行声明。
int
ordinal()
返回枚举常量的序数(它在枚举声明中的位置,其中初始常量序数为零)。
String
toString()
返回枚举常量的名称,它包含在声明中。
static
<T extends Enum<T>> T
valueOf(Class<T> 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() 的方法:
package
com.hmw.test;
/**
* 枚举测试类
*
* @author <a href="mailto:hemingwang0902@126.com">何明旺</a>
*/
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,
"星期二"
);
// ... ...
for
(Iterator<Entry<EnumTest, String>> iter = weekMap.entrySet().iterator(); iter.hasNext();) {
Entry<EnumTest, String> entry = iter.next();
System.out.println(entry.getKey().name() +
":"
+ entry.getValue());
}
}
}
|
原理分析
enum 的语法结构尽管和 class 的语法不一样,但是经过编译器编译之后产生的是一个class文件。该class文件经过反编译可以看到实际上是生成了一个类,该类继承了java.lang.Enum<E>。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,它们都可以定义一些属性和方法,不同之处是:enum 不能使用 extends 关键字继承其他类,因为 enum 已经继承了 java.lang.Enum(java是单一继承)。
转载来的一个例子
package com.ljq.test;
/**
* 枚举用法详解
*
* @author jiqinlin
*
*/
public class TestEnum {
/**
* 普通枚举
*
* @author jiqinlin
*
*/
public enum ColorEnum {
red, green, yellow, blue;
}
/**
* 枚举像普通的类一样可以添加属性和方法,可以为它添加静态和非静态的属性或方法
*
* @author jiqinlin
*
*/
public enum SeasonEnum {
//注:枚举写在最前面,否则编译出错
spring, summer, autumn, winter;
private final static String position = "test";
public static SeasonEnum getSeason() {
if ("test".equals(position))
return spring;
else
return winter;
}
}
/**
* 性别
*
* 实现带有构造器的枚举
*
* @author jiqinlin
*
*/
public enum Gender{
//通过括号赋值,而且必须带有一个参构造器和一个属性跟方法,否则编译出错
//赋值必须都赋值或都不赋值,不能一部分赋值一部分不赋值;如果不赋值则不能写构造器,赋值编译也出错
MAN("MAN"), WOMEN("WOMEN");
private final String value;
//构造器默认也只能是private, 从而保证构造函数只能在内部使用
Gender(String value) {
this.value = value;
}
public String getValue() {
return value;
}
}
/**
* 订单状态
*
* 实现带有抽象方法的枚举
*
* @author jiqinlin
*
*/
public enum OrderState {
/** 已取消 */
CANCEL {public String getName(){return "已取消";}},
/** 待审核 */
WAITCONFIRM {public String getName(){return "待审核";}},
/** 等待付款 */
WAITPAYMENT {public String getName(){return "等待付款";}},
/** 正在配货 */
ADMEASUREPRODUCT {public String getName(){return "正在配货";}},
/** 等待发货 */
WAITDELIVER {public String getName(){return "等待发货";}},
/** 已发货 */
DELIVERED {public String getName(){return "已发货";}},
/** 已收货 */
RECEIVED {public String getName(){return "已收货";}};
public abstract String getName();
}
public static void main(String[] args) {
//枚举是一种类型,用于定义变量,以限制变量的赋值;赋值时通过“枚举名.值”取得枚举中的值
ColorEnum colorEnum = ColorEnum.blue;
switch (colorEnum) {
case red:
System.out.println("color is red");
break;
case green:
System.out.println("color is green");
break;
case yellow:
System.out.println("color is yellow");
break;
case blue:
System.out.println("color is blue");
break;
}
//遍历枚举
System.out.println("遍历ColorEnum枚举中的值");
for(ColorEnum color : ColorEnum.values()){
System.out.println(color);
}
//获取枚举的个数
System.out.println("ColorEnum枚举中的值有"+ColorEnum.values().length+"个");
//获取枚举的索引位置,默认从0开始
System.out.println(ColorEnum.red.ordinal());//0
System.out.println(ColorEnum.green.ordinal());//1
System.out.println(ColorEnum.yellow.ordinal());//2
System.out.println(ColorEnum.blue.ordinal());//3
//枚举默认实现了java.lang.Comparable接口
System.out.println(ColorEnum.red.compareTo(ColorEnum.green));//-1
//--------------------------
System.out.println("===========");
System.err.println("季节为" + SeasonEnum.getSeason());
//--------------
System.out.println("===========");
for(Gender gender : Gender.values()){
System.out.println(gender.value);
}
//--------------
System.out.println("===========");
for(OrderState order : OrderState.values()){
System.out.println(order.getName());
}
}
}