Enum、EnumMap、EnumSet的用法讲解

先看定义的枚举类:

package org.effectivejava.examples.chapter01;

/**
 * Created by sty on 2018/2/23.
 */
public enum  OperateTypeEnum {

    ADD("增加"),DELETE("删除"),UPDATE("更新"),QUERY("查询");

    private String enumDesc;

    OperateTypeEnum(String enumDesc) {
        this.enumDesc = enumDesc;
    }

    public String getEnumDesc() {
        return enumDesc;
    }

    public void setEnumDesc(String enumDesc) {
        this.enumDesc = enumDesc;
    }

}

java.lang.Enum

每一个枚举类都会隐式的继承java.lang.Enum这个类,也许你会问,你是怎么知道的?我们可以通过反射的方式来解析下OperateTypeEnum这个枚举类:

Class clazz = OperateTypeEnum.class;
Class clazzSuper = clazz.getSuperclass();
if(clazzSuper != null)
     System.out.println(clazzSuper.getName());

输出结果为:java.lang.Enum。正是因为这个原因,而java中又是没有多继承的,所以枚举类不能继承。但是可以实现接口。

values方法

通过翻父类中的方法,你也找不到这个方法在哪里。那么这个方法是怎么产生的呢?是编译器在编译枚举类的时候添加上去的。这个我们同样可以通过反射的方式来获得这样的结果:

Class clazz = EnumTest01.class;  
Method[] methods = clazz.getDeclaredMethods();  
for(Method method : methods){  
    System.out.println(method.getName());  
} 

输出结果为:

main
values
valueOf
getEnumDesc
setEnumDesc
testEnumMethod
testEnumMethod2

可以看到其中有一个values方法。
那么这个values方法有什么用呢? 通过values方法我们可以获取枚举类中的所有的元素。请看例子:

System.out.println(Arrays.toString(OperateTypeEnum.values()));
//循环所有的枚举类型  
for(OperateTypeEnum val : OperateTypeEnum.values()){
    System.out.println(val.getEnumDesc());
}

输出结果为:

[ADD, DELETE, UPDATE, QUERY]
增加
删除
更新
查询

当你需要获取一个枚举类中的所有枚举元素的时候,就可以用这个方法了。

valueOf方法

这个方法同样是编译在编译的时候添加到枚举类中去的。例子见上面。这个方法的作用是通过枚举元素的名称获取一个枚举类。
System.out.println(OperateTypeEnum.valueOf("UPDATE").getEnumDesc());
与之相对应的是java.lang.Enum这个父类中也有一个valueOf方法。但是这个方法的用法稍微有点不同。如下所示:
System.out.println(Enum.valueOf(OperateTypeEnum.class, "DELETE").getEnumDesc());

switch语句

从java1.6之后,我们可以在switch语句的case中放入枚举元素。例子如下:

public static void testSwitchEnum() {
        putSwitchEnum(OperateTypeEnum.DELETE);
    }

    public static void putSwitchEnum(OperateTypeEnum enumSwitch) {

        switch (enumSwitch) {
            case ADD:
                System.out.println("这个是add方法");
                break;
            case DELETE:
                System.out.println("这个是delete方法");
                break;
            case UPDATE:
                System.out.println("这个是update方法");
                break;
            default:
                System.out.println("这个是query方法");
                break;
        }
    }

枚举元素自定义方法

在枚举元素中可以自定义方法,来重写枚举类中的方法。

package org.effectivejava.examples.chapter01;

import java.lang.reflect.Method;
import java.util.Arrays;

/**
 * Created by sty on 2018/2/23.
 */
public enum  OperateTypeEnum {

    ADD("增加"){
        @Override
        public void getInfo(){
            System.out.println("这个是add");
        }
        public void getPrint(){
            System.out.println("add");
        }
    },DELETE("删除"),UPDATE("更新"),QUERY("查询");

    public void getInfo(){
        System.out.println("我是原始方法,我可以被重写");
    }
    
    private String enumDesc;

    OperateTypeEnum(String enumDesc) {
        this.enumDesc = enumDesc;
    }
}

为什么可以这样做呢?我们可以这样去理解,每一个枚举元素都是一个继承枚举类的内部子类,并且每一个内部子类中都包含所有的枚举元素。下面这个例子可以佐证:

OperateTypeEnum enumTest = ADD;
enumTest.ADD.UPDATE.getInfo();

实现单例

估计这是最简单的实现单例的一个方式。只有一个枚举元素。

public enum SingletonEnum {  
      singleton;  
} 

ordinal方法

这个方法是用来表示枚举类中元素的顺序的,是从0开始的。这个我们在后面会用到。

for (OperateTypeEnum test : OperateTypeEnum.values()) {
            System.out.println(test.name()+" "+test.ordinal());
        }

结果为:

ADD 0
DELETE 1
UPDATE 2
QUERY 3

name方法

name方法用来表示枚举元素的名称的,他的名称即你写的枚举元素。例子见上图。

