Java-集合（HashSet类）

内容说明

1）HashSet实现了Set接口；

2）HashSet实际上是HashMap；

public HashSet() {
        map = new HashMap<>();
    }

3）可以存放null值，但是只能有一个null；

4）HashSet不保证元素是有序的，取决于hash后，在确定索引的结果；

5）不能用重复的元素/对象。

常用方法测试

package com.pero.set_;

import java.util.HashSet;

/**
 * @author Pero
 * @version 1.0
 */
public class HashSet01 {
    public static void main(String[] args) {

        HashSet hashSet = new HashSet();
        //在执行add()方法后会返回一个boolean值
        //如果添加成功返回true，否则返回false
        System.out.println(hashSet.add("jake"));
        System.out.println(hashSet.add("lucy"));
        System.out.println(hashSet.add("tom"));
        System.out.println(hashSet.add("smith"));
        System.out.println(hashSet.add("john"));
        System.out.println(hashSet.add("jake"));

        //删除指定对象
        hashSet.remove("jake");
        System.out.println(hashSet);

        hashSet = new HashSet();
        hashSet.add("tom");
        hashSet.add("tom");
        hashSet.add(new Person("tom"));  //添加成功
        hashSet.add(new Person("tom"));  //添加成功
        System.out.println(hashSet);

        hashSet.add(new String("pero"));  //添加成功
        hashSet.add(new String("pero"));  //添加失败
        //后期源码分析底层元素添加机制(HashMap)

        System.out.println(hashSet);

    }
}
class Person {
    private String name;

    public Person(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    @Override
    public String toString() {
        return "Person{" +
                "name='" + name + '\'' +
                '}';
    }
}

底层机制说明

HashSet底层是HashMap，HashMap底层是（数组+链表+红黑树）。

模拟数组+链表的运行机制

package com.pero.set_;

/**
 * 数组+链表
 * @author Pero
 * @version 1.0
 */

public class HashSetStructure {
    public static void main(String[] args) {
        
        //创建Node数组，Node数组也成为表（table）
        
        Node[] table = new Node[16];
        System.out.println(table);
        
        //创建节点
        Node jake = new Node("jake", null);
        table[2] = jake;
        Node tom = new Node("tom", null);
        jake.next = tom;  //将tom节点挂载到jake后面，形成一个链表
        Node smith = new Node("smith", null);
        tom.next = smith;  //将smith节点挂载到tom后面，链表增加一个数据
        Node lucy = new Node("lucy", null);
        table[3] = lucy;  //将lucy放到table表的索引为3的位置
        

        System.out.println(table);


    }
}
class Node{  //节点类用于存储数据，形成链表
    Object item;  //存储数据
    Node next;    //指向下一个节点
    
    public Node(Object item,Node next){
        this.item = item;
        this.next = next;
    }
}

元素添加底层实现机制

1）HashSet底层是HashMap；

2)添加一个元素时，先得到hash值，然后通过hash值转成索引值（放置在数组的某个位置）；

3）找到存储数据的table表，看这个索引位置是否已经存放元素；

4）如果索引位置没有存放元素，直接存放；

5）如果索引位置已经存放元素，调用equals()方法进行比较，如果相同就放弃添加，如果不相同，则添加到当前索引位置链表的最后一位；

6）在Java8中，如果一条链表的元素个数达到TREEIRFY_THRESHOLD(默认值为8)的个数，并且table的大小大于等于MIN_TREEIFY_CAPACITY(默认值为64)的值，就会进行树化(红黑树)。

HashSet扩容和转成红黑树机制

1）HashSet底层是HashMap，第一次添加时，table数组扩容到16个空间，临界值（threshold）是16*加载因子（loadFactor）是0.75=12；

★当++size>threshold时，执行resize()方法，开始扩容。size表示添加节点的数量，不论是在table表中添加还是在链表中添加元素size都会增加1

2）如果size使用到了临界值21，就会扩容到16*2=32，新的临界值就是32*0.75=24，依此类推；

3）在Java8中，如果一条链表的元素个数到达TREEIY_THRESHOLD（默认值为8），并且table的大小>=MIN_TREEIFY_CAPACITY（默认值为64），就会进行树化（将链表转成红黑树），否则仍然采用数组扩容机制。

测试代码

package com.pero.set_;

import java.util.HashSet;
import java.util.Iterator;
import java.util.Random;

