Java Collections Framework 源码分析(4.1 - Set) - Reading-Thinking-Sharing

Java Collections Framework 源码分析(4.1 - Set)

前两篇文章介绍了 List 接口的两个实现类，List 数据结构的特定很明显，支持通过序号的随机访问，支持添加重复元素等。而本篇介绍的数据结构 Set 与 List 有较大的差异，Set 不支持添加重复元素，也不支持随机访问某个元素，内部元素的存放也不一定是有序的。下面会介绍 Set 接口的几个实现，帮助大家了解 Set 的具体特性以及之下的原理。

`Set` 接口

从 Set 接口的注释上可以了解到 Set 的一些特点：

* `Set` 中不允许存放重复的元素，重复元素的判断标准是 `equals` 方法返回 true 或者 false。
* 有些 `Set` 的实现对放入容器内的元素类型有特殊的要求，例如有的不允许放入 null 值，而有的则允许。
* 当 `Set` 中放入可变对象，而该对象的状态变化会引起 `equals` 方法返回结果时，`Set` 很多方法的返回结果是不可知，这点在实际开发中需要特别的注意。

从代码上来看 Set 接口只是单纯的继承了 Collection 接口，并没有添加其他额外的方法。

`HashSet`

HashSet 是开发人员日常工作中使用最多的一种 Set 数据类型，甚至在很大程度下是开发人员使用过的唯一的 Set 数据类型。

先来看看 HashSet 的类图：

0 (1).jpeg

从继承体系来看 HashSet 继承了 AbstractSet 抽象类，并实现了 Set 接口。AbstractSet 中的代码很简单，它主要实现了 hashCode 和 equals 方法，其中的逻辑很简单，这里也不赘述了。此外它还实现了 removeAll 方法，通过迭代器的循环移除与传入参数容器中相同的元素。

回到 HashSet 本身的代码，源码的注释告诉了我们以下的特性：

* `HashSet` 使用 `HashMap` 存放数据
* `HashSet` 允许存放 null 值
* `HashSet` 不是线程安全的，类似 `ArrayList` 和 `LinkedList` 
* `add`，`remove`，`contains`，`size` 方法的时间复杂度是 O(1)，即是常量时间

注释中提及的比较有意思的一点是，对 HashSet 进行迭代时，花费的时间是 O(n) 的，与 size 方法返回的数字(代表了 set 内有多少元素)和 HashSet 内的 HashMap 的 capacity 有关，因此在初始化一个 HashSet 时不应该过高的设置 capacity 的值，也不应该过低的设置 load factor 的值。这两个值的具体作用我会在 HashMap 源码分析时详细说明。

最后一点需要注意的是 HashSet 迭代时是无法保证元素顺序的，因此 HashSet 是无序的容器，类似数学意义上 Set(集合)的概念。

接下来可以开始浏览源代码，了解 HashSet 的细节了。首先看一下 HashSet 的成员变量：

private transient HashMap<E,Object> map;

// Dummy value to associate with an Object in the backing Map
private static final Object PRESENT = new Object();

成员变量很简单，map 是用来存放元素的，实际存放元素的是 HashMap 的 key，因此 value 部分用一个私有的静态变量 PRESENT 来填充，节约内存。

看一下几个核心的方法，你会发现非常简单，都是直接调用了 HashMap 上对应的方法，如下：

public int size() {
    return map.size();
}

public boolean isEmpty() {
    return map.isEmpty();
}

public boolean contains(Object o) {
    return map.containsKey(o);
}

public boolean add(E e) {
    return map.put(e, PRESENT)==null;
}

public boolean remove(Object o) {
    return map.remove(o)==PRESENT;
}

所以 HashSet 只是 HashMap 的一个简单包装，但是有个构造函数值得看一下：

HashSet(int initialCapacity, float loadFactor, boolean dummy) {
    map = new LinkedHashMap<>(initialCapacity, loadFactor);
}

在这个构造函数中，把存放数据的 HashMap 改为了 LinkedHashMap，而这个构造函数同一般的构造函数也有所不同，它不是 public 的，而是 default 的。看一下注释，可以发现这个构造函数是用来初始化 LinkedHashSet 的。HashSet 并没有特别的地方介绍了，就让我们看看这个 LinkedHashSet 有何不同。

`LinkedHashSet`

从代码层面来看 LinkedHashSet 也比较简单，它是 HashSet 的子类，同时它使用 LinkedHashMap 存放数据而不是 HashMap。从注释来看它的特性有几下几条：

* 对 `LinkedHashSet` 进行迭代时，迭代顺序是有保证的，它会按照插入操作的先后顺序对元素进行迭代。
* `add`，`contains`，`remove` 的时间复杂度也是常量的，但是在性能上稍低于 `HashSet`，因为它需要额外的操作维护链表的数据结构。
* 但是在使用 `Iterator` 对容器进行迭代时，性能稍高于 `HashSet`，因为它的时间复杂度由 `size` 决定，而不需要像 `HashSet` 那样还要考虑 `capacity` 的值。

结语

Set 接口的实现分为两大类，其一是本次介绍的以 HashSet 为代表的无序集合，还有一类是有序集合，具体的实现是 TreeSet。下一篇文章会详细介绍 TreeSet 的特点和代码的细节，希望大家不要错过哦！

欢迎关注我的微信号「且把金针度与人」,获取更多高质量文章

Java Collections Framework 源码分析(4.1 - Set)