Java集合（5）：HashSet

　　存入Set的每个元素必须是惟一的，因为Set不保存重复元素。加入Set的元素必须定义equals()方法以确保对象的唯一性。Set不保证维护元素的次序。Set与Collection有完全一样的接口。

一.HashSet介绍

　　HashSet实现Set接口，它是基于HashMap来实现的，底层采用HashMap来保存元素。它不保证set 的迭代顺序，特别是它不保证该顺序恒久不变。此类允许使用null元素。

　　在没有其他限制的情况下需要Set时应尽量使用HashSet，因为它对速度进行了优化。

1.HashSet的继承关系

public class HashSet<E>
    extends AbstractSet<E>
    implements Set<E>, Cloneable, java.io.Serializable

2.HashSet的类图关系如下：

　　HashSet继承AbstractSet类，实现Set、Cloneable、Serializable接口。其中AbstractSet提供 Set 接口的骨干实现，从而最大限度地减少了实现此接口所需的工作。Set接口是一种不包括重复元素的Collection，它维持它自己的内部排序，所以随机访问没有任何意义。

二.HashSet源码解析

1.私有属性

//基于HashMap实现，底层使用HashMap保存所有元素
private transient HashMap<E,Object> map;

//定义一个Object对象作为HashMap的value
private static final Object PRESENT = new Object();

总结一下，HashSet的实现方式大致如下，通过一个HashMap存储元素，元素是存放在HashMap的Key中，而Value统一使用一个Object对象。

2.HashSet的构造方法

HashSet一共有5个构造函数。

/**
 * 默认构造函数
 * 初始化一个空的HashMap，并使用默认初始容量为16和加载因子0.75。
 */
public HashSet() {
    map = new HashMap<>();
}

/**
 * 构造一个包含指定 collection 中的元素的新 set。
 * collection中所有元素的初始容量来创建一个HashMap。 
 * @param c 其中的元素将存放在此set中的collection。
 */
public HashSet(Collection<? extends E> c) {
    map = new HashMap<>(Math.max((int) (c.size()/.75f) + 1, 16));
    addAll(c);
}

/**
 * 构造一个新的空 set，其底层 HashMap 实例具有指定的初始容量和指定的加载因子
 * @param initialCapacity 初始容量。 
 * @param loadFactor 加载因子。
 */
public HashSet(int initialCapacity, float loadFactor) {
    map = new HashMap<>(initialCapacity, loadFactor);
}

/**
 * 构造一个新的空 set，其底层 HashMap 实例具有指定的初始容量和默认的加载因子（0.75）。
 * @param initialCapacity 初始容量。
 */
public HashSet(int initialCapacity) {
   map = new HashMap<>(initialCapacity);
}

/**
 * 此构造函数为包访问权限，不对外公开，实际只是是对LinkedHashSet的支持。
 * 以指定的initialCapacity和loadFactor构造一个新的空链接哈希集合。
 * @param initialCapacity 初始容量。 
 * @param loadFactor 加载因子。 
 * @param dummy 标记。 
 */
HashSet(int initialCapacity, float loadFactor, boolean dummy) {
   map = new LinkedHashMap<>(initialCapacity, loadFactor);
}

　　HashSet所有的构造都是构造出一个新的HashMap，其中最后一个构造函数，为包访问权限是不对外公开，仅仅只在使用LinkedHashSet时才会发生作用。

3.HashSet的其他方法

　　因为HashSet是基于HashMap，那么对于HashSet而言，其方法的实现过程是非常简单的。

3.1 iterator

public Iterator<E> iterator() {
        return map.keySet().iterator();
}

　　iterator()方法返回对此 set 中元素进行迭代的迭代器。返回元素的顺序并不是特定的。底层调用HashMap的keySet返回所有的key，这点反应了HashSet中的所有元素都是保存在HashMap的key中，value则是使用的PRESENT对象，该对象为static final。

3.2 size

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

