Java enum的使用

之前学Java很少用到枚举,但是会经常看到别人代码中有枚举,然后进行学习。现在想再复习下枚举,今天简单总结下。

简介

Java的Enum枚举类型是在JDK1.5引入的,在 Java 中它虽然算个“小”功能,却给我的开发带来了“大”方便。

简单学习

知识的了解

定义枚举类型其实就是在定义一个类,只不过很多细节由编译器帮你补齐了,所以,某种程度上enum关键词的作用就像是class或interface.

当使用enum定义枚举类型时,实际上所定义出来的类型是继承自java.lang.Enum类。而每个被枚举的成员其实就是定义的枚举类型的一个实例,它们都被默认为public、static和final,这与接口中的常量限制相同,可以通过类名称直接使用它们。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
public enum Light {
// 利用构造函数传参
RED(1), GREEN(3), YELLOW(2);

// 定义私有变量
private int nCode;

// 构造函数,枚举类型只能为私有
private Light(int _nCode) {
this.nCode = _nCode;
}

@Override
public String toString() {
return String.valueOf(this.nCode);
}
}

如上面的例子所定义的枚举类型Light,RED,GREEN,YELLOW都是Light的一个对象实例。因为是对象,所以,对象上自然有一些方法可以调用。

  1. values()方法可以让您取得所有的枚举成员实例,并以数组方式返回。您可以使用这两个方法来简单的将Color的枚举成员显示出来。
  2. 静态valueOf()方法可以让您将指定的字符串尝试转换为枚举类型。
  3. 可以用compareTo()方法来比较两个枚举对象在枚举时的顺序。-1之前,0位置相同,1之后。
  4. 对于每个枚举成员,使用ordinal()方法,依枚举顺序得到位置索引,默认以0开始。
  5. 从Object继承的toString()方法被重新定义了,可以让你直接取得枚举值的字符串描述;
    如果重写toStirng方法,
    for (Light aLight : Light.values()) {}遍历后aLight值为1、3、2,aLight.name()为RED, GREEN, YELLOW,aLight.ordinal()为0、1、2
    否则aLight的值为RED, GREEN, YELLOW,aLight.name()为RED, GREEN, YELLOW,aLight.ordinal()为0、1、2

七种常见用法

用法一:常量

在JDK1.5 之前,我们定义常量都是: public static fianl…. 。现在好了,有了枚举,可以把相关的常量分组到一个枚举类型里,而且枚举提供了比常量更多的方法。

1
2
3
public enum Color {  
RED, GREEN, BLANK, YELLOW
};

用法二:switch

JDK1.6之前的switch语句只支持int,char,enum类型,使用枚举,能让我们的代码可读性更强。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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;
}
}
}

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

如果打算自定义自己的方法,那么必须在enum实例序列的最后添加一个分号。而且 Java 要求必须先定义 enum实例。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
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;
}
}

用法四:覆盖枚举的方法

下面给出一个toString()方法覆盖的例子。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
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;
}
}

用法五:实现接口

所有的枚举都继承自java.lang.Enum类。由于Java 不支持多继承,所以枚举对象不能再继承其他类。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
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);
}
}

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

1
2
3
4
5
6
7
8
public interface Food {
enum Coffee implements Food{
BLACK_COFFEE,DECAF_COFFEE,LATTE,CAPPUCCINO
}
enum Dessert implements Food{
FRUIT, CAKE, GELATO
}
}

用法七:关于枚举集合的使用

java.util.EnumSet和java.util.EnumMap是两个枚举集合。EnumSet保证集合中的元素不重复;EnumMap中的key是enum类型,而value则可以是任意类型。关于这个两个集合的使用就不在这里赘述,可以查看最上面的例子以及参考JDK文档。

枚举和常量定义的区别

一、 通常定义常量方法

我们通常利用public final static方法定义的代码如下,分别用1表示红灯,3表示绿灯,2表示黄灯。

1
2
3
4
5
6
7
8
9
10
public class Light {
/* 红灯 */
public final static int RED = 1;

/* 绿灯 */
public final static int GREEN = 3;

/* 黄灯 */
public final static int YELLOW = 2;
}

二、 枚举类型定义常量方法

枚举类型的简单定义方法如下,我们似乎没办法定义每个枚举类型的值。比如我们定义红灯、绿灯和黄灯的代码可能如下:

1
2
3
public enum Light {
RED, GREEN, YELLOW;
}

我们只能够表示出红灯、绿灯和黄灯,但是具体的值我们没办法表示出来。别急,既然枚举类型提供了构造函数,我们可以通过构造函数和覆写toString方法来实现。首先给Light枚举类型增加构造方法,然后每个枚举类型的值通过构造函数传入对应的参数,同时覆写toString方法,在该方法中返回从构造函数中传入的参数,改造后的代码如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
public enum Light {
// 利用构造函数传参
RED(1), GREEN(3), YELLOW(2);

// 定义私有变量
private int nCode;

// 构造函数,枚举类型只能为私有
private Light(int _nCode) {
this.nCode = _nCode;
}

@Override
public String toString() {
return String.valueOf(this.nCode);
}
}

