一、Set 实现类之 UML 类图
Attention
:TreeSet 实现的直接父接口是 NavigableSet,而 NavigableSet 继承了 SortedSet 接口- 截取自本人博文: Java 集合框架 (The Collections Framework) 之 UML 类图
二、HashSet
2.1 HashSet 的类声明
public class HashMap<K,V> extends AbstractMap<K,V>
implements Map<K,V>, Cloneable, Serializable
{
//
}
根据 HashSet 的类声明可知,HashSet 支持克隆、支持序列化。
2.2 HashSet 的成员变量
- 根据上图可知,HashSet 的底层是基于 HashMap 的,通过进一步阅读源码可以发现,HashSet 保存的元素其实就是其成员变量 map 的所有 key 值。(这一点与面向对象设计模式的CRP-合成复用原则一致,通过合成复用,HashSet 不仅复用了 HashMap 的代码,又没有破坏 HashMap 的封装性,而若通过继承,则 HashSet 显然会破坏 HashMap 封装性而能够使用 HashMap 的方法)
- 为什么 HashSet 有一个静态常量 PRESENT,且类型为 Object?
关于这一点,我们可以查看在 HashSet 方法中 PRESENT 的使用情况,如下:
public boolean add(E e) {
return map.put(e, PRESENT)==null;
}
public boolean remove(Object o) {
return map.remove(o)==PRESENT;
}
根据 HashSet 的 add(E e) 方法可知,其成员变量 map 的 value 均为 PRESENT (静态常量:Object 实例),那么为什么要使用 PRESENT 作为其成员变量 map 的 value 呢?倘若我们的 PRESENT 是 null (或者说无 PRESENT 这一静态成员常量) ,那么 map.put(e, PRESENT) 的返回值始终都为 null,那么add(E e) 方法的返回值始终都为 true,这样的话,对于 HashSet ,其元素添加是否成功我们无从得知;对于 remove(Object o) 也是如此。
2.3 HashSet 的构造方法
- 空构造方法
/**
* Constructs a new, empty set; the backing <tt>HashMap</tt> instance has
* default initial capacity (16) and load factor (0.75).
*/
public HashSet() {
map = new HashMap<>();
}
构建一个新的空的 HashSet,该构造方法通过实例化一个具有默认初始容量16以及默认载入因子0.75的 HashMap() 对象为其成员变量 map 赋值。
- 带参构造方法:public HashSet(int initialCapacity){}
/**
* Constructs a new, empty set; the backing <tt>HashMap</tt> instance has
* the specified initial capacity and default load factor (0.75).
*
* @param initialCapacity the initial capacity of the hash table
* @throws IllegalArgumentException if the initial capacity is less
* than zero
*/
public HashSet(int initialCapacity) {
map = new HashMap<>(initialCapacity);
}
与空构造方法无异,还是构建一个新的空的 HashSet,不过是通过实例化一个指定初始容量initialCapacity以及默认载入因子0.75的 HashMap() 对象为其成员变量 map 赋值。
- 带参构造方法:public HashSet(int initialCapacity, float loadFactor){}
/**
* Constructs a new, empty set; the backing <tt>HashMap</tt> instance has
* the specified initial capacity and the specified load factor.
*
* @param initialCapacity the initial capacity of the hash map
* @param loadFactor the load factor of the hash map
* @throws IllegalArgumentException if the initial capacity is less
* than zero, or if the load factor is nonpositive
*/
public HashSet(int initialCapacity, float loadFactor) {
map = new HashMap<>(initialCapacity, loadFactor);
}
与空构造方法无异,还是构建一个新的空的 HashSet,不过是通过实例化一个指定初始容量initialCapacity以及指定载入因子loadFactor 的 HashMap() 对象为其成员变量 map 赋值。
- 带参构造方法:public HashSet(Collection<? extends E> c){}
/**
* Constructs a new set containing the elements in the specified
* collection. The <tt>HashMap</tt> is created with default load factor
* (0.75) and an initial capacity sufficient to contain the elements in
* the specified collection.
*
* @param c the collection whose elements are to be placed into this set
* @throws NullPointerException if the specified collection is null
*/
public HashSet(Collection<? extends E> c) {
map = new HashMap<>(Math.max((int) (c.size()/.75f) + 1, 16));
addAll(c);
}
构建一个包含指定集合所有元素的 HashSet,通过实例化一个初始容量为c.size()/.75f) + 1
与16
的较大者、默认载入因子0.75的 HashMap() 对象为其成员变量 map 赋值。
- 有参构造方法:HashSet(int initialCapacity, float loadFactor, boolean dummy)
/**
* Constructs a new, empty linked hash set. (This package private
* constructor is only used by LinkedHashSet.) The backing
* HashMap instance is a LinkedHashMap with the specified initial
* capacity and the specified load factor.
*
* @param initialCapacity the initial capacity of the hash map
* @param loadFactor the load factor of the hash map
* @param dummy ignored (distinguishes this
* constructor from other int, float constructor.)
* @throws IllegalArgumentException if the initial capacity is less
* than zero, or if the load factor is nonpositive
*/
HashSet(int initialCapacity, float loadFactor, boolean dummy) {
map = new LinkedHashMap<>(initialCapacity, loadFactor);
}
根据源码,该构造方法没有访问修饰符(即,默认),那么它是一个package private 的构造方法(也就是说,只在自己的包中可见,即只在java.util包可见),因此我们不能通过该构造方法构造一个 HashSet。根据注释也可知道,该构造方法只在 LinkedHashSet 使用到,关于这部分,在下文 LinkedHashSet 的构造方法有涉及。还有一点,该构造方法的第三个参数 dummy 只是为了区别于public HashSet(int initialCapacity, float loadFactor)
这一构造方法。
2.4 HashSet 的线程安全性
通过阅读源码,HashSet 的方法直接or间接的(HashSet 通过调用 HashMap 的方法实现的方法)都不存在synchronized
关键字且方法体无任何锁机制,故而是线程不安全的。
三、LinkedHashSet
2.1 LinkedHashSet 的类声明
public class LinkedHashSet<E>
extends HashSet<E>
implements Set<E>, Cloneable, java.io.Serializable
{
//
}
根据 LinkedHashSet 的类声明可知,LinkedHashSet 支持克隆、支持序列化。
2.2 LinkedHashSet 的构造方法
阅读源码其实可以发现,LinkedHashSet 除了构造方法以外,仅有一个spliterator()
方法,该方法是用于获取Spliterator的,即Splitable iterator(可分割迭代器,一个Java为了并行遍历数据源中的元素而设计的迭代器),具体请自己查阅相关文章。下面对 LinkedHashSet 的构造方法进行介绍:
根据上图,LinkedHashSet 的构造方法都无一例外的调用了父类 HashSet 的无访问修饰符的构造方法,其父类的无访问修饰符的构造方法如下:
HashSet(int initialCapacity, float loadFactor, boolean dummy) {
map = new LinkedHashMap<>(initialCapacity, loadFactor);
}
故而可以发现,LinkedHashSet 的底层实现是基于 LinkedHashMap 的,通过实例化一个初始容量为initialCapacity
的、载入因子为loadFactor
(initialCapacity
与loadFactor
的值均由LinkedHashSet的构造方法设置而得) 的 LinkedHashMap() 对象为成员变量 map 赋值。
2.3 LinkedHashSet 的线程安全性
由于LinkedHashSet除了spliterator()
外只有构造方法,故而 LinkedHashSet 的方法调用调用的都是父类 HashSet 的方法,又由于 HashSet 的方法直接or间接地都不存在synchronized
关键字且方法体无任何锁机制,故而也是线程不安全的。
四、TreeSet
4.1 TreeSet 的类声明
public class TreeSet<E> extends AbstractSet<E>
implements NavigableSet<E>, Cloneable, java.io.Serializable
{
//
}
根据 TreeSet 的类声明可知,TreeSet 支持克隆、支持序列化,且TreeSet实现了NavigableSet接口(SortedSet的直接子接口),那么其实可以预见,TreeSet 的 元素之间是有序的。
4.2 TreeSet 的成员变量
TreeSet 的成员变量如下(当然还有一个静态长整型常量serialVersionUID
):
/**
* The backing map.
*/
private transient NavigableMap<E,Object> m;
// Dummy value to associate with an Object in the backing Map
private static final Object PRESENT = new Object();
首先,来看一下PRESENT变量,其实该变量的作用与上文 HashSet 部分提到的基本一致:
其次,我们来看一下不可序列化的成员变量 m
,其类型为 NavigableMap<E,Object>
(接口类型),鉴于接口不能实例化,所以 TreeSet 的底层是应该是基于 NavigableMap 的实现类的,即 TreeMap 与 ConcurrentSkipListSet,那么究竟基于谁,请见TreeSet 的构造方法
部分。(其实多半也可以猜到,哈哈)
4.3 TreeSet 的构造方法
- 无参构造方法与带参构造方法
TreeSet(NavigableMap<E,Object> m){}
/**
* Constructs a new, empty tree set, sorted according to the
* natural ordering of its elements. All elements inserted into
* the set must implement the {@link Comparable} interface.
* Furthermore, all such elements must be <i>mutually
* comparable</i>: {@code e1.compareTo(e2)} must not throw a
* {@code ClassCastException} for any elements {@code e1} and
* {@code e2} in the set. If the user attempts to add an element
* to the set that violates this constraint (for example, the user
* attempts to add a string element to a set whose elements are
* integers), the {@code add} call will throw a
* {@code ClassCastException}.
*/
public TreeSet() {
this(new TreeMap<E,Object>());
}
创建一个新的空的 TreeSet,其元素的排序规则按元素的自然序排序。由于需要排序,TreeSet 的任何元素对应的类必须实现Comparable接口。
那么,对于上文疑问——TreeSet 的底层是基于 TreeMap 还是 ConcurrentSkipListSet,就有了初步解答:TreeSet 的底层是基于 TreeMap 的。
还有一点需要补充,该构造方法调用了一个无修饰符的构造方法,即:
/**
* Constructs a set backed by the specified navigable map.
*/
TreeSet(NavigableMap<E,Object> m) {
this.m = m;
}
鉴于我们不能使用该构造方法构建 TreeSet 实例,那么关于TreeSet 的底层是基于 TreeMap 还是 ConcurrentSkipListSet的进一步解答还需看余下的构造方法。
- 带参构造方法:public TreeSet(Comparator<? super E> comparator)
/**
* Constructs a new, empty tree set, sorted according to the specified
* comparator. All elements inserted into the set must be <i>mutually
* comparable</i> by the specified comparator: {@code comparator.compare(e1,
* e2)} must not throw a {@code ClassCastException} for any elements
* {@code e1} and {@code e2} in the set. If the user attempts to add
* an element to the set that violates this constraint, the
* {@code add} call will throw a {@code ClassCastException}.
*
* @param comparator the comparator that will be used to order this set.
* If {@code null}, the {@linkplain Comparable natural
* ordering} of the elements will be used.
*/
public TreeSet(Comparator<? super E> comparator) {
this(new TreeMap<>(comparator));
}
创建一个新的空的TreeSet,但是其元素的排序规则是根据传入的Comparator设定的。这一构造函数同样调用了一个无修饰符的构造方法。根据该构造函数,TreeSet 的底层是基于 TreeMap 还是 ConcurrentSkipListSet 的进一步解答是:TreeSet 是基于 TreeMap 的。
- 带参构造函数:public TreeSet(Collection<? extends E> c)
/**
* Constructs a new tree set containing the elements in the specified
* collection, sorted according to the <i>natural ordering</i> of its
* elements. All elements inserted into the set must implement the
* {@link Comparable} interface. Furthermore, all such elements must be
* <i>mutually comparable</i>: {@code e1.compareTo(e2)} must not throw a
* {@code ClassCastException} for any elements {@code e1} and
* {@code e2} in the set.
*
* @param c collection whose elements will comprise the new set
* @throws ClassCastException if the elements in {@code c} are
* not {@link Comparable}, or are not mutually comparable
* @throws NullPointerException if the specified collection is null
*/
public TreeSet(Collection<? extends E> c) {
this();
addAll(c);
}
从指定集合c中创建 TreeSet ,该构造方法调用了无参构造方法,因此TreeSet 的底层是基于 TreeMap 还是 ConcurrentSkipListSet 的更进一步解答是:TreeSet 是基于 TreeMap 的。
- 带参构造方法:public TreeSet(SortedSet s)
/**
* Constructs a new tree set containing the same elements and
* using the same ordering as the specified sorted set.
*
* @param s sorted set whose elements will comprise the new set
* @throws NullPointerException if the specified sorted set is null
*/
public TreeSet(SortedSet<E> s) {
this(s.comparator());
addAll(s);
}
从指定有序集s中创建 TreeSet,其元素排序规则与有序集排序规则一致。鉴于TreeSet 无其它构造方法了,那么关于 TreeSet 的底层是基于 TreeMap 还是 ConcurrentSkipListSet 的确切解答是 TreeMap。
4.4 TreeSet 的线程安全性
与 HashSet 一样,通过阅读源码,TreeSet 的方法直接or间接的(TreeSet 通过调用 TreeMap 的方法实现的方法)都不存在synchronized
关键字且方法体无任何锁机制,故而是线程不安全的。
五、CopyOnWriteArraySet
4.1 CopyOnWriteArraySet 的 类声明
public class CopyOnWriteArraySet<E> extends AbstractSet<E>
implements java.io.Serializable
{
//
}
根据 CopyOnWriteArraySet 的类声明可知,CopyOnWriteArraySet 支持序列化
4.2 CopyOnWriteArraySet 的 成员变量
private static final long serialVersionUID = 5457747651344034263L;
private final CopyOnWriteArrayList<E> al;
CopyOnWriteArraySet 的底层是基于 CopyOnWriteArrayList 的
4.3 CopyOnWriteArraySet 的 构造方法
- 无参构造方法
/**
* Creates an empty set.
*/
public CopyOnWriteArraySet() {
al = new CopyOnWriteArrayList<E>();
}
直接为成员变量实例化赋值。
- 带参构造方法:从指定集合构建实例对象
/**
* Creates a set containing all of the elements of the specified
* collection.
*
* @param c the collection of elements to initially contain
* @throws NullPointerException if the specified collection is null
*/
public CopyOnWriteArraySet(Collection<? extends E> c) {
if (c.getClass() == CopyOnWriteArraySet.class) {
@SuppressWarnings("unchecked") CopyOnWriteArraySet<E> cc =
(CopyOnWriteArraySet<E>)c;
al = new CopyOnWriteArrayList<E>(cc.al);
}
else {
al = new CopyOnWriteArrayList<E>();
al.addAllAbsent(c);
}
}
4.4 CopyOnWriteArraySet 的线程安全性
通过阅读源码,CopyOnWriteArraySet 的方法实现都是基于CopyOnWriteArrayList 的,由于CopyOnWriteArrayList 是线程安全的,因此 CopyOnWriteArraySet 是线程安全的。
六、总结
6.1 Set 实现类的线程安全性
- HashSet 是线程不安全的
- LinkedHashSet 是线程不安全的
- TreeSet 是线程不安全的
- CopyOnWriteArraySet 是线程安全的
6.2 Set 实现类的底层实现
- HashSet 的底层实现是基于 HashMap 的
- LinkedHashSet 的底层实现是基于 LinkedMap 的
- TreeSet 的底层实现是基于 TreeMap 的
- CopyOnWriteArraySet 的底层实现是基于CopyOnWriteArrayList 的