/**
 * HashSet底层源码分析-测试代码
 * @author Pero
 * @version 1.0
 */

@SuppressWarnings({"all"})
public class HashSetSource {
    public static void main(String[] args) {

        Random random = new Random();

        HashSet hashSet = new HashSet();
        for (int i = 0; i < 120; i++) {
            System.out.println(hashSet.add(random.nextInt()));
        }

        Iterator iterator = hashSet.iterator();
        while (iterator.hasNext()) {
            Object next =  iterator.next();
            System.out.println(next);
        }

    }
}

源码分析

1）执行构造器public HashSet()；

public HashSet() {
        map = new HashMap<>();
    }

private transient HashMap<E,Object> map;

public HashMap() {
        this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
    }

    /**
     * The load factor for the hash table.
     *
     * @serial
     */
    final float loadFactor;

static final float DEFAULT_LOAD_FACTOR = 0.75f;

2）执行hashSet.add("java")方法，开始添加元素；

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

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

3）执行public V put(K key, V value) 方法，key->e,value->PRESENT

public V put(K key, V value) {
        return putVal(hash(key), key, value, false, true);
    }

4)执行 static final int hash(Object key)方法，

static final int hash(Object key) {  
    
        //通过算法得到key的hash值，并不是key.hashCode(),
        //是将key.hashCode()得到的值进行了算法运算。

        int h;
        return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
    }

//  >>>表示对h的数值无符号右移十六位

5）执行 final V putVal(int hash, K key, V value, boolean onlyIfAbsent, boolean evict)方法

final V putVal(int hash, K key, V value, boolean onlyIfAbsent, boolean evict) {

        //定义辅助变量
        Node<K,V>[] tab;  //辅助表变量
        Node<K,V> p;   //辅助链表中特定索引位置辅助变量
        int n, i; 
====================================================================================
        //transient Node<K,V>[] table;  table是在HashMap中定义的一个节点数组
        //如果当前table表存储数据是空的或者空间大小=0，就是说明是第一次扩容
        //执行完resize()方法后，table成为空间为16的Node数组表
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;
====================================================================================
        //通过对key的hash值运算确定key在table表中的索引位置来存放
        //并把这个位置的对象，赋值给p
        //判断p是否为null，如果p为空表示table表中的当前位置还没有存放数据，就创建一个Node
        //存放到该索引位置
        if ((p = tab[i = (n - 1) & hash]) == null)
            tab[i] = newNode(hash, key, value, null);
====================================================================================
        //如果p不为空表示table表中的当前位置有存放数据
        else {

            //定义一个Node节点e,定义一个存储数据类型的k;
            Node<K,V> e; 
            K k;
====================================================================================
            //p当前表示table表中目标索引位置存储的第一个节点
            //p.hash表示table表中目标索引位置第一个元素的hash值，hash表示当前添加元素的hash值
            //（k = p.key）表示table表中目标索引位置第一个节点存储的元素对象
            //key表示当前添加元素对象，(k = p.key) == key表示比较两个对象是否为同意对象
            //equals()方法是对存储对象内容进行比较，重写equals()方法可以定义对象相同的内容条件
            //该判断意思是：
            //如果当前添加的元素对象和当前目标节点的第一个元素对象是同一个元素对象
            //或者
            //当前添加的元素不是同一个对象，但是元素内容相同
            //则满足判定结果
            if (p.hash == hash && ((k = p.key) == key || (key != null && key.equals(k))))
                //使用过程中，如果是自定义类要注意equals()方法的重写问题，
                //可以通过重写equals()方法，来区别选择判断重复对象和重复内容
                //hashSet.add(new Person("tom"));  //添加成功
                //hashSet.add(new Person("tom"));  //添加成功
                //hashSet.add(new String("pero"));  //添加成功
                //hashSet.add(new String("pero"));  //添加失败
                //Person类没有重写equals方法，new Peron("tom")前后两个表示不同对象且内容不同
                //String类重写了equals方法，new String("pero")前后两个表示不同对象的相同内容
                
                //e=p !=null，在if (e != null)判断中，返回return oldValue;表示添加失败
                e = p;
====================================================================================

            //在判断p是否是一个红黑树，如果是执行putTreeVal(this, tab, hash, key, value)方法
            else if (p instanceof TreeNode)
                e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
====================================================================================
            //进行链表添加，将待添加元素与table表中指定索引位置的链表中的其他元素比较
            //如果存在相同元素则存储失败，如果没有相同元素，则将待添加元素添加到链表的最后一位
            else {
                //对链表检索
                for (int binCount = 0; ; ++binCount) {
                    //判断链表下一个位置是否为null，如果为空说明在该条链表上没有
                    //与添加元素相同的对象或内容，直接添加，如果不为空则进行下一个判断
                    //即判断当前链表位置所存储的元素是否与待添加的元素相关（对象或者内容相同）
                    if ((e = p.next) == null) {  

                        //将待添加元素添加到链表最后一位
                        p.next = newNode(hash, key, value, null); 
                        
                        //判断当前链表节点是否达到8个节点（索引 >= TREEIFY_THRESHOLD - 1），
                        //如果达到则调用treeifyBin()方法，对当前链表进行树化（构建红黑树），
                        //在转成红黑树时还需要判断table表的容量是否小于64，如果小于则对table
                        //表进行扩容，如果大于或等于64则进行树化
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                            treeifyBin(tab, hash);
                        break;
                    }

                    //元素筛选：
                    //如果当前添加的元素对象和当前目标节点的第一个元素对象是同一个元素对象
                    //或者
                    //当前添加的元素不是同一个对象，但是元素内容相同
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        break;

                    //相当于p指针向下移动，当添加成功后，p=e都等于null；
                    p = e;
                }
            }
==================================================================================
            //如果e!=null成立那么返回oldValue，不再执行该方法的后续操作，添加元素失败
            if (e != null) { // existing mapping for key
                V oldValue = e.value;
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                afterNodeAccess(e);
                return oldValue;
            }
        }
        ++modCount;

        //判断添加元素是否大于临界值，如果大于则进行扩容
        if (++size > threshold)
            resize();

        //空方法，希望让HashMap的子类，通过重写该方法来实现一些操作
        //例如形成一个有序的链表挂载双向链表
        afterNodeInsertion(evict);

        //返回null表示添加成功
        return null;
    }

