Java学习笔记之HashSet集合保证元素唯一性地源码解析

HashSet是Set接口的一个实现类,它的底层是HashMap,HashMap的底层是数组加链表.
它是怎么保证元素唯一性的呢?我们来看看源码:

public V put(K key, V value) {
    /**四个参数，第一个hash值，第四个参数表示如果该key存在值，如果为null的话，则插入新的value，最后一个参数，在hashMap中没有用，可以不用管，使用默认的即可**/
    return putVal(hash(key), key, value, false, true);
}

final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
    boolean evict) {
    //tab 哈希数组，p 该哈希桶的首节点，n hashMap的长度，i 计算出的数组下标
    Node<K,V>[] tab; Node<K,V> p; int n, i;
    //获取长度并进行扩容，使用的是懒加载，table一开始是没有加载的，等put后才开始加载
    if ((tab = table) == null || (n = tab.length) == 0)
        n = (tab = resize()).length; //初始化长度16
    /**如果计算出的该哈希桶的位置没有值，则把新插入的key-value放到此处，此处就算没有插入成功，也就是发生哈希冲突时也会把哈希桶的首节点赋予p**/
    if ((p = tab[i = (n - 1) & hash]) == null)
        tab[i] = newNode(hash, key, value, null);
    //发生哈希冲突的几种情况
    else {
        // e 临时节点的作用， k 存放该当前节点的key
        Node<K,V> e; K k;
        //第一种，插入的key-value的hash值，key都与当前节点的相等，e = p，则表示为首节点
        if (p.hash == hash &&
            ((k = p.key) == key || (key != null && key.equals(k))))
            e = p;
        //第二种，hash值不等于首节点，判断该p是否属于红黑树的节点
        else if (p instanceof TreeNode)
            /**为红黑树的节点，则在红黑树中进行添加，如果该节点已经存在，则返回该节点（不为null），该值很重要，用来判断put操作是否成功，如果添加成功返回null**/
            e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
        //第三种，hash值不等于首节点，不为红黑树的节点，则为链表的节点
        else {
            //遍历该链表
            for (int binCount = 0; ; ++binCount) {
                //如果找到尾部，则表明添加的key-value没有重复，在尾部进行添加
                if ((e = p.next) == null) {
                    p.next = newNode(hash, key, value, null);
                    //判断是否要转换为红黑树结构
                    if (binCount >= TREEIFY_THRESHOLD - 1)
                        treeifyBin(tab, hash);
                    break;
                }
                //如果链表中有重复的key，e则为当前重复的节点，结束循环
                if (e.hash == hash &&
                    ((k = e.key) == key || (key != null && key.equals(k))))
                    break;
                p = e;
            }
        }
        //有重复的key，则用待插入值进行覆盖，返回旧值。
        if (e != null) {
            V oldValue = e.value;
            if (!onlyIfAbsent || oldValue == null)
                e.value = value;
            afterNodeAccess(e);
            return oldValue;
        }
    }
    //到了此步骤，则表明待插入的key-value是没有key的重复，因为插入成功e节点的值为null
    //修改次数+1
    ++modCount;
    //实际长度+1，判断是否大于临界值，大于则扩容
    if (++size > threshold)
        resize();
    afterNodeInsertion(evict);
    //添加成功
    return null;
}
	
//这里的threshold是临界值,跟进查看源码
int threshold;

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

//initialCapacity:初始容量   loadFactor:载荷因数
public HashMap(int initialCapacity, float loadFactor) {
	//当初始容量小于0,抛出IllegalArgumentException:违反内容异常
    if (initialCapacity < 0)
        throw new IllegalArgumentException("Illegal initial capacity: " + initialCapacity);
	//initialCapacity:初始容量大于MAXIMUM_CAPACITY:最大容量,初始容量=最大容量
    if (initialCapacity > MAXIMUM_CAPACITY)
        initialCapacity = MAXIMUM_CAPACITY;
	//当载荷因数小于等于0或者Float.isNaN()为false,抛出异常IllegalArgumentException
    if (loadFactor <= 0 || Float.isNaN(loadFactor))
        throw new IllegalArgumentException("Illegal load factor: " + loadFactor);
    this.loadFactor = loadFactor;
    this.threshold = tableSizeFor(initialCapacity);
    }
	
public static boolean isNaN(float v) {
    return (v != v);
}


static final int tableSizeFor(int cap) {
	//调用numberOfLeadingZeros()方法
    int n = -1 >>> Integer.numberOfLeadingZeros(cap - 1);
	//如果n值小于0,直接返回1,如果n值大于0,判断n是否大于MAXIMUM_CAPACITY,如果大于返回MAXIMUM_CAPACITY,如果小于返回n+1
    return (n < 0) ? 1 : (n >= MAXIMUM_CAPACITY) ? MAXIMUM_CAPACITY : n + 1;
}

//根据这个方法我们假设i=1<<16/i=1<<8/i=1<<4/i=1<<2时,得出四个返回值:14/22/26/28	
public static int numberOfLeadingZeros(int i) {
    // HD, Count leading 0's
    if (i <= 0)
        return i == 0 ? 32 : 0;
    int n = 31;
    if (i >= 1 << 16) { n -= 16; i >>>= 16; }
    if (i >= 1 <<  8) { n -=  8; i >>>=  8; }
    if (i >= 1 <<  4) { n -=  4; i >>>=  4; }
    if (i >= 1 <<  2) { n -=  2; i >>>=  2; }
    return n - (i >>> 1);
}

由于很多方法里面调用了其他方法,我只分析了一部分相关的内容.