死磕 java集合之PriorityQueue源碼分析

問題

（1）什么是優(yōu)先級隊(duì)列？

（2）怎么實(shí)現(xiàn)一個(gè)優(yōu)先級隊(duì)列？

（3）PriorityQueue是線程安全的嗎？

（4）PriorityQueue就有序的嗎？

簡介

優(yōu)先級隊(duì)列，是0個(gè)或多個(gè)元素的集合，集合中的每個(gè)元素都有一個(gè)權(quán)重值，每次出隊(duì)都彈出優(yōu)先級最大或最小的元素。

一般來說，優(yōu)先級隊(duì)列使用堆來實(shí)現(xiàn)。

還記得堆的相關(guān)知識嗎？鏈接直達(dá)【拜托，面試別再問我堆（排序）了！】。

那么Java里面是如何通過“堆”這個(gè)數(shù)據(jù)結(jié)構(gòu)來實(shí)現(xiàn)優(yōu)先級隊(duì)列的呢？

讓我們一起來學(xué)習(xí)吧。

源碼分析

主要屬性

// 默認(rèn)容量
private static final int DEFAULT_INITIAL_CAPACITY = 11;
// 存儲元素的地方
transient Object[] queue; // non-private to simplify nested class access
// 元素個(gè)數(shù)
private int size = 0;
// 比較器
private final Comparator<? super E> comparator;
// 修改次數(shù)
transient int modCount = 0; // non-private to simplify nested class access

（1）默認(rèn)容量是11；

（2）queue，元素存儲在數(shù)組中，這跟我們之前說的堆一般使用數(shù)組來存儲是一致的；

（3）comparator，比較器，在優(yōu)先級隊(duì)列中，也有兩種方式比較元素，一種是元素的自然順序，一種是通過比較器來比較；

（4）modCount，修改次數(shù)，有這個(gè)屬性表示PriorityQueue也是fast-fail的；

不知道fast-fail的，查看這篇文章的彩蛋部分：【死磕 java集合之HashSet源碼分析】。

入隊(duì)

入隊(duì)有兩個(gè)方法，add(E e)和offer(E e)，兩者是一致的，add(E e)也是調(diào)用的offer(E e)。

public boolean add(E e) {
    return offer(e);
}

public boolean offer(E e) {
    // 不支持null元素
    if (e == null)
        throw new NullPointerException();
    modCount++;
    // 取size
    int i = size;
    // 元素個(gè)數(shù)達(dá)到最大容量了，擴(kuò)容
    if (i >= queue.length)
        grow(i + 1);
    // 元素個(gè)數(shù)加1
    size = i + 1;
    // 如果還沒有元素
    // 直接插入到數(shù)組第一個(gè)位置
    // 這里跟我們之前講堆不一樣了
    // java里面是從0開始的
    // 我們說的堆是從1開始的
    if (i == 0)
        queue[0] = e;
    else
        // 否則，插入元素到數(shù)組size的位置，也就是最后一個(gè)元素的下一位
        // 注意這里的size不是數(shù)組大小，而是元素個(gè)數(shù)
        // 然后，再做自下而上的堆化
        siftUp(i, e);
    return true;
}

private void siftUp(int k, E x) {
    // 根據(jù)是否有比較器，使用不同的方法
    if (comparator != null)
        siftUpUsingComparator(k, x);
    else
        siftUpComparable(k, x);
}

@SuppressWarnings("unchecked")
private void siftUpComparable(int k, E x) {
    Comparable<? super E> key = (Comparable<? super E>) x;
    while (k > 0) {
        // 找到父節(jié)點(diǎn)的位置
        // 因?yàn)樵厥菑?開始的，所以減1之后再除以2
        int parent = (k - 1) >>> 1;
        // 父節(jié)點(diǎn)的值
        Object e = queue[parent];
        // 比較插入的元素與父節(jié)點(diǎn)的值
        // 如果比父節(jié)點(diǎn)大，則跳出循環(huán)
        // 否則交換位置
        if (key.compareTo((E) e) >= 0)
            break;
        // 與父節(jié)點(diǎn)交換位置
        queue[k] = e;
        // 現(xiàn)在插入的元素位置移到了父節(jié)點(diǎn)的位置
        // 繼續(xù)與父節(jié)點(diǎn)再比較
        k = parent;
    }
    // 最后找到應(yīng)該插入的位置，放入元素
    queue[k] = key;
}

（1）入隊(duì)不允許null元素；

（2）如果數(shù)組不夠用了，先擴(kuò)容；

（3）如果還沒有元素，就插入下標(biāo)0的位置；

（4）如果有元素了，就插入到最后一個(gè)元素往后的一個(gè)位置（實(shí)際并沒有插入哈）；

（5）自下而上堆化，一直往上跟父節(jié)點(diǎn)比較；

（6）如果比父節(jié)點(diǎn)小，就與父節(jié)點(diǎn)交換位置，直到出現(xiàn)比父節(jié)點(diǎn)大為止；

（7）由此可見，PriorityQueue是一個(gè)小頂堆。

擴(kuò)容

private void grow(int minCapacity) {
    // 舊容量
    int oldCapacity = queue.length;
    // Double size if small; else grow by 50%
    // 舊容量小于64時(shí)，容量翻倍
    // 舊容量大于等于64，容量只增加舊容量的一半
    int newCapacity = oldCapacity + ((oldCapacity < 64) ?
                                     (oldCapacity + 2) :
                                     (oldCapacity >> 1));
    // overflow-conscious code
    // 檢查是否溢出
    if (newCapacity - MAX_ARRAY_SIZE > 0)
        newCapacity = hugeCapacity(minCapacity);

    // 創(chuàng)建出一個(gè)新容量大小的新數(shù)組并把舊數(shù)組元素拷貝過去
    queue = Arrays.copyOf(queue, newCapacity);
}

