EnumSet详细讲解

https://blog.csdn.net/tugangkai/article/details/89631886

之前介绍的Set接口的实现类HashSet/TreeSet，它们内部都是用对应的HashMap/TreeMap实现的，但EnumSet不是，它的实现与EnumMap没有任何关系，而是用极为精简和高效的位向量实现的，位向量是计算机程序中解决问题的一种常用方式，我们有必要理解和掌握。

除了实现机制，EnumSet的用法也有一些不同。次外，EnumSet可以说是处理枚举类型数据的一把利器，在一些应用领域，它非常方便和高效。

下面，我们先来看EnumSet的基本用法，然后通过一个场景来看EnumSet的应用，最后，我们分析EnumSet的实现机制。

基本用法

与TreeSet/HashSet不同，EnumSet是一个抽象类，不能直接通过new新建，也就是说，类似下面代码是错误的：

EnumSet<Size> set = new EnumSet<Size>();

不过，EnumSet提供了若干静态工厂方法，可以创建EnumSet类型的对象，比如：

public static <E extends Enum<E>> EnumSet<E> noneOf(Class<E> elementType)

noneOf方法会创建一个指定枚举类型的EnumSet，不含任何元素。创建的EnumSet对象的实际类型是EnumSet的子类，待会我们再分析其具体实现。

为方便举例，我们定义一个表示星期几的枚举类Day，值从周一到周日，如下所示：

1.  
   enum Day {
2.  
   MONDAY, TUESDAY, WEDNESDAY,
3.  
   THURSDAY, FRIDAY, SATURDAY, SUNDAY
4.  
   }

 可以这么用noneOf方法：

1.  
   Set<Day> weekend = EnumSet.noneOf(Day.class);
2.  
   weekend.add(Day.SATURDAY);
3.  
   weekend.add(Day.SUNDAY);
4.  
   System.out.println(weekend);

weekend表示休息日，noneOf返回的Set为空，添加了周六和周日，所以输出为：

[SATURDAY, SUNDAY]

EnumSet还有很多其他静态工厂方法，如下所示(省略了修饰public static)：

1.  
   // 初始集合包括指定枚举类型的所有枚举值
2.  
   <E extends Enum<E>> EnumSet<E> allOf(Class<E> elementType)
3.  
   // 初始集合包括枚举值中指定范围的元素
4.  
   <E extends Enum<E>> EnumSet<E> range(E from, E to)
5.  
   // 初始集合包括指定集合的补集
6.  
   <E extends Enum<E>> EnumSet<E> complementOf(EnumSet<E> s)
7.  
   // 初始集合包括参数中的所有元素
8.  
   <E extends Enum<E>> EnumSet<E> of(E e)
9.  
   <E extends Enum<E>> EnumSet<E> of(E e1, E e2)
10.  
    <E extends Enum<E>> EnumSet<E> of(E e1, E e2, E e3)
11.  
    <E extends Enum<E>> EnumSet<E> of(E e1, E e2, E e3, E e4)
12.  
    <E extends Enum<E>> EnumSet<E> of(E e1, E e2, E e3, E e4, E e5)
13.  
    <E extends Enum<E>> EnumSet<E> of(E first, E... rest)
14.  
    // 初始集合包括参数容器中的所有元素
15.  
    <E extends Enum<E>> EnumSet<E> copyOf(EnumSet<E> s)
16.  
    <E extends Enum<E>> EnumSet<E> copyOf(Collection<E> c)

可以看到，EnumSet有很多重载形式的of方法，最后一个接受的的是可变参数，其他重载方法看上去是多余的，之所以有其他重载方法是因为可变参数的运行效率低一些。

应用场景

下面，我们通过一个场景来看EnumSet的应用。

想象一个场景，在一些工作中，比如医生、客服，不是每个工作人员每天都在的，每个人可工作的时间是不一样的，比如张三可能是周一和周三，李四可能是周四和周六，给定每个人可工作的时间，我们可能有一些问题需要回答，比如：

• 有没有哪天一个人都不会来？
• 有哪些天至少会有一个人来？
• 有哪些天至少会有两个人来？
• 有哪些天所有人都会来，以便开会？
• 哪些人周一和周二都会来？ 

使用EnumSet，可以方便高效地回答这些问题，怎么做呢？我们先来定义一个表示工作人员的类Worker，如下所示：

1.  
   class Worker {
2.  
   String name;
3.  
   Set<Day> availableDays;
4.  
    
5.  
   public Worker(String name, Set<Day> availableDays) {
6.  
   this.name = name;
7.  
   this.availableDays = availableDays;
8.  
   }
9.  
    
10.  
    public String getName() {
11.  
    return name;
12.  
    }
13.  
     
14.  
    public Set<Day> getAvailableDays() {
15.  
    return availableDays;
16.  
    }
17.  
    }

