美文网首页日常学习程序员Java学习笔记
Enum、EnumMap、EnumSet的用法讲解

Enum、EnumMap、EnumSet的用法讲解

作者: 木叶之荣 | 来源:发表于2017-01-12 14:19 被阅读669次

    在工作中遇到这样一个问题,要在前台页面上渲染出来所有的枚举元素,但是前台页面用的是Velocity,所以需要把枚举元素放到Map里,然后在前台进行渲染。这里不能一个一个的取出枚举元素来put的,就想能用一个循环能搞定这个。发现枚举类有一个方法values,正好可以满足我的需求。OK话不多说我们一个一个的介绍其中主要的方法。
    先看定义的枚举类:

    package com.zkn.newlearn.enums;
    
    /**
     * 
     * @author zkn 2016-07-11
     *
     */
    
    public enum EnumTest01 {
        
        UPDATE(1,"更新"),QUERY(2,"查询"),DELETE(3,"删除");
        private Integer enumValue;
        private String enumDesc;
        
        private EnumTest01(Integer enumValue, String enumDesc) {
            this.enumValue = enumValue;
            this.enumDesc = enumDesc;
        }
        
        public int getEnumValue(){
            return this.enumValue;
        }
        
        public String getEnumDesc(){
            return this.enumDesc;
        }
    }
    

    java.lang.Enum

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

        public void testEnumMethod(){
            
            Class clazz = EnumTest01.class;
            Class clazzSuper = clazz.getSuperclass();
            if(clazzSuper != null)
                System.out.println(clazzSuper.getName());
        }
    

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

    public enum EnumTest02 implements Sender{
        ;
    
        @Override
        public void doSend() {
            // TODO Auto-generated method stub
            
        }
        
    }
    package com.zkn.newlearn.gof.factory;
    /**
     * 
     * @author zkn
     *
     */
    public interface Sender {
    
        public void doSend();
        
    }
    

    values方法

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

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

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

            System.out.println(Arrays.toString(EnumTest01.values()));
            //循环所有的枚举类型
            for(EnumTest01 test : EnumTest01.values()){
                System.out.println(test.getEnumDesc()+test.getEnumValue());
                //System.out.println(test.name()+"   "+test.ordinal());
            }
    

    输出结果为:


    20160711234616585.png

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

    valueOf方法

    这个方法同样是编译在编译的时候添加到枚举类中去的。例子见上面。这个方法的作用是通过枚举元素的名称获取一个枚举类。

    System.out.println(EnumTest01.valueOf("UPDATE").getEnumDesc());
    

    与之相对应的是java.lang.Enum这个父类中也有一个valueOf方法。但是这个方法的用法稍微有点不同。如下所示:

    System.out.println(Enum.valueOf(EnumTest01.class, "DELETE").getEnumDesc());
    

    switch语句

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

        public void testSwitchEnum() {
            putSwitchEnum(EnumTest01.DELETE);
        }
    
        public void putSwitchEnum(EnumTest01 enumSwitch) {
    
            switch (enumSwitch) {
            case DELETE:
                System.out.println("这个是delete方法");
                break;
            case UPDATE:
                System.out.println("这个是update方法");
                break;
            default:
                System.out.println("这个是query方法");
                break;
            }
        }
    

    枚举元素自定义方法

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

    package com.zkn.newlearn.enums;
    /**
     * 
     * @author zkn 2016-07-11
     *
     */
    public enum EnumTest02{
        GREEN{
            @Override
            public void getInfo(){
                System.out.println("这个是绿灯");
            }
            public void getPrint(){
                System.out.println("zhangsan");
            }
        },
        RED{
            @Override
            public void getInfo(){
                System.out.println("这个是红灯");
            }
        },
        YELLOW{
            @Override
            public void getInfo(){
                System.out.println("这个是黄灯");
            }
        };
    
        public void getInfo(){
            
        }
        
    }
    

    为什么可以这样做呢?我们看一下编译器编译之后的Class文件:如图:

    Paste_Image.png

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

        import static com.zkn.newlearn.enums.EnumTest02.*;
        @Test
        public void testEnumCustom(){
            EnumTest02 enumTest = GREEN;
            enumTest.RED.RED.getInfo();
        } 
    

    实现单例

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

    package com.zkn.newlearn.gof.singleton;
    /**
     * 枚举实现单例
     * @author zkn
     *
     */
    public enum SingletonGofTest04 {
    
        singleton;
    }
    

    ordinal方法

    这个方法是用来表示枚举类中元素的顺序的,是从0开始的。这个我们在后面会用到。
    for (EnumTest01 test : EnumTest01.values()) {
    System.out.println(test.name()+" "+test.ordinal());
    }

    Paste_Image.png

    name方法

    name方法用来表示枚举元素的名称的,他的名称即你写的枚举元素。例子见上图。
    另外:
    你可以像写java类一样去写一个枚举类,只是这个枚举类不能集成其他类。

    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<EnumTest01, String> enumMap = new EnumMap<EnumTest01, String>(EnumTest01.class);
            enumMap.put(EnumTest01.DELETE, "dsdsd");
            enumMap.put(EnumTest01.UPDATE, "qqqqqq");
            for (Map.Entry<EnumTest01, 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<EnumTest01> enumSets = EnumSet.of(EnumTest01.DELETE);
    

    allOf

    创建一个包含指定元素类型的所有元素的枚举 set。

    EnumSet<EnumTest01> enumSets = EnumSet.allOf(EnumTest01.class);
    

    range方法

    创建一个指定范围的Set。

    EnumSet<EnumTest01> enumSets = EnumSet.range(EnumTest01.DELETE,EnumTest01.UPDATE);
    

    noneOf方法

    创建一个指定枚举类型的空set。

            EnumSet<EnumTest01> enumSet = EnumSet.noneOf(EnumTest01.class);
            enumSet.add(EnumTest01.DELETE);
            enumSet.add(EnumTest01.UPDATE);
            for (Iterator<EnumTest01> it = enumSet.iterator(); it.hasNext();) {
                System.out.println(it.next().getEnumDesc());
            }
            for (EnumTest01 enumTest : enumSet) {
                System.out.println(enumTest.getEnumDesc() + "  ..... ");
            }
    

    copyOf

    创建一个set的并copy所传入的集合中的枚举元素。

    EnumSet<EnumTest01> enumSets = EnumSet.copyOf(enumSet);
    

    其他方法不再多说,不过大家可以思考一下EnumSetIterator中next方法的实现。
    好了,关于枚举的相关介绍就先到这里吧。有问题的可以评论交流。

    相关文章

      网友评论

        本文标题:Enum、EnumMap、EnumSet的用法讲解

        本文链接:https://www.haomeiwen.com/subject/ckidbttx.html