JAVA HashSet 去除重複值原理__JAVA

Java中的set是一個不包含重複元素的集合，確切地說，是不包含e1.equals(e2)的元素對。Set中允許添加null。Set不能保證集合裡元素的順序。

在往set中添加元素時，如果指定元素不存在，則添加成功。也就是說，如果set中不存在(e==null ? e1==null : e.queals(e1))的元素e1,則e1能添加到set中。

下面以set的一個實作類別HashSet為例，簡單介紹一下set不重複實現的原理：

package com.darren.test.overide;public class CustomString {    private String value;    public CustomString() {        this("");    }    public CustomString(String value) {        this.value = value;    }}

package com.darren.test.overide;import java.util.HashSet;import java.util.Set;public class HashSetTest {    public static void main(String[] args) {        String a = new String("A");        String b = new String("A");                CustomString c = new CustomString("B");        CustomString d = new CustomString("B");                System.out.println("a.equals(b) == " + a.equals(b));        System.out.println("c.equals(d) == " + c.equals(d));                Set<Object> set = new HashSet<Object>();        set.add(a);        set.add(b);        set.add(c);        set.add(d);                System.out.println("set.size() == " + set.size());                for (Object object : set) {            System.out.println(object);        }    }}

運行結果如下：

a.equals(b) == truec.equals(d) == falseset.size() == 3com.darren.test.overide.CustomString@2c39d2Acom.darren.test.overide.CustomString@5795ce

也許你已經看出關鍵來了，沒錯就是equals方法。這麼說還是不恰當，準確的說應該是equals和hashcode方法。為什麼這麼說呢，讓我們改一改CustomString類在進行測試：

package com.darren.test.overide;public class CustomString {    private String value;    public CustomString() {        this("");    }    public CustomString(String value) {        this.value = value;    }    @Override    public boolean equals(Object obj) {        if (this == obj) {                        return true;        } else if (obj instanceof CustomString) {            CustomString customString = (CustomString) obj;                        return customString.value.equals(value);        } else {                        return false;        }    }}

測試結果：

a.equals(b) == truec.equals(d) == trueset.size() == 3com.darren.test.overide.CustomString@12504e0Acom.darren.test.overide.CustomString@1630eb6

這次的equals傳回值都為true，但是set的size還是3

讓我們繼續改