　　size()返回此 set 中的元素的数量（set 的容量）。底层调用HashMap的size方法，返回HashMap容器的大小。

3.3 isEmpty

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

　　isEmpty()，判断HashSet()集合是否为空，为空返回 true，否则返回false。

3.4 contains

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

　　contains()，判断某个元素是否存在于HashSet()中，存在返回true，否则返回false。更加确切的讲应该是要满足这种关系才能返回true：(o==null ? e==null : o.equals(e))。底层调用containsKey判断HashMap的key值是否为空。

3.5 add

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

　　如果此set中尚未包含指定元素，则添加指定元素，返回true。更确切地讲，如果此set没有包含满足(e==null ? e2==null : e.equals(e2))的元素e2，则向此set 添加指定的元素e。如果此set已包含该元素，则该调用不更改set并返回false。底层实际将将该元素作为key放入HashMap。由于HashMap的put()方法添加key-value对时，当新放入HashMap的Entry中key 与集合中原有Entry的key相同（hashCode()返回值相等，通过equals比较也返回true）,新添加的Entry的value会将覆盖原来Entry的value，但key不会有任何改变，因此如果向HashSet中添加一个已经存在的元素时，新添加的集合元素将不会被放入HashMap中，原来的元素也不会有任何改变，这也就满足了Set中元素不重复的特性。

3.6 remove

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

　　remove如果指定元素存在于此 set 中，则将其移除，返回true 。底层使用HashMap的remove方法删除指定的Entry。

3.7 clear()

public void clear() {
        map.clear();
}

　　clear从此 set 中移除所有元素。底层调用HashMap的clear方法清除所有的Entry。

3.8 clone()

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();
        }
}

　　clone返回此 HashSet 实例的浅表副本：并没有复制这些元素本身。

三.LinkedHashSet

1.LinkedHashSet介绍

LinkedHashSet具有HashSet的查询速度，且内部使用链表维护元素的顺序（插入的次序）。于是在使用迭代器遍历Set时，结果会按照元素的插入次序显示。

public class LinkedHashSet<E>
    extends HashSet<E>
    implements Set<E>, Cloneable, java.io.Serializable {

    public LinkedHashSet(int initialCapacity, float loadFactor) {
            super(initialCapacity, loadFactor, true);
    }

    public LinkedHashSet(int initialCapacity) {
        super(initialCapacity, .75f, true);
    }

    public LinkedHashSet() {
        super(16, .75f, true);
    }

    public LinkedHashSet(Collection<? extends E> c) {
        super(Math.max(2*c.size(), 11), .75f, true);
        addAll(c);
    }
}

　　LinkedHashSet继承自HashSet，HashSet基于HashMap实现，看LinkedHashSet类只是定义的四个构造方法都调用了父类HashSet的第五个构造方法：HashSet(int initialCapacity, float loadFactor, boolean dummy)。HashSet的这个构造方法创建的是一个LinkedHashMap，LinkedHashMap继承自HashMap，同时自身有一个链表结构用于维护元素顺序，默认情况使用的是插入元素，所以LinkedHashSet既有HashSet的访问速度，同时可以维护顺序。

2.HashSet和LinkedHashSet维护元素顺序的例子：

Set<String> linkedSet = new LinkedHashSet<String>();
linkedSet.add("First");
linkedSet.add("Second");
linkedSet.add("Thrid");
linkedSet.add("Fourth");
System.out.println("LinkedHashSet:"+linkedSet);
Set<String> hashSet = new HashSet<String>();
hashSet.add("First");
hashSet.add("Second");
hashSet.add("Thrid");
hashSet.add("Fourth");
System.out.println("HashSet:"+hashSet);
// LinkedHashSet:[First, Second, Thrid, Fourth]
// HashSet:[Fourth, Second, Thrid, First]

参考：http://cmsblogs.com/?p=599

http://www.cnblogs.com/ITtangtang/p/3948538.html

http://www.cnblogs.com/hzmark/archive/2012/12/27/HashSet.html