private static int hugeCapacity(int minCapacity) {
    if (minCapacity < 0) // overflow
        throw new OutOfMemoryError();
    return (minCapacity > MAX_ARRAY_SIZE) ?
        Integer.MAX_VALUE :
        MAX_ARRAY_SIZE;
}

（1）當(dāng)數(shù)組比較小（小于64）的時(shí)候每次擴(kuò)容容量翻倍；

（2）當(dāng)數(shù)組比較大的時(shí)候每次擴(kuò)容只增加一半的容量；

出隊(duì)

出隊(duì)有兩個(gè)方法，remove()和poll()，remove()也是調(diào)用的poll()，只是沒有元素的時(shí)候拋出異常。

public E remove() {
    // 調(diào)用poll彈出隊(duì)首元素
    E x = poll();
    if (x != null)
        // 有元素就返回彈出的元素
        return x;
    else
        // 沒有元素就拋出異常
        throw new NoSuchElementException();
}

@SuppressWarnings("unchecked")
public E poll() {
    // 如果size為0，說明沒有元素
    if (size == 0)
        return null;
    // 彈出元素，元素個(gè)數(shù)減1
    int s = --size;
    modCount++;
    // 隊(duì)列首元素
    E result = (E) queue[0];
    // 隊(duì)列末元素
    E x = (E) queue[s];
    // 將隊(duì)列末元素刪除
    queue[s] = null;
    // 如果彈出元素后還有元素
    if (s != 0)
        // 將隊(duì)列末元素移到隊(duì)列首
        // 再做自上而下的堆化
        siftDown(0, x);
    // 返回彈出的元素
    return result;
}

private void siftDown(int k, E x) {
    // 根據(jù)是否有比較器，選擇不同的方法
    if (comparator != null)
        siftDownUsingComparator(k, x);
    else
        siftDownComparable(k, x);
}

@SuppressWarnings("unchecked")
private void siftDownComparable(int k, E x) {
    Comparable<? super E> key = (Comparable<? super E>)x;
    // 只需要比較一半就行了，因?yàn)槿~子節(jié)點(diǎn)占了一半的元素
    int half = size >>> 1;        // loop while a non-leaf
    while (k < half) {
        // 尋找子節(jié)點(diǎn)的位置，這里加1是因?yàn)樵貜?號位置開始
        int child = (k << 1) + 1; // assume left child is least
        // 左子節(jié)點(diǎn)的值
        Object c = queue[child];
        // 右子節(jié)點(diǎn)的位置
        int right = child + 1;
        if (right < size &&
            ((Comparable<? super E>) c).compareTo((E) queue[right]) > 0)
            // 左右節(jié)點(diǎn)取其小者
            c = queue[child = right];
        // 如果比子節(jié)點(diǎn)都小，則結(jié)束
        if (key.compareTo((E) c) <= 0)
            break;
        // 如果比最小的子節(jié)點(diǎn)大，則交換位置
        queue[k] = c;
        // 指針移到最小子節(jié)點(diǎn)的位置繼續(xù)往下比較
        k = child;
    }
    // 找到正確的位置，放入元素
    queue[k] = key;
}

（1）將隊(duì)列首元素彈出；

（2）將隊(duì)列末元素移到隊(duì)列首；

（3）自上而下堆化，一直往下與最小的子節(jié)點(diǎn)比較；

（4）如果比最小的子節(jié)點(diǎn)大，就交換位置，再繼續(xù)與最小的子節(jié)點(diǎn)比較；

（5）如果比最小的子節(jié)點(diǎn)小，就不用交換位置了，堆化結(jié)束；

（6）這就是堆中的刪除堆頂元素；

取隊(duì)首元素

取隊(duì)首元素有兩個(gè)方法，element()和peek()，element()也是調(diào)用的peek()，只是沒取到元素時(shí)拋出異常。

public E element() {
    E x = peek();
    if (x != null)
        return x;
    else
        throw new NoSuchElementException();
}
public E peek() {
    return (size == 0) ? null : (E) queue[0];
}

（1）如果有元素就取下標(biāo)0的元素；

（3）如果沒有元素就返回null，element()拋出異常；

總結(jié)

（1）PriorityQueue是一個(gè)小頂堆；

（2）PriorityQueue是非線程安全的；

（3）PriorityQueue不是有序的，只有堆頂存儲著最小的元素；

（4）入隊(duì)就是堆的插入元素的實(shí)現(xiàn)；

（5）出隊(duì)就是堆的刪除元素的實(shí)現(xiàn)；

（6）還不懂堆？看一看這篇文章【拜托，面試別再問我堆（排序）了！】。

彩蛋

（1）論Queue中的那些方法？

Queue是所有隊(duì)列的頂級接口，它里面定義了一批方法，它們有什么區(qū)別呢？

（2）為什么PriorityQueue中的add(e)方法沒有做異常檢查呢？

因?yàn)镻riorityQueue是無限增長的隊(duì)列，元素不夠用了會擴(kuò)容，所以添加元素不會失敗。

歡迎關(guān)注我的公眾號“彤哥讀源碼”，查看更多源碼系列文章, 與彤哥一起暢游源碼的海洋。