简介
集合,这个概念有点模糊。
- 广义上来讲,java 中的集合是指 java.util 包下面的容器类,包括和 Collection 及 Map 相关的所有类。
- 中义上来讲,我们一般说集合特指 java 集合中的 Collection 相关的类,不包含 Map 相关的类。
- 狭义上来讲,数学上的集合是指不包含重复元素的容器,即集合中不存在两个相同的元素,在 java 里面对应 Set。
具体怎么来理解还是要看上下文环境。
比如,面试别人让你说下 java 中的集合,这时候肯定是广义上的。
再比如,下面我们讲的把另一个集合中的元素全部添加到 Set 中,这时候就是中义上的。
HashSet 是 Set 的一种实现方式,底层主要使用 HashMap 来确保元素不重复。
源码分析
属性
// 内部使用 HashMap
private transient HashMap<E,Object> map;
// 虚拟对象,用来作为 value 放到 map 中
private static final Object PRESENT = new Object();
构造方法
public HashSet() {map = new HashMap<>();
}
public HashSet(Collection<? extends E> c) {map = new HashMap<>(Math.max((int) (c.size()/.75f) + 1, 16));
addAll(c);
}
public HashSet(int initialCapacity, float loadFactor) {map = new HashMap<>(initialCapacity, loadFactor);
}
public HashSet(int initialCapacity) {map = new HashMap<>(initialCapacity);
}
// 非 public,主要是给 LinkedHashSet 使用的
HashSet(int initialCapacity, float loadFactor, boolean dummy) {map = new LinkedHashMap<>(initialCapacity, loadFactor);
}
构造方法都是调用 HashMap 对应的构造方法。
最后一个构造方法有点特殊,它不是 public 的,意味着它只能被同一个包或者子类调用,这是 LinkedHashSet 专属的方法。
添加元素
直接调用 HashMap 的 put() 方法,把元素本身作为 key,把 PRESENT 作为 value,也就是这个 map 中所有的 value 都是一样的。
public boolean add(E e) {return map.put(e, PRESENT)==null;
}
删除元素
直接调用 HashMap 的 remove() 方法,注意 map 的 remove 返回是删除元素的 value,而 Set 的 remov 返回的是 boolean 类型。
这里要检查一下,如果是 null 的话说明没有该元素,如果不是 null 肯定等于 PRESENT。
public boolean remove(Object o) {return map.remove(o)==PRESENT;
}
查询元素
Set 没有 get() 方法哦,因为 get 似乎没有意义,不像 List 那样可以按 index 获取元素。
这里只要一个检查元素是否存在的方法 contains(),直接调用 map 的 containsKey() 方法。
public boolean contains(Object o) {return map.containsKey(o);
}
遍历元素
直接调用 map 的 keySet 的迭代器。
public Iterator<E> iterator() {return map.keySet().iterator();}
全部源码
package java.util;
import java.io.InvalidObjectException;
import sun.misc.SharedSecrets;
public class HashSet<E>
extends AbstractSet<E>
implements Set<E>, Cloneable, java.io.Serializable
{
static final long serialVersionUID = -5024744406713321676L;
// 内部元素存储在 HashMap 中
private transient HashMap<E,Object> map;
// 虚拟元素,用来存到 map 元素的 value 中的,没有实际意义
private static final Object PRESENT = new Object();
// 空构造方法
public HashSet() {map = new HashMap<>();
}
// 把另一个集合的元素全都添加到当前 Set 中
// 注意,这里初始化 map 的时候是计算了它的初始容量的
public HashSet(Collection<? extends E> c) {map = new HashMap<>(Math.max((int) (c.size()/.75f) + 1, 16));
addAll(c);
}
// 指定初始容量和装载因子
public HashSet(int initialCapacity, float loadFactor) {map = new HashMap<>(initialCapacity, loadFactor);
}
// 只指定初始容量
public HashSet(int initialCapacity) {map = new HashMap<>(initialCapacity);
}
// LinkedHashSet 专用的方法
// dummy 是没有实际意义的, 只是为了跟上上面那个操持方法签名不同而已
HashSet(int initialCapacity, float loadFactor, boolean dummy) {map = new LinkedHashMap<>(initialCapacity, loadFactor);
}
// 迭代器
public Iterator<E> iterator() {return map.keySet().iterator();}
// 元素个数
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;
}
// 清空所有元素
public void clear() {map.clear();
}
// 克隆方法
@SuppressWarnings("unchecked")
public Object clone() {
try {HashSet<E> newSet = (HashSet<E>) super.clone();
newSet.map = (HashMap<E, Object>) map.clone();
return newSet;
} catch (CloneNotSupportedException e) {throw new InternalError(e);
}
}
// 序列化写出方法
private void writeObject(java.io.ObjectOutputStream s)
throws java.io.IOException {
// 写出非 static 非 transient 属性
s.defaultWriteObject();
// 写出 map 的容量和装载因子
s.writeInt(map.capacity());
s.writeFloat(map.loadFactor());
// 写出元素个数
s.writeInt(map.size());
// 遍历写出所有元素
for (E e : map.keySet())
s.writeObject(e);
}
// 序列化读入方法
private void readObject(java.io.ObjectInputStream s)
throws java.io.IOException, ClassNotFoundException {
// 读入非 static 非 transient 属性
s.defaultReadObject();
// 读入容量, 并检查不能小于 0
int capacity = s.readInt();
if (capacity < 0) {
throw new InvalidObjectException("Illegal capacity:" +
capacity);
}
// 读入装载因子, 并检查不能小于等于 0 或者是 NaN(Not a Number)
// java.lang.Float.NaN = 0.0f / 0.0f;
float loadFactor = s.readFloat();
if (loadFactor <= 0 || Float.isNaN(loadFactor)) {
throw new InvalidObjectException("Illegal load factor:" +
loadFactor);
}
// 读入元素个数并检查不能小于 0
int size = s.readInt();
if (size < 0) {
throw new InvalidObjectException("Illegal size:" +
size);
}
// 根据元素个数重新设置容量
// 这是为了保证 map 有足够的容量容纳所有元素, 防止无意义的扩容
capacity = (int) Math.min(size * Math.min(1 / loadFactor, 4.0f),
HashMap.MAXIMUM_CAPACITY);
// 再次检查某些东西, 不重要的代码忽视掉
SharedSecrets.getJavaOISAccess()
.checkArray(s, Map.Entry[].class, HashMap.tableSizeFor(capacity));
// 创建 map, 检查是不是 LinkedHashSet 类型
map = (((HashSet<?>)this) instanceof LinkedHashSet ?
new LinkedHashMap<E,Object>(capacity, loadFactor) :
new HashMap<E,Object>(capacity, loadFactor));
// 读入所有元素, 并放入 map 中
for (int i=0; i<size; i++) {@SuppressWarnings("unchecked")
E e = (E) s.readObject();
map.put(e, PRESENT);
}
}
// 可分割的迭代器, 主要用于多线程并行迭代处理时使用
public Spliterator<E> spliterator() {return new HashMap.KeySpliterator<E,Object>(map, 0, -1, 0, 0);
}
}
总结
(1)HashSet 内部使用 HashMap 的 key 存储元素,以此来保证元素不重复;
(2)HashSet 是无序的,因为 HashMap 的 key 是无序的;
(3)HashSet 中允许有一个 null 元素,因为 HashMap 允许 key 为 null;
(4)HashSet 是非线程安全的;
(5)HashSet 是没有 get() 方法的;
相关学习
(1)阿里手册上有说,使用 java 中的集合时要自己指定集合的大小,通过这篇源码的分析,我们发现有下面这个构造方法,很清楚明白地告诉了我们怎么指定容量。
假如,我们预估 HashMap 要存储 n 个元素,那么,它的容量就应该指定为 ((n/0.75f) + 1),如果这个值小于 16,那就直接使用 16 得了。
初始化时指定容量是为了减少扩容的次数,提高效率。
public HashSet(Collection<? extends E> c) {map = new HashMap<>(Math.max((int) (c.size()/.75f) + 1, 16));
addAll(c);
}
(2)什么是 fail-fast?
fail-fast 机制是 java 集合中的一种错误机制。
当使用迭代器迭代时,如果发现集合有修改,则快速失败做出响应,抛出 ConcurrentModificationException 异常。
这种修改有可能是其它线程的修改,也有可能是当前线程自己的修改导致的,比如迭代的过程中直接调用 remove() 删除元素等。
另外,并不是 java 中所有的集合都有 fail-fast 的机制。比如,像最终一致性的 ConcurrentHashMap、CopyOnWriterArrayList 等都是没有 fast-fail 的。
那么,fail-fast 是怎么实现的呢?
像 ArrayList、HashMap 中都有一个属性叫 modCount,每次对集合的修改这个值都会加 1,在遍历前记录这个值到 expectedModCount 中,遍历中检查两者是否一致,如果出现不一致就说明有修改,则抛出 ConcurrentModificationException 异常。