为演示方便，将所有工作人员的信息放到一个数组workers中，如下所示：

1.  
   Worker[] workers = new Worker[]{
2.  
   new Worker("张三", EnumSet.of(
3.  
   Day.MONDAY, Day.TUESDAY, Day.WEDNESDAY, Day.FRIDAY)),
4.  
   new Worker("李四", EnumSet.of(
5.  
   Day.TUESDAY, Day.THURSDAY, Day.SATURDAY)),
6.  
   new Worker("王五", EnumSet.of(
7.  
   Day.TUESDAY, Day.THURSDAY)),
8.  
   };

每个工作人员的可工作时间用一个EnumSet表示。有了这个信息，我们就可以回答以上的问题了。

哪些天一个人都不会来？代码可以为：

1.  
   Set<Day> days = EnumSet.allOf(Day.class);
2.  
   for(Worker w : workers){
3.  
   days.removeAll(w.getAvailableDays());
4.  
   }
5.  
   System.out.println(days);

days初始化为所有值，然后遍历workers，从days中删除可工作的所有时间，最终剩下的就是一个人都不会来的时间，这实际是在求worker时间并集的补集，输出为：

[SUNDAY]

有哪些天至少会有一个人来？就是求worker时间的并集，代码可以为：

1.  
   Set<Day> days = EnumSet.noneOf(Day.class);
2.  
   for(Worker w : workers){
3.  
   days.addAll(w.getAvailableDays());
4.  
   }
5.  
   System.out.println(days);

输出为：

[MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY]

有哪些天所有人都会来？就是求worker时间的交集，代码可以为：

1.  
   Set<Day> days = EnumSet.allOf(Day.class);
2.  
   for(Worker w : workers){
3.  
   days.retainAll(w.getAvailableDays());
4.  
   }
5.  
   System.out.println(days);

输出为：

[TUESDAY]

哪些人周一和周二都会来？使用containsAll方法，代码可以为：

1.  
   Set<Worker> availableWorkers = new HashSet<Worker>();
2.  
   for(Worker w : workers){
3.  
   if(w.getAvailableDays().containsAll(
4.  
   EnumSet.of(Day.MONDAY,Day.TUESDAY))){
5.  
   availableWorkers.add(w);
6.  
   }
7.  
   }
8.  
   for(Worker w : availableWorkers){
9.  
   System.out.println(w.getName());
10.  
    }

输出为：

张三

哪些天至少会有两个人来？我们先使用EnumMap统计每天的人数，然后找出至少有两个人的天，代码可以为：

1.  
   Map<Day, Integer> countMap = new EnumMap<>(Day.class);
2.  
   for(Worker w : workers){
3.  
   for(Day d : w.getAvailableDays()){
4.  
   Integer count = countMap.get(d);
5.  
   countMap.put(d, count==null?1:count+1);
6.  
   }
7.  
   }
8.  
   Set<Day> days = EnumSet.noneOf(Day.class);
9.  
   for(Map.Entry<Day, Integer> entry : countMap.entrySet()){
10.  
    if(entry.getValue()>=2){
11.  
    days.add(entry.getKey());
12.  
    }
13.  
    }
14.  
    System.out.println(days);

输出为：

[TUESDAY, THURSDAY]

理解了EnumSet的使用，下面我们来看它是怎么实现的。

实现原理

位向量

EnumSet是使用位向量实现的，什么是位向量呢？就是用一个位表示一个元素的状态，用一组位表示一个集合的状态，每个位对应一个元素，而状态只可能有两种。

对于之前的枚举类Day，它有7个枚举值，一个Day的集合就可以用一个字节byte表示，最高位不用，设为0，最右边的位对应顺序最小的枚举值，从右到左，每位对应一个枚举值，1表示包含该元素，0表示不含该元素。

比如，表示包含Day.MONDAY，Day.TUESDAY，Day.WEDNESDAY，Day.FRIDAY的集合，位向量图示结构如下：

对应的整数是23。

位向量能表示的元素个数与向量长度有关，一个byte类型能表示8个元素，一个long类型能表示64个元素，那EnumSet用的长度是多少呢？

EnumSet是一个抽象类，它没有定义使用的向量长度，它有两个子类，RegularEnumSet和JumboEnumSet。RegularEnumSet使用一个long类型的变量作为位向量，long类型的位长度是64，而JumboEnumSet使用一个long类型的数组。如果枚举值个数小于等于64，则静态工厂方法中创建的就是RegularEnumSet，大于64的话就是JumboEnumSet。

内部组成

理解了位向量的基本概念，我们来看EnumSet的实现，同EnumMap一样，它也有表示类型信息和所有枚举值的实例变量，如下所示：

1.  
   final Class<E> elementType;
2.  
   final Enum[] universe;