package com.darren.test.overide;public class CustomString {    private String value;    public CustomString() {        this("");    }    public CustomString(String value) {        this.value = value;    }    @Override    public int hashCode() {        // return super.hashCode();        return 1;    }}

再看結果：

a.equals(b) == truec.equals(d) == falseset.size() == 3com.darren.test.overide.CustomString@1com.darren.test.overide.CustomString@1A

只重寫hashCode方法，不重寫equals方法也不行

最後再改一改

package com.darren.test.overide;public class CustomString {    private String value;    public CustomString() {        this("");    }    public CustomString(String value) {        this.value = value;    }    @Override    public boolean equals(Object obj) {        if (this == obj) {            return true;        } else if (obj instanceof CustomString) {            CustomString customString = (CustomString) obj;            return customString.value.equals(value);        } else {            return false;        }    }    @Override    public int hashCode() {        // return super.hashCode();        return 1;    }}

最後結果：

a.equals(b) == truec.equals(d) == trueset.size() == 2com.darren.test.overide.CustomString@1A

可以了，證明需要重寫equals方法和hashCode方法，來看原理：

java.lnag.Object中對hashCode的約定：

1. 在一個應用程式執行期間，如果一個對象的equals方法做比較所用到的資訊沒有被修改的話，則對該對象調用hashCode方法多次，它必須始終如一地返回同一個整數。

2. 如果兩個對象根據equals(Object o)方法是相等的，則調用這兩個對象中任一對象的hashCode方法必須產生相同的整數結果。

3. 如果兩個對象根據equals(Object o)方法是不相等的，則調用這兩個對象中任一個對象的hashCode方法，不要求產生不同的整數結果。但如果能不同，則可能提高散列表的效能。

在HashSet中，基本的操作都是有HashMap底層實現的，因為HashSet底層是用HashMap儲存資料的。當向HashSet中添加元素的時候，首先計算元素的hashcode值，然後用這個（元素的hashcode）%（HashMap集合的大小）+1計算出這個元素的儲存位置，如果這個位置位空，就將元素添加進去；如果不為空白，則用equals方法比較元素是否相等，相等就不添加，否則找一個空位添加。

如下是HashSet的部分源碼：

package java.util;public class HashSet<E> extends AbstractSet<E>     implements Set<E>, Cloneable, java.io.Serializable{    static final long serialVersionUID = -5024744406713321676L;       // 底層使用HashMap來儲存HashSet中所有元素。       private transient HashMap<E,Object> map;          // 定義一個虛擬Object對象作為HashMap的value，將此對象定義為static final。       private static final Object PRESENT = new Object();       /**      * 預設的無參構造器，構造一個空的HashSet。      *       * 實際底層會初始化一個空的HashMap，並使用預設初始容量為16和載入因子0.75。      */       public HashSet() {        map = new HashMap<E,Object>();    }    /**      * 構造一個包含指定collection中的元素的新set。      *      * 實際底層使用預設的載入因子0.75和足以包含指定      * collection中所有元素的初始容量來建立一個HashMap。      * @param c 其中的元素將存放在此set中的collection。      */       public HashSet(Collection< extends E> c) {        map = new HashMap<E,Object>(Math.max((int) (c.size()/.75f) + 1, 16));        addAll(c);    }    /**      * 以指定的initialCapacity和loadFactor構造一個空的HashSet。      *      * 實際底層以相應的參數構造一個空的HashMap。      * @param initialCapacity 初始容量。      * @param loadFactor 載入因子。      */       public HashSet(int initialCapacity, float loadFactor) {        map = new HashMap<E,Object>(initialCapacity, loadFactor);    }    /**      * 以指定的initialCapacity構造一個空的HashSet。      *      * 實際底層以相應的參數及載入因子loadFactor為0.75構造一個空的HashMap。      * @param initialCapacity 初始容量。      */       public HashSet(int initialCapacity) {        map = new HashMap<E,Object>(initialCapacity);    }    /**      * 以指定的initialCapacity和loadFactor構造一個新的空連結雜湊集合。      * 此建構函式為包存取權限，不對外公開，實際只是是對LinkedHashSet的支援。      *      * 實際底層會以指定的參數構造一個空LinkedHashMap執行個體來實現。      * @param initialCapacity 初始容量。      * @param loadFactor 載入因子。      * @param dummy 標記。      */       HashSet(int initialCapacity, float loadFactor, boolean dummy) {        map = new LinkedHashMap<E,Object>(initialCapacity, loadFactor);    }    /**      * 返回對此set中元素進行迭代的迭代器。返回元素的順序並不是特定的。      *       * 底層實際調用底層HashMap的keySet來返回所有的key。      * 可見HashSet中的元素，只是存放在了底層HashMap的key上，      * value使用一個static final的Object對象標識。      * @return 對此set中元素進行迭代的Iterator。      */       @Override    public Iterator<E> iterator() {        return map.keySet().iterator();    }    /**      * 返回此set中的元素的數量（set的容量）。      *      * 底層實際調用HashMap的size()方法返回Entry的數量，就得到該Set中元素的個數。      * @return 此set中的元素的數量（set的容量）。      */       @Override    public int size() {        return map.size();    }    /**      * 如果此set不包含任何元素，則返回true。      *      * 底層實際調用HashMap的isEmpty()判斷該HashSet是否為空白。      * @return 如果此set不包含任何元素，則返回true。      */       @Override    public boolean isEmpty() {        return map.isEmpty();    }    /**      * 如果此set包含指定元素，則返回true。      * 更確切地講，若且唯若此set包含一個滿足(o==null ? e==null : o.equals(e))      * 的e元素時，返回true。      *      * 底層實際調用HashMap的containsKey判斷是否包含指定key。      * @param o 在此set中的存在已得到測試的元素。      * @return 如果此set包含指定元素，則返回true。      */       @Override    public boolean contains(Object o) {        return map.containsKey(o);    }    /**      * 如果此set中尚未包含指定元素，則添加指定元素。      * 更確切地講，如果此 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中元素不重複的特性。      * @param e 將添加到此set中的元素。      * @return 如果此set尚未包含指定元素，則返回true。      */       @Override    public boolean add(E e) {        return map.put(e, PRESENT)==null;    }    /**      * 如果指定元素存在於此set中，則將其移除。      * 更確切地講，如果此set包含一個滿足(o==null ? e==null : o.equals(e))的元素e，      * 則將其移除。如果此set已包含該元素，則返回true      * （或者：如果此set因調用而發生更改，則返回true）。（一旦調用返回，則此set不再包含該元素）。      *      * 底層實際調用HashMap的remove方法刪除指定Entry。      * @param o 如果存在於此set中則需要將其移除的對象。      * @return 如果set包含指定元素，則返回true。      */       @Override    public boolean remove(Object o) {        return map.remove(o)==PRESENT;    }    /**      * 從此set中移除所有元素。此調用返回後，該set將為空白。      *      * 底層實際調用HashMap的clear方法清空Entry中所有元素。      */       @Override    public void clear() {        map.clear();    }}