枚举类全面讲解 Enum

对于以下文 章需要指出的是，枚举类中的变量不一定是final的，可以被多次赋值，并且是全局的，可以用作设置全局变量。

 

 

对枚举类型印象大多来自于C 语言，在 C 语言中，枚举类型是一个 HardCode （硬编码）类型，其使用 价值并不大。因此，在 Java 5 之前，枚举是被抛弃的。然而 Java 5 以后的发现版本开始对枚举进行支持，枚举的引入给 Java 世界带来了争议。

笔者比较赞同引入枚举，作为一门通用的静态编程语言，应该是海纳百川的 （因此笔者赞成闭包进入Java 7 ）， 多途径实现功能。

如果您不了解枚举的用法，建议参考笔者以前网络资源，了解基本的用法。 地址为： http://mercyblitz.blog.ccidnet.com/blog-htm-do-showone-uid-45914-type-blog-itemid-189396.html

枚举是一种特殊的（受限制的）类，它具有以下特点：

1. 可 列性
2. 常 量性
3. 强 类型
4. 类 的特性

留下一个问题-怎么利用这些枚举特点，更好为设计服务呢？根据这些特 点，下面向大家分别得介绍设计技巧。

一、 可 列性

在设计中，必须搞清楚枚举 使 用场景 。 枚 举内部成员都是可列的，或者说固定的。这种硬编码的形式，看上去令人觉得不自在，不过这就是枚举。如果需要动态（不可列）的成员话，请不好使用枚举。

JDK提供不少良好的可列性设计枚举。比如时间单位 java.util.concurrent.TimeUnit 和 线程状态枚举 java.lang.Thread.State 。

 

假设有一个游戏难度枚举，有三种难度NORMAL , MEDIUM, HARD

/**

 * 游戏中的难度枚举：NORMAL , MEDIUM, HARD

 *

 * @author mercyblitz

 */

public
 
enum
 Difficulty {

NORMAL, MEDIUM, HARD //注意：枚举成员命名，请使用
英文大写形式

}

/**

 * 游戏中的难度枚举：NORMAL , MEDIUM, HARD

 * 

 * @author mercyblitz

 */

public enum Difficulty {

NORMAL, MEDIUM, HARD //注意：枚举成员命名，请使用英文大写形式

}

 

 

如果要添加其他成员，只能通过硬编码的方法添加到枚举类。回到枚举 Difficulty，低版 本的必定会影响二进制兼容性。对于静态语言来说，是无法避免的，不能认为是枚举的短处。

 

二、 常 量性

之所以定性为常量性，是因为枚举是不能改变，怎么证明 成员其不变呢？利用上面的Difficulty枚举为例，一段简单的代码得到其原型，如下：

package
 org.mercy.design.enumeration;

import
 java.lang.reflect.Field;

/**
 * Difficulty 元 信息
 * @author mercy
 */
public
 