EnumMap

Map的实现类有很多种,EnumMap从名字我们可以看出这个Map是给枚举类用的。它的key为枚举元素,value自定义。在工作中我们也可以用其他的Map来实现我们关于枚举的需求,但是为什么要用这个EnumMap呢?因为它的性能高!为什么性能高?因为它的内部是用数组的数据结构来维护的!我们可以看一下它的源码实现:

  • put方法
    public V put(K key, V value) {  
        typeCheck(key);  
    
        int index = key.ordinal();  
        Object oldValue = vals[index];  
        vals[index] = maskNull(value);  
        if (oldValue == null)  
            size++;  
        return unmaskNull(oldValue);  
    } 
    
    typeCheck是用来检查key的类型的,因为key只能为枚举元素。接下来的这一句int index = key.ordinal();key.ordinal()这个就是我们上面说的枚举类型的序号,然后被当做数组的下标,放到vals这个数组里。那么get方法呢?
  • get方法
    public V get(Object key) {  
        return (isValidKey(key) ?  
                unmaskNull(vals[((Enum<?>)key).ordinal()]) : null);  
    } 
    
    注意这一句话:vals[((Enum<?>)key).ordinal()]。这个不就是取得下标,根据下标获取数组中的值吗?!
  • remove方法
    public V remove(Object key) {  
        if (!isValidKey(key))  
            return null;  
        int index = ((Enum<?>)key).ordinal();  
        Object oldValue = vals[index];  
        vals[index] = null;  
        if (oldValue != null)  
            size--;  
        return unmaskNull(oldValue);  
    } 
    
    remove方法的实现也是挺简单的,就是把相应下标的元素变为null,等着GC回收。

这里我们只是说了EnumMap里比较常用的三个方法,如果有兴趣的同学可以看看其他的方法实现。一个使用EnumMap的例子奉上:

  EnumMap<OperateTypeEnum, String> enumMap = new EnumMap<OperateTypeEnum, String>(OperateTypeEnum.class);
        enumMap.put(OperateTypeEnum.DELETE, "dddddddddddddd");
        enumMap.put(OperateTypeEnum.UPDATE, "uuuuuuuuuuuuuu");
        for (Map.Entry<OperateTypeEnum, String> entry : enumMap.entrySet()) {
            System.out.println(entry.getValue() + entry.getKey().getEnumDesc());
        }

EnumSet

EnumSet这是一个用来操作Enum的集合,是一个抽象类,它有两个继承类:JumboEnumSet和RegularEnumSet。在使用的时候,需要制定枚举类型。它的特点也是速度非常快,为什么速度很快呢?因为每次add的时候,每个枚举值只占一个长整型的一位。我们可以翻看源码来看看它的实现:

  • add方法
    public boolean add(E e) {  
        typeCheck(e);  
    
        long oldElements = elements;  
        elements |= (1L << ((Enum<?>)e).ordinal());  
        return elements != oldElements;  
    } 
    
    从中我们可以看出是先对一个长整型左移枚举类型的序列数,然后再和长整型 或 。
  • of方法
    of方法有好几个重载的方法,它的作用是创建一个最初包含指定元素的枚举 set。
    EnumSet<OperateTypeEnum> enumSets = EnumSet.of(OperateTypeEnum.DELETE);
    
  • allOf
    创建一个包含指定元素类型的所有元素的枚举 set。
    EnumSet<OperateTypeEnum> enumSets = EnumSet.allOf(OperateTypeEnum.class);
    
  • range方法
    创建一个指定范围的Set。
    EnumSet<OperateTypeEnum> enumSets = EnumSet.range(OperateTypeEnum.DELETE,OperateTypeEnum.UPDATE);
    
  • noneOf方法
    创建一个指定枚举类型的空set。
     EnumSet<OperateTypeEnum> enumSet = EnumSet.noneOf(OperateTypeEnum.class);
        enumSet.add(OperateTypeEnum.DELETE);
        enumSet.add(OperateTypeEnum.UPDATE);
        for (Iterator<OperateTypeEnum> it = enumSet.iterator(); it.hasNext();) {
            System.out.println(it.next().getEnumDesc());
        }
        for (OperateTypeEnum enumTest : enumSet) {
            System.out.println(enumTest.getEnumDesc() + "  ..... ");
        }
    
  • copyOf方法
    创建一个set的并copy所传入的集合中的枚举元素。
     EnumSet<OperateTypeEnum> enumSets = EnumSet.copyOf(enumSet);
    

其他方法不再多说,不过大家可以思考一下EnumSetIterator中next方法的实现。

好了,关于枚举的相关介绍就先到这里吧。有问题的可以评论交流。

附相关代码:https://github.com/toocruel/effective-java-examples/blob/master/src/main/java/org/effectivejava/examples/chapter01/OperateTypeEnum.java

(全文完)

(转载本站文章请注明作者和出处 Enum、EnumMap、EnumSet的用法讲解