transient Node<K,V>[] table;

void afterNodeAccess(Node<K,V> p) { }

static final int TREEIFY_THRESHOLD = 8;

final Node<K,V>[] resize() {

        Node<K,V>[] oldTab = table;
        int oldCap = (oldTab == null) ? 0 : oldTab.length;
        int oldThr = threshold;
        int newCap, newThr = 0;

        if (oldCap > 0) {
            if (oldCap >= MAXIMUM_CAPACITY) {
                threshold = Integer.MAX_VALUE;
                return oldTab;
            }
======================================================================================
            else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                     oldCap >= DEFAULT_INITIAL_CAPACITY)
                newThr = oldThr << 1; // double threshold
        }
======================================================================================
        else if (oldThr > 0) // initial capacity was placed in threshold
            newCap = oldThr;
======================================================================================
        else {               // zero initial threshold signifies using defaults
            newCap = DEFAULT_INITIAL_CAPACITY;  //空间存储范围定义为16
            //DEFAULT_LOAD_FACTOR为加载因子0.75
            //newThr为临界值，当空间使用到定义范围的75%时准备扩容，防止多线程操作时造成拥堵
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
        }
======================================================================================
        if (newThr == 0) {
            float ft = (float)newCap * loadFactor;
            newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?
                      (int)ft : Integer.MAX_VALUE);
        }
======================================================================================
        threshold = newThr;
        @SuppressWarnings({"rawtypes","unchecked"})
        Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
        table = newTab;   //table表为Node类型的拥有16