class
 MetaDifficulty {

    public
 
static
 
void
 main(String[] args) {
        MetaDifficulty instance = new
 MetaDifficulty();
        // 利用反射连接其成员的特性
        Class<Difficulty> classDifficulty = Difficulty.class
;
        for
 (Field field : classDifficulty.getFields()) {
            instance.printFieldSignature(field);
            System.out.println();
        }
    }

    /**
     * 打 印字段 签名(signature)
     *
     * @param field
     */
    private
 
void
 printFieldSignature(Field field) {
        StringBuilder message = new
 StringBuilder(
"字段  "
)
                                .append(field.getName())
                                .append(" 的签名："
)
                                .append(field.toString())
                                .append("\t"
);
        System.out.print(message);
    }

	package org.mercy.design.enumeration;
	
	import java.lang.reflect.Field;
	
	/**
	 * Difficulty 元信息
	 * @author mercy
	 */
	public class MetaDifficulty {
	
		public static void main(String[] args) {
			MetaDifficulty instance = new MetaDifficulty();
			// 利用反射连接其成员的特性
			Class<Difficulty> classDifficulty = Difficulty.class;
			for (Field field : classDifficulty.getFields()) {
				instance.printFieldSignature(field);
				System.out.println();
			}
		}
	
		/**
		 * 打印字段 签名(signature)
		 * 
		 * @param field
		 */
		private void printFieldSignature(Field field) {
			StringBuilder message = new StringBuilder("字段  ")
									.append(field.getName())
									.append(" 的签名：")
									.append(field.toString())
									.append("\t");
			System.out.print(message);
		}

}

 

 

printFieldSignature 方 法输出枚举 Difficulty的 字段，其结果为：

字段  NORMAL 的签 名：public static final org.mercy.design.enumeration.Difficulty org.mercy.design.enumeration.Difficulty.NORMAL

字段  MEDIUM 的签 名：public static final org.mercy.design.enumeration.Difficulty org.mercy.design.enumeration.Difficulty.MEDIUM

字段  HARD 的签 名：public static final org.mercy.design.enumeration.Difficulty org.mercy.design.enumeration.Difficulty.HARD

 

这个结果得出了两个结论，其一，每个枚举成员是枚举的字段。其二，每个成员都被 public static final。 凡是 static final  变 量都是 Java 中的 “常量”，其保存在常量池中。根据其常量性和命名规则，建议全大写命名每个枚举的成员（前面提到）。

常量性提供了数据一致性，不必担心被被其他地方修改，同时保证了线程安全。因此在设计过程中，不必担心线程安全问题。

枚举类型是常量，那么在判断是可以使用== 符号来做比较。可是如果枚举成员能够克隆 (Clone) 的话 , 那么 == 比较会失效，从而一致性不能得到保证。如果按照类的定义方法，考虑枚举的话，那么枚举类是集成了 java.lang.Object 类，因此，它继承 了 protected java.lang.Object clone() 方法，也就是说支持 clone ，虽然需要通过反射的手段去调用。 Java 语言规范提到，每个枚举继承了 java.lang.Enum<E> 抽象基类。

提供一段测试代码来验明真伪：

/**
 * 指 
定的类是枚举java.lang.Enum<E>的子类吗？
 *
 * @param klass
 * @return
 */
private
 
boolean
 isEnum(Class<?> klass) {
    Class<?> superClass = klass.getSuperclass();
    while
 (
true
) { 
// 递归
查找
        if
 (superClass != 
null
) {
            if
 (Enum.
class
.equals(superClass))
                return
 
true
;
        } else
 {
            break
;
        }
        superClass = superClass.getSuperclass();
    }
    return
 
false
;
}

	/**
	 * 指定的类是枚举java.lang.Enum<E>的子类吗？
	 * 
	 * @param klass
	 * @return
	 */
	private boolean isEnum(Class<?> klass) {
		Class<?> superClass = klass.getSuperclass();
		while (true) { // 递归查找
			if (superClass != null) {
				if (Enum.class.equals(superClass))
					return true;
			} else {
				break;
			}
			superClass = superClass.getSuperclass();
		}
		return false;
	}

 

    客户端代码调用： instance.isEnum(Difficulty. class ) ;  结 果返回true ，那么证明了 Difficulty 枚 举继承了java.lang.Enum<E> 抽象基类。

那么java.lang.Enum<E> 有没有覆盖 clone 方法呢？查看一下源代码：

/**

     * Throws CloneNotSupportedException.  This guarantees that enums

     * are never cloned, which is necessary to preserve their "singleton"

     * status.

     *

     * @return (never returns)

     */

    protected
 
final
 Object clone() 
throws
 CloneNotSupportedException{

throw
 
new
 CloneNotSupportedException();

}

/**

     * Throws CloneNotSupportedException.  This guarantees that enums

     * are never cloned, which is necessary to preserve their "singleton"

     * status.

     *

     * @return (never returns)

     */

    protected final Object clone() throws CloneNotSupportedException{

throw new CloneNotSupportedException();

}

 

 

 

 

很明显，java.lang.Enum<E> 基类 final 定 义了 clone 方法， 即枚举不支持克隆，并且 Java doc 提到要保持单体性。那么这也是面向对象设计的原则之一 - 对于保持单态性的对象而 言，尽可能不支持或者不暴露clone 方 法。

 

三、 强 类型

前面的两个特性，在前Java 5 时代，利用了常量字段也可以完成需 要。比如可以这么设计Difficulty类的字段，

 

public
 
static
 
final
 
int
 NORMAL = 
1
;

public
 
static
 
final
 
int
 MEDIUM = 
2
;

public
 
static
 
final
 
int
 HARD = 
3
;

public static final int NORMAL = 1;

public static final int MEDIUM = 2;

public static final int HARD = 3;

 

 

这么设计有一个缺点-弱类型，因为三个字段都是int原生型。

比如有一个方法用于设置游戏难度，定义如下：

public
 
void
 setDifficulty(
int
 difficulty)

public void setDifficulty(int difficulty)

   

  利用int类型作为参数，可能会有问题-如果参数在NORMAL，MEDIUM，HARD之外int数是可以接受的。利用规约的方法可以避免这个问题，比 如设计范围检查：

/**

 * 设置游戏难度

 * @param difficulty 难 度数

 * @throws IllegalArgumentException

 *             如 
果参数不是 NORMAL、MEDIUM和Hard其中一个，那么报出IllegalArgumentException

 */

public
 
void
 setDifficulty(
int
 difficulty)

 throws
 IllegalArgumentException

/**

 * 设置游戏难度

 * @param difficulty 难度数

 * @throws IllegalArgumentException

 *             如果参数不是 NORMAL、MEDIUM和Hard其中一个，那么报出IllegalArgumentException

 */

public void setDifficulty(int difficulty)

 throws IllegalArgumentException 

 

 

在可能实现方法中，通过三次成员比较，这样比较笨拙和憋足。

如果您在使用Java 5以前版本的话，作者提供一个较好的实现方法:

package
 org.mercy.design.enumeration;

import
 java.util.Collections;
import
 java.util.HashSet;
import
 java.util.Set;
/**
 * Difficulty JDK1.4 实现　Difficulty枚举
 * @author mercy
 */
public
 
class
 Difficulty14 {
    //枚举字段
    public
 
static
 
final
 
int
 NORMAL = 
1
;
    public
 
static
 
final
 
int
 MEDIUM = 
2
;
    public
 
static
 
final
 
int
 HARD = 
3
;

    private
 
final
 
static
 Set difficulties;

    static
 {
        // Hash 提供快速查找
        HashSet difficultySet = new
 HashSet();
        difficultySet.add(Integer.valueOf(NORMAL));
        difficultySet.add(Integer.valueOf(MEDIUM));
        difficultySet.add(Integer.valueOf(HARD));
        //利用不变的对象是一个好的设计实践
        difficulties= Collections.unmodifiableSet(difficultySet);
    }

    /**
     * 设 置游戏难度
     * @param difficulty 难 度数
     * @throws IllegalArgumentException
     *             如果参数不是NORMAL、
MEDIUM和Hard其中一个，那么报出 IllegalArgumentException
     */
    public
 
void
 setDifficulty(
int
 difficulty)
    throws
 IllegalArgumentException {
        if
(!difficulties.contains(Integer.valueOf(difficulty)))
            throw
 
new
 IllegalArgumentException(
"参数错误"
);
        //设置难度...
    }
}

package org.mercy.design.enumeration;

import java.util.Collections;
import java.util.HashSet;
import java.util.Set;
/**
 * Difficulty JDK1.4实现　Difficulty枚举
 * @author mercy
 */
public class Difficulty14 {
	//枚举字段
	public static final int NORMAL = 1;
	public static final int MEDIUM = 2;
	public static final int HARD = 3;
	
	private final static Set difficulties;

	static {
		// Hash 提供快速查找
		HashSet difficultySet = new HashSet();
		difficultySet.add(Integer.valueOf(NORMAL));
		difficultySet.add(Integer.valueOf(MEDIUM));
		difficultySet.add(Integer.valueOf(HARD));
		//利用不变的对象是一个好的设计实践
		difficulties= Collections.unmodifiableSet(difficultySet);
	}
	
	/**
	 * 设置游戏难度
	 * @param difficulty 难度数
	 * @throws IllegalArgumentException
	 *             如果参数不是NORMAL、MEDIUM和Hard其中一个，那么报出IllegalArgumentException
	 */
	public void setDifficulty(int difficulty) 
	throws IllegalArgumentException {
		if(!difficulties.contains(Integer.valueOf(difficulty)))
			throw new IllegalArgumentException("参数错误");
		//设置难度...
	}
}

 

 

在上面的代码中，尽管提供了范围检查，不过参数范围还是巨大（可以 说是无数），并且是运行时检查。因为 setDifficulty 的 参数是 int的， 客户端调用时候，编译器可以接受 int 以及范围更小的 short 、 byte 等类型。那么违反了 一个良好的实践 -在面向对象 设计中，类型范围最好在编译时确定而非运行时。

另一个良好的面向对象实践 -利用对象类型，而不是原生型（如果编程语言支持的话）。 那 么，如果使用java.lang.Integer 取 代 int 类型，并且 Integer 是 final 类，没有必要担心多态的情况下，不就可 以提供强类型吗？的确，提供了强类型约束，并且更好的锁定类型范围（因为是 final 的）。可是， Integer 的范围在一定程度上，认为是无限的，同时不支持 swtich 语句（ 仅支持 int  、 short 、 byte 和 Java 5  枚举类型）。因此 Integer 还是不合适的。

枚举的常量性和可列性，在Difficulty 场景中尤其适合。

 

四、 类 的特性

已知每个枚举都继承了java.lang.Enun<E> 基类，其既有常量性，同时也有类的特点。尽管它是一种被限制的类，比如name和ordinal字段状态都是有JVM处理的。不过开发人员可以充分的利用 类的特点，作出优美的设计。

枚举既然也是类，那么也遵循类的设计。通过扩张 Difficulty 类， 面向对象的方式来设计枚举。

1.  封 装设计

如果有一个 需求 - Difficulty 持 久化，把其存入 d ifficult ies数 据库表中，并且提供一个唯一的 id 整型值。面向对象的封装，枚举也 适用。示例如下：

public
 
enum
 Difficulty {
    // 注意：枚举成员命名，请使用英文大写形式
    NORMAL(1
), MEDIUM(
2
), HARD(
3
);
    /**
     * final 修饰字段是一个良好的实践。
     */
    final
 
private
 
int
 id;

    Difficulty(final
 
int
 id){
        this
.id=id;
    }
    /**
     * 获 得ID
     * @return
     */
    public
 
int
 getId() {
        return
 id;
    }
}

public enum Difficulty {
	// 注意：枚举成员命名，请使用英文大写形式
	NORMAL(1), MEDIUM(2), HARD(3); 
	/**
	 * final修饰字段是一个良好的实践。
	 */
	final private int id;
	
	Difficulty(final int id){
		this.id=id;
	}
	/**
	 * 获得ID
	 * @return
	 */
	public int getId() {
		return id;
	}
}

 

 

通过调用getId 方法可以获取枚举成员的 ID 值。

2.  抽 象设计

在不同的游 戏难度级别中，不同任务的难度值不同（大多数情况是通过值来表示，而非枚举对象本身）。以Difficulty为例，定义一个抽象的方法，计算难度值。

/**
 * 获 取不同任务的难度值
 *
 * @param mission
 * @return
 * @throws IllegalArgumentException
 *             如
果<code>mission</code> 为负数时。
 */
public
 
abstract
 
int
 getValue(
int
 mission) 
throws
 IllegalArgumentException;

	/**
	 * 获取不同任务的难度值
	 * 
	 * @param mission
	 * @return
	 * @throws IllegalArgumentException
	 *             如果<code>mission</code> 为负数时。
	 */
	public abstract int getValue(int mission) throws IllegalArgumentException;

 

3.  多 态设计

Difficulty 枚举中定义抽象方法getValue，那么其子类必须实现这个方法。不过枚举不能被继承，也不能继承其他类，除了默认额 java.lang.Enum<E>类以外。因此枚举是一个final的版本，不能实现抽象方法？

枚举的特殊 在此，枚举虽然不能显示地利用extends关键字继承，不过它的每个成员都是自己的子类。那么以Difficulty为例，其类层次关系 为：java.lang.Enum<E> -> Difficulty -> HARD。这么看来，每个枚举成员相当于定了一个 final的类内置类。

回到 Difficulty枚举，实现抽象方法如下：

 

 

NORMAL(
1
) {
        @Override
        public
 
int
 getValue(
int
 mission)
    throws
 IllegalArgumentException {
            return
 mission + 
this
.getId();
        }
    },
    MEDIUM(2
) {
        @Override
        public
 
int
 getValue(
int
 mission)
    throws
 IllegalArgumentException {
            return
 mission *