elementType表示类型信息，universe表示枚举类的所有枚举值。

EnumSet自身没有记录元素个数的变量，也没有位向量，它们是子类维护的。

对于RegularEnumSet，它用一个long类型表示位向量，代码为：

private long elements = 0L;

它没有定义表示元素个数的变量，是实时计算出来的，计算的代码是：

1.  
   public int size() {
2.  
   return Long.bitCount(elements);
3.  
   }

对于JumboEnumSet，它用一个long数组表示，有单独的size变量，代码为：

1.  
   private long elements[];
2.  
   private int size = 0;

静态工厂方法

我们来看EnumSet的静态工厂方法noneOf，代码为：

1.  
   public static <E extends Enum<E>> EnumSet<E> noneOf(Class<E> elementType) {
2.  
   Enum[] universe = getUniverse(elementType);
3.  
   if (universe == null)
4.  
   throw new ClassCastException(elementType + " not an enum");
5.  
    
6.  
   if (universe.length <= 64)
7.  
   return new RegularEnumSet<>(elementType, universe);
8.  
   else
9.  
   return new JumboEnumSet<>(elementType, universe);
10.  
    }

getUniverse的代码与上节介绍的EnumMap是一样的，就不赘述了。如果元素个数不超过64，就创建RegularEnumSet，否则创建JumboEnumSet。

RegularEnumSet和JumboEnumSet的构造方法为：

1.  
   RegularEnumSet(Class<E>elementType, Enum[] universe) {
2.  
   super(elementType, universe);
3.  
   }
4.  
   JumboEnumSet(Class<E>elementType, Enum[] universe) {
5.  
   super(elementType, universe);
6.  
   elements = new long[(universe.length + 63) >>> 6];
7.  
   }

它们都调用了父类EnumSet的构造方法，其代码为：

1.  
   EnumSet(Class<E>elementType, Enum[] universe) {
2.  
   this.elementType = elementType;
3.  
   this.universe = universe;
4.  
   }

就是给实例变量赋值，JumboEnumSet根据元素个数分配足够长度的long数组。

其他工厂方法基本都是先调用noneOf构造一个空的集合，然后再调用添加方法，我们来看添加方法。

添加元素

RegularEnumSet的add方法的代码为：

1.  
   public boolean add(E e) {
2.  
   typeCheck(e);
3.  
    
4.  
   long oldElements = elements;
5.  
   elements |= (1L << ((Enum)e).ordinal());
6.  
   return elements != oldElements;
7.  
   }

主要代码是按位或操作：

elements |= (1L << ((Enum)e).ordinal());

(1L << ((Enum)e).ordinal())将元素e对应的位设为1，与现有的位向量elements相或，就表示添加e了。从集合论的观点来看，这就是求集合的并集。

JumboEnumSet的add方法的代码为：

1.  
   public boolean add(E e) {
2.  
   typeCheck(e);
3.  
    
4.  
   int eOrdinal = e.ordinal();
5.  
   int eWordNum = eOrdinal >>> 6;
6.  
    
7.  
   long oldElements = elements[eWordNum];
8.  
   elements[eWordNum] |= (1L << eOrdinal);
9.  
   boolean result = (elements[eWordNum] != oldElements);
10.  
    if (result)
11.  
    size++;
12.  
    return result;
13.  
    }

与RegularEnumSet的add方法的区别是，它先找对应的数组位置，eOrdinal >>> 6就是eOrdinal除以64，eWordNum就表示数组索引，有了索引之后，其他操作与RegularEnumSet就类似了。

对于其他操作，JumboEnumSet的思路是类似的，主要算法与RegularEnumSet一样，主要是增加了寻找对应long位向量的操作，或者有一些循环处理，逻辑也都比较简单，后文就只介绍RegularEnumSet的实现了。

RegularEnumSet的addAll方法的代码为：

1.  
   public boolean addAll(Collection<? extends E> c) {
2.  
   if (!(c instanceof RegularEnumSet))
3.  
   return super.addAll(c);
4.  
    
5.  
   RegularEnumSet es = (RegularEnumSet)c;
6.  
   if (es.elementType != elementType) {
7.  
   if (es.isEmpty())
8.  
   return false;
9.  
   else
10.  
    throw new ClassCastException(
11.  
    es.elementType + " != " + elementType);
12.  
    }
13.  
     
14.  
    long oldElements = elements;
15.  
    elements |= es.elements;
16.  
    return elements != oldElements;
17.  
    }

类型正确的话，就是按位或操作。

删除元素

remove方法的代码为：

1.  
   public boolean remove(Object e) {
2.  
   if (e == null)
3.  
   return false;
4.  
   Class eClass = e.getClass();
5.  
   if (eClass != elementType && eClass.getSuperclass() != elementType)
6.  
   return false;
7.  
    
8.  
   long oldElements = elements;
9.  
   elements &= ~(1L << ((Enum)e).ordinal());
10.  
    return elements != oldElements;
11.  
    }