======================================================================================
        if (oldTab != null) {
            for (int j = 0; j < oldCap; ++j) {
                Node<K,V> e;
                if ((e = oldTab[j]) != null) {
                    oldTab[j] = null;
                    if (e.next == null)
                        newTab[e.hash & (newCap - 1)] = e;
                    else if (e instanceof TreeNode)
                        ((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
                    else { // preserve order
                        Node<K,V> loHead = null, loTail = null;
                        Node<K,V> hiHead = null, hiTail = null;
                        Node<K,V> next;
                        do {
                            next = e.next;
                            if ((e.hash & oldCap) == 0) {
                                if (loTail == null)
                                    loHead = e;
                                else
                                    loTail.next = e;
                                loTail = e;
                            }
                            else {
                                if (hiTail == null)
                                    hiHead = e;
                                else
                                    hiTail.next = e;
                                hiTail = e;
                            }
                        } while ((e = next) != null);
                        if (loTail != null) {
                            loTail.next = null;
                            newTab[j] = loHead;
                        }
                        if (hiTail != null) {
                            hiTail.next = null;
                            newTab[j + oldCap] = hiHead;
                        }
                    }
                }
            }
        }
        return newTab;
    }

static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16

static final float DEFAULT_LOAD_FACTOR = 0.75f;

final TreeNode<K,V> putTreeVal(HashMap<K,V> map, Node<K,V>[] tab,
                                       int h, K k, V v) {
            Class<?> kc = null;
            boolean searched = false;
            TreeNode<K,V> root = (parent != null) ? root() : this;
            for (TreeNode<K,V> p = root;;) {
                int dir, ph; K pk;
                if ((ph = p.hash) > h)
                    dir = -1;
                else if (ph < h)
                    dir = 1;
                else if ((pk = p.key) == k || (k != null && k.equals(pk)))
                    return p;
                else if ((kc == null &&
                          (kc = comparableClassFor(k)) == null) ||
                         (dir = compareComparables(kc, k, pk)) == 0) {
                    if (!searched) {
                        TreeNode<K,V> q, ch;
                        searched = true;
                        if (((ch = p.left) != null &&
                             (q = ch.find(h, k, kc)) != null) ||
                            ((ch = p.right) != null &&
                             (q = ch.find(h, k, kc)) != null))
                            return q;
                    }
                    dir = tieBreakOrder(k, pk);
                }

                TreeNode<K,V> xp = p;
                if ((p = (dir <= 0) ? p.left : p.right) == null) {
                    Node<K,V> xpn = xp.next;
                    TreeNode<K,V> x = map.newTreeNode(h, k, v, xpn);
                    if (dir <= 0)
                        xp.left = x;
                    else
                        xp.right = x;
                    xp.next = x;
                    x.parent = x.prev = xp;
                    if (xpn != null)
                        ((TreeNode<K,V>)xpn).prev = x;
                    moveRootToFront(tab, balanceInsertion(root, x));
                    return null;
                }
            }
        }

final void treeifyBin(Node<K,V>[] tab, int hash) {
        int n, index; Node<K,V> e;
        if (tab == null || (n = tab.length) < MIN_TREEIFY_CAPACITY)
            resize();
        else if ((e = tab[index = (n - 1) & hash]) != null) {
            TreeNode<K,V> hd = null, tl = null;
            do {
                TreeNode<K,V> p = replacementTreeNode(e, null);
                if (tl == null)
                    hd = p;
                else {
                    p.prev = tl;
                    tl.next = p;
                }
                tl = p;
            } while ((e = e.next) != null);
            if ((tab[index] = hd) != null)
                hd.treeify(tab);
        }
    }

重写equals()方法和hashCode()方法案例 

package com.pero.set_;

import java.util.HashSet;
import java.util.Objects;

/**
 * @author Pero
 * @version 1.0
 */

public class HashSetExercise {
    public static void main(String[] args) {
        HashSet hashSet = new HashSet();
        hashSet.add(new Employee("jake", 21));
        hashSet.add(new Employee("lucy", 27));
        hashSet.add(new Employee("jake", 21));

        System.out.println(hashSet);
    }
}

class Employee {
    private String name;
    private int age;

    public Employee(String name, int age) {
        this.name = name;
        this.age = age;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "Employee{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }

    //重写equals()方法，返回类型是boolean，形参列表是Object o
    @Override
    public boolean equals(Object o) {

        //如果当前对象和比较对象是同一对象，则比较的内容相同则返回true
        if (this == o) return true;
        //如果比较对象为null或者当前对象的运行类型和比较对象的运行类型不同则比较内容不同
        if (o == null || getClass() != o.getClass()) return false;

        //先将比较对象向下转型,然后对属性进行比较，如果属性相同，说明是同一对象则返回true
        Employee employee = (Employee) o;
        return age == employee.age && Objects.equals(name, employee.name);
    }

    //重写hashCode()方法，返回类型是int型
    @Override
    public int hashCode() {

        //如果对象的name和age相同则返回相同的hash值
        return Objects.hash(name, age);
    }
}