浅析enum（枚举）

以下为转载内容，转载地址http://www.cnblogs.com/hemingwang0902/archive/2011/12/29/2306263.html，作者:旺仔专栏

enum 的全称为 enumeration， 是 JDK 1.5  中引入的新特性，存放在 java.lang 包中。

    下面是我在使用 enum 过程中的一些经验和总结，主要包括如下内容：

1. 原始的接口定义常量

2. 语法（定义）

3. 遍历、switch 等常用操作

4. enum 对象的常用方法介绍

5. 给 enum 自定义属性和方法

6. EnumSet，EnumMap 的应用

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:[e-mail]">何明旺</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:[e-mail]">何明旺</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，只不过 java 编译器帮我们做了语法的解析和编译而已。 

总结
    可以把 enum 看成是一个普通的 class，它们都可以定义一些属性和方法，不同之处是：enum 不能使用 extends 关键字继承其他类，因为 enum 已经继承了 java.lang.Enum（java是单一继承）。

另外，enum类还可以定义多个属性值，只需添加相应的变量和构造函数：

public enum EquipType {
	
	/** 头盔:增加物防+法防 */
	Helmet(1, 201, "头盔", false),
	/** 武器:物攻/法攻 */
	Weapon(2, 202, "武器", false);
        
         
	private int value;
	private int position;
	private String name;
	private boolean canAdd;
         
         private EquipType(int value, int position, String name, boolean canAdd){
		this.value = value;
		this.position = position;
		this.name = name;
		this.canAdd = canAdd;
	}
	/**
	 * 对应的值
	 * @return
	 */
	public int value(){
		return this.value;
	}
	/**
	 * 名字
	 * @return
	 */
	public String getName(){
		return this.name;
	}
	/**
	 * 对应伙伴身上装备的位置
	 * @return
	 */
	public int position(){
		return this.position;
	}

          //还可以像普通类一样定义静态、非静态方法等。除了必需写上对应的变量值和构造函数外，其它基本和普通类一致
}

枚举看起来优雅而干净~