主要代码是：

elements &= ~(1L << ((Enum)e).ordinal());

~是取反，该代码将元素e对应的位设为了0，这样就完成了删除。

从集合论的观点来看，remove就是求集合的差，A-B等价于A∩B’，B’表示B的补集。代码中，elements相当于A，(1L << ((Enum)e).ordinal())相当于B，~(1L << ((Enum)e).ordinal())相当于B’，elements &= ~(1L << ((Enum)e).ordinal())就相当于A∩B’，即A-B。

查看是否包含某元素

contains方法的代码为：

1.  
   public boolean contains(Object e) {
2.  
   if (e == null)
3.  
   return false;
4.  
   Class eClass = e.getClass();
5.  
   if (eClass != elementType && eClass.getSuperclass() != elementType)
6.  
   return false;
7.  
    
8.  
   return (elements & (1L << ((Enum)e).ordinal())) != 0;
9.  
   }

代码也很简单，按位与操作，不为0，则表示包含。

查看是否包含集合中的所有元素

containsAll方法的代码为：

1.  
   public boolean containsAll(Collection<?> c) {
2.  
   if (!(c instanceof RegularEnumSet))
3.  
   return super.containsAll(c);
4.  
    
5.  
   RegularEnumSet es = (RegularEnumSet)c;
6.  
   if (es.elementType != elementType)
7.  
   return es.isEmpty();
8.  
    
9.  
   return (es.elements & ~elements) == 0;
10.  
    }

最后的位操作有点晦涩。我们从集合论的角度解释下，containsAll就是在检查参数c表示的集合是不是当前集合的子集。一般而言，集合B是集合A的子集，即B⊆A，等价于A’∩B是空集∅，A’表示A的补集，如下图所示：

上面代码中，elements相当于A，es.elements相当于B，~elements相当于求A的补集，(es.elements & ~elements) == 0;就是在验证A’∩B是不是空集，即B是不是A的子集。

只保留参数集合中有的元素

retainAll方法的代码为：

1.  
   public boolean retainAll(Collection<?> c) {
2.  
   if (!(c instanceof RegularEnumSet))
3.  
   return super.retainAll(c);
4.  
    
5.  
   RegularEnumSet<?> es = (RegularEnumSet<?>)c;
6.  
   if (es.elementType != elementType) {
7.  
   boolean changed = (elements != 0);
8.  
   elements = 0;
9.  
   return changed;
10.  
    }
11.  
     
12.  
    long oldElements = elements;
13.  
    elements &= es.elements;
14.  
    return elements != oldElements;
15.  
    }

从集合论的观点来看，这就是求集合的交集，所以主要代码就是按位与操作，容易理解。

求补集

EnumSet的静态工厂方法complementOf是求补集，它调用的代码是：

1.  
   void complement() {
2.  
   if (universe.length != 0) {
3.  
   elements = ~elements;
4.  
   elements &= -1L >>> -universe.length; // Mask unused bits
5.  
   }
6.  
   }

这段代码也有点晦涩，elements=~elements比较容易理解，就是按位取反，相当于就是取补集，但我们知道elements是64位的，当前枚举类可能没有用那么多位，取反后高位部分都变为了1，需要将超出universe.length的部分设为0。下面代码就是在做这件事：

elements &= -1L >>> -universe.length; 

-1L是64位全1的二进制，我们在剖析Integer一节介绍过移动位数是负数的情况，上面代码相当于：

elements &= -1L >>> (64-universe.length); 

如果universe.length为7，则-1L>>>(64-7)就是二进制的1111111，与elements相与，就会将超出universe.length部分的右边的57位都变为0。

实现原理小结

以上就是EnumSet的基本实现原理，内部使用位向量，表示很简洁，节省空间，大部分操作都是按位运算，效率极高。

小结

本节介绍了EnumSet的用法和实现原理，用法上，它是处理枚举类型数据的一把利器，简洁方便，实现原理上，它使用位向量，精简高效。

对于只有两种状态，且需要进行集合运算的数据，使用位向量进行表示、位运算进行处理，是计算机程序中一种常用的思维方式。

至此，关于具体的容器类，我们就介绍完了。Java容器类中还有一些过时的容器类，以及一些不常用的类，我们就不介绍了。

在介绍具体容器类的过程中，我们忽略了一个实现细节，那就是，所有容器类其实都不是从头构建的，它们都继承了一些抽象容器类。这些抽象类提供了容器接口的部分实现，方便了Java具体容器类的实现。如果我们需要实现自定义的容器类，也应该考虑从这些抽象类继承。

那，具体都有什么抽象类？它们都提供了哪些基础功能？如何进行扩展呢？让我们下节来探讨。