java提高篇（二四）-----HashSet

      在前篇博文中（java提高篇（二三）-----HashMap）詳細講解了HashMap的實現過程，對於HashSet而言，它是基於HashMap來實現的，底層采用HashMap來保存元素。所以如果對HashMap比較熟悉，那么HashSet是so  easy!!

一、定義

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

    HashSet繼承AbstractSet類，實現Set、Cloneable、Serializable接口。其中AbstractSet提供 Set 接口的骨干實現，從而最大限度地減少了實現此接口所需的工作。Set接口是一種不包括重復元素的Collection，它維持它自己的內部排序，所以隨機訪問沒有任何意義。

     基本屬性

//基於HashMap實現，底層使用HashMap保存所有元素
        private transient HashMap<E,Object> map;
    </span><span style="color: #008000">//</span><span style="color: #008000">定義一個Object對象作為HashMap的value</span>
    <span style="color: #0000ff">private</span> <span style="color: #0000ff">static</span> <span style="color: #0000ff">final</span> Object PRESENT = <span style="color: #0000ff">new</span> Object();</pre>

     構造函數

/**
         * 默認構造函數
         * 初始化一個空的HashMap，並使用默認初始容量為16和加載因子0.75。
         */
        public HashSet() {
            map = new HashMap<>();
        }
    </span><span style="color: #008000">/**</span><span style="color: #008000">
     * 構造一個包含指定 collection 中的元素的新 set。
     </span><span style="color: #008000">*/</span>
    <span style="color: #0000ff">public</span> HashSet(Collection&lt;? <span style="color: #0000ff">extends</span> E&gt;<span style="color: #000000"> c) {
        map </span>= <span style="color: #0000ff">new</span> HashMap&lt;&gt;(Math.max((<span style="color: #0000ff">int</span>) (c.size()/.75f) + 1, 16<span style="color: #000000">));
        addAll(c);
    }
    
    </span><span style="color: #008000">/**</span><span style="color: #008000">
     * 構造一個新的空 set，其底層 HashMap 實例具有指定的初始容量和指定的加載因子
     </span><span style="color: #008000">*/</span>
    <span style="color: #0000ff">public</span> HashSet(<span style="color: #0000ff">int</span> initialCapacity, <span style="color: #0000ff">float</span><span style="color: #000000"> loadFactor) {
        map </span>= <span style="color: #0000ff">new</span> HashMap&lt;&gt;<span style="color: #000000">(initialCapacity, loadFactor);
    }
       
    </span><span style="color: #008000">/**</span><span style="color: #008000">
     * 構造一個新的空 set，其底層 HashMap 實例具有指定的初始容量和默認的加載因子（0.75）。
     </span><span style="color: #008000">*/</span>
    <span style="color: #0000ff">public</span> HashSet(<span style="color: #0000ff">int</span><span style="color: #000000"> initialCapacity) {
       map </span>= <span style="color: #0000ff">new</span> HashMap&lt;&gt;<span style="color: #000000">(initialCapacity);
    }
       
    </span><span style="color: #008000">/**</span><span style="color: #008000">
     * 在API中我沒有看到這個構造函數，今天看源碼才發現（原來訪問權限為包權限，不對外公開的）
     * 以指定的initialCapacity和loadFactor構造一個新的空鏈接哈希集合。
     * dummy 為標識 該構造函數主要作用是對LinkedHashSet起到一個支持作用
     </span><span style="color: #008000">*/</span><span style="color: #000000">
    HashSet(</span><span style="color: #0000ff">int</span> initialCapacity, <span style="color: #0000ff">float</span> loadFactor, <span style="color: #0000ff">boolean</span><span style="color: #000000"> dummy) {
       map </span>= <span style="color: #0000ff">new</span> LinkedHashMap&lt;&gt;<span style="color: #000000">(initialCapacity, loadFactor);
    }</span></pre>

     從構造函數中可以看出HashSet所有的構造都是構造出一個新的HashMap，其中最后一個構造函數，為包訪問權限是不對外公開，僅僅只在使用LinkedHashSet時才會發生作用。

二、方法

     既然HashSet是基於HashMap，那么對於HashSet而言，其方法的實現過程是非常簡單的。

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

    iterator()方法返回對此 set 中元素進行迭代的迭代器。返回元素的順序並不是特定的。底層調用HashMap的keySet返回所有的key，這點反應了HashSet中的所有元素都是保存在HashMap的key中，value則是使用的PRESENT對象，該對象為static final。

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

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

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

    isEmpty()，判斷HashSet()集合是否為空，為空返回 true，否則返回false。

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

    contains()，判斷某個元素是否存在於HashSet()中，存在返回true，否則返回false。更加確切的講應該是要滿足這種關系才能返回true：(o==null ? e==null : o.equals(e))。底層調用containsKey判斷HashMap的key值是否為空。

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

    add()如果此 set 中尚未包含指定元素，則添加指定元素。如果此Set沒有包含滿足(e==null ? e2==null : e.equals(e2)) 的e2時，則將e2添加到Set中，否則不添加且返回false。由於底層使用HashMap的put方法將key = e，value=PRESENT構建成key-value鍵值對，當此e存在於HashMap的key中，則value將會覆蓋原有value，但是key保持不變，所以如果將一個已經存在的e元素添加中HashSet中，新添加的元素是不會保存到HashMap中，所以這就滿足了HashSet中元素不會重復的特性。

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

remove如果指定元素存在於此 set 中，則將其移除。底層使用HashMap的remove方法刪除指定的Entry。

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

clear從此 set 中移除所有元素。底層調用HashMap的clear方法清除所有的Entry。

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 實例的淺表副本：並沒有復制這些元素本身。

后記：

由於HashSet底層使用了HashMap實現，使其的實現過程變得非常簡單，如果你對HashMap比較了解，那么HashSet簡直是小菜一碟。有兩個方法對HashMap和HashSet而言是非常重要的，下篇將詳細講解hashcode和equals。