三、 完整示例代码

枚举类型的完整演示代码如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
import java.util.EnumMap;
import java.util.EnumSet;

public class LightTest {

// 1.定义枚举类型
public enum Light {

// 利用构造函数传参
RED(1), GREEN(3), YELLOW(2);

// 定义私有变量
private int nCode;

// 构造函数,枚举类型只能为私有
private Light(int _nCode) {
this.nCode = _nCode;
}

@Override
public String toString() {
return String.valueOf(this.nCode);
}
}

/**
*
* @param args
*/
public static void main(String[] args) {
// 1.遍历枚举类型
System.out.println("演示枚举类型的遍历 ......");
testTraversalEnum();
// 2.演示EnumMap对象的使用
System.out.println("演示EnmuMap对象的使用和遍历.....");
testEnumMap();
// 3.演示EnmuSet的使用
System.out.println("演示EnmuSet对象的使用和遍历.....");
testEnumSet();
}

/**
*
* 演示枚举类型的遍历
*/
private static void testTraversalEnum() {
Light[] allLight = Light.values();
for (Light aLight : allLight) {
System.out.println("当前灯name:" + aLight.name());
System.out.println("当前灯ordinal:" + aLight.ordinal());
System.out.println("当前灯:" + aLight);
}
}

/**
*
* 演示EnumMap的使用,EnumMap跟HashMap的使用差不多,只不过key要是枚举类型
*/

private static void testEnumMap() {
// 1.演示定义EnumMap对象,EnumMap对象的构造函数需要参数传入,默认是key的类的类型
EnumMap<Light, String> currEnumMap = new EnumMap<Light, String>(Light.class);
currEnumMap.put(Light.RED, "红灯");
currEnumMap.put(Light.GREEN, "绿灯");
currEnumMap.put(Light.YELLOW, "黄灯");
// 2.遍历对象
for (Light aLight : Light.values()) {
System.out.println("[key=" + aLight.name() + ",value="
+ currEnumMap.get(aLight) + "]");
}
}

/**
*
* 演示EnumSet如何使用,EnumSet是一个抽象类,获取一个类型的枚举类型内容<BR/>
*
* 可以使用allOf方法
*/
private static void testEnumSet() {
EnumSet<Light> currEnumSet = EnumSet.allOf(Light.class);
for (Light aLightSetElement : currEnumSet) {
System.out.println("当前EnumSet中数据为:" + aLightSetElement);
}
}
}

执行结果如下:
演示枚举类型的遍历 ……
当前灯name:RED
当前灯ordinal:0
当前灯:1
当前灯name:GREEN
当前灯ordinal:1
当前灯:3
当前灯name:YELLOW
当前灯ordinal:2
当前灯:2
演示EnmuMap对象的使用和遍历…..
[key=RED,value=红灯]
[key=GREEN,value=绿灯]
[key=YELLOW,value=黄灯]
演示EnmuSet对象的使用和遍历…..
当前EnumSet中数据为:1
当前EnumSet中数据为:3
当前EnumSet中数据为:2

四、 正常定义常量方法和枚举定义常量方法的区别

以下内容可能有些无聊,但绝对值得一窥

1
2
3
4
public class State {
public static final int ON = 1;
public static final Int OFF= 0;
}

有什么不好了,大家都这样用了很长时间了,没什么问题啊。

  1. 首先它不是类型安全的。你必须确保是int;其次,你还要确保它的范围是0和1;最后,很多时候你打印出来的时候,你只看到1和0,但其没有看到代码的人并不知道你的企图。
  2. 可以创建一个enum类,把它看做一个普通的类。除了它不能继承其他类了。(java是单继承,它已经继承了Enum),可以添加其他方法,覆盖它本身的方法。
  3. JDK1.7后switch()参数可以使用enum了。
  4. values()方法是编译器插入到enum定义中的static方法,所以,当你将enum实例向上转型为父类Enum是,values()就不可访问了。解决办法:在Class中有一个getEnumConstants()方法,所以即便Enum接口中没有values()方法,我们仍然可以通过Class对象取得所有的enum实例。
  5. 无法从enum继承子类,如果需要扩展enum中的元素,可以在一个接口的内部,创建实现该接口的枚举,达到将枚举元素进行分组。
  6. 使用EnumSet代替标志。enum要求其成员都是唯一的,但是enum中不能删除添加元素。
  7. EnumMap的key是enum,value是任何其他Object对象。
  8. enum允许程序员为eunm实例编写方法。所以可以为每个enum实例赋予各自不同的行为。
  9. 使用enum的职责链(Chain of Responsibility) .这个关系到设计模式的职责链模式。以多种不同的方法来解决一个问题。然后将他们链接在一起。当一个请求到来时,遍历这个链,直到链中的某个解决方案能够处理该请求。
  10. 使用enum的状态机。
  11. 使用enum多路分发。

参考资料

Java枚举类型的使用

热评文章