PriorityQueue 源码解析（JDK1.8）

目录

一. 前言

二. 源码解析

2.1. 入队

2.2. 出队

2.3. 查找

2.4. 基于集合构造优先队列

---

一. 前言

    PriorityQueue，即优先队列。优先队列的作用是能保证每次取出的元素都是队列中权值最小的（Java的优先队列每次取最小元素，C++的优先队列每次取最大元素）。这里牵涉到了大小关系，元素大小的评判可以通过元素本身的自然顺序（natural ordering），也可以通过构造时传入的比较器(Comparator，类似于C++的仿函数)。

    Java中PriorityQueue实现了Queue接口，不允许放入null元素；其通过堆实现，具体说是通过完全二叉树（complete binary tree）实现的小顶堆（任意一个非叶子节点的权值，都不大于其左右子节点的权值），也就意味着可以通过数组来作为PriorityQueue的底层实现。

上图中我们给每个元素按照层序遍历的方式进行了编号，如果你足够细心，会发现父节点和子节点的编号是有联系的，更确切的说父子节点的编号之间有如下关系:
leftNo = parentNo*2+1
rightNo = parentNo*2+2
parentNo = (nodeNo-1)/2

通过上述三个公式，可以轻易计算出某个节点的父节点以及子节点的下标。这也就是为什么可以直接用数组来存储堆的原因。

PriorityQueue的peek()和element()操作是常数时间，add()、offer()、无参数的remove()以及poll()方法的时间复杂度都是log(N)。

二. 源码解析

2.1. 入队

add(E e) 和 offer(E e) 的语义相同，都是向优先队列中插入元素，只是Queue接口规定二者对插入失败时的处理不同，前者在插入失败时抛出异常，后者则会返回false。对于PriorityQueue这两个方法其实没什么差别。

public boolean add(E e) {
    return offer(e);
}
 
public boolean offer(E e) {
	// 若添加的元素为null，则直接抛出空指针异常
	if (e == null)
		throw new NullPointerException();
	// 操作数+1
	modCount++;
	int i = size;
	// 如果元素个数已大于或等于数组的长度，则执行扩容操作
	if (i >= queue.length)
		grow(i + 1);
	// 将待添加元素添加到数组最后，并执行元素上移过程
	siftUp(i, e);
	// 元素添加完成后，元素个数+1
	size = i + 1;
	// 返回true，代表添加元素成功
	return true;
}

扩容函数：

private void grow(int minCapacity) {
	// 获取现有容量
	int oldCapacity = queue.length;
	// Double size if small; else grow by 50%
	// 若现有容量<64，则新容量变为现有容量的2倍+2
	// 若现有容量>64，则新容量变为现有容量的1.5倍
	int newCapacity = oldCapacity + ((oldCapacity < 64) ?
									 (oldCapacity + 2) :
									 (oldCapacity >> 1));
	// overflow-conscious code
	// 若新容量大于Integer.MAX_VALUE - 8，执行hugeCapacity方法
	if (newCapacity - MAX_ARRAY_SIZE > 0)
		newCapacity = hugeCapacity(minCapacity);
	// 将老数组元素拷贝到新数组中
	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;
}

元素上移：

private void siftUp(int k, E x) {
	// 判断是否有传入的comparator
	// 若有则执行siftUpUsingComparator，否则执行siftUpComparable
	if (comparator != null)
		siftUpUsingComparator(k, x);
	else
		siftUpComparable(k, x);
}
 
private void siftUpComparable(int k, E x) {
	Comparablesuper E> key = (Comparablesuper E>) x;
	while (k > 0) {
		// 获取父节点的index=(k-1)/2
		int parent = (k - 1) >>> 1;
		// 拿到父节点的value
		Object e = queue[parent];
		// 若当前节点value>=父节点，停止上移，直接break返回
		if (key.compareTo((E) e) >= 0)
			break;
		// 若当前节点value>=父节点，与父节点替换，元素上移
		queue[k] = e;
		k = parent;
	}
	queue[k] = key;
}
 
// 过程基本与siftUpComparable相同，区别就是在元素上移的过程中，siftUpUsingComparator方法使用传入的Comparator来进行大小比较
private void siftUpUsingComparator(int k, E x) {
	while (k > 0) {
		int parent = (k - 1) >>> 1;
		Object e = queue[parent];
		if (comparator.compare(x, (E) e) >= 0)
			break;
		queue[k] = e;
		k = parent;
	}
	queue[k] = x;
}

可以发现，PriorityQueue构造时若不传入自定义的Comparator，元素上移过程中进行Value比较的时候，默认使用的元素的compareTo方法。故PriorityQueue默认是最小优先队列，若需要最大优先队列，则需要传入相应的Comparator。

2.2. 出队

remove(Object o) 和 poll() 方法的语义也完全相同，都是获取并删除队首元素，区别是当方法失败时前者抛出异常，后者返回null。由于删除操作会改变队列的结构，为维护小顶堆的性质，需要进行必要的调整。

 

public E poll() {
    if (size == 0)
        return null;
    int s = --size;
    modCount++;
    E result = (E) queue[0];//0下标处的那个元素就是最小的那个
    E x = (E) queue[s];
    queue[s] = null;
    if (s != 0)
        siftDown(0, x);//调整
    return result;
}

上述代码首先记录0下标处的元素，并用最后一个元素替换0下标位置的元素，之后调用siftDown()方法对堆进行调整，最后返回原来0下标处的那个元素(也就是最小的那个元素)。重点是siftDown(int k, E x)方法，该方法的作用是从k指定的位置开始，将x逐层向下与当前点的左右孩子中较小的那个交换，直到x小于或等于左右孩子中的任何一个为止。

private void siftDown(int k, E x) {
	if (comparator != null)
		siftDownUsingComparator(k, x);
	else
		siftDownComparable(k, x);
}
 
// siftDownComparable()
private void siftDownComparable(int k, E x) {
    Comparablesuper E> key = (Comparablesuper E>) x;
    int half = size >>> 1;
    while (k < half) {
    	// 首先找到左右孩子中较小的那个，记录到c里，并用child记录其下标
        int child = (k << 1) + 1; // leftNo = parentNo*2+1
        Object c = queue[child];
        int right = child + 1;
        if (right < size &&
            comparator.compare((E) c, (E) queue[right]) > 0)
            c = queue[child = right];
        if (comparator.compare(x, (E) c) <= 0)
            break;
        queue[k] = c; // 然后用c取代原来的值
        k = child;
    }
    queue[k] = x;
}
 
private void siftDownUsingComparator(int k, E x) {
	int half = size >>> 1;
	while (k < half) {
		int child = (k << 1) + 1;
		Object c = queue[child];
		int right = child + 1;
		if (right < size &&
			comparator.compare((E) c, (E) queue[right]) > 0)
			c = queue[child = right];
		if (comparator.compare(x, (E) c) <= 0)
			break;
		queue[k] = c;
		k = child;
	}
	queue[k] = x;
}

remove(Object o)：

remove(Object o) 方法用于删除队列中跟o相等的某一个元素（如果有多个相等，只删除一个），该方法不是Queue接口内的方法，而是Collection接口的方法。由于删除操作会改变队列结构，所以要进行调整；又由于删除元素的位置可能是任意的，所以调整过程比其它函数稍加繁琐。具体来说，remove(Object o)可以分为2种情况: 1. 删除的是最后一个元素。直接删除即可，不需要调整。2. 删除的不是最后一个元素，从删除点开始以最后一个元素为参照调用一次siftDown()即可。此处不再赘述。

// remove(Object o)
public boolean remove(Object o) {
	// 通过遍历数组的方式找到第一个满足o.equals(queue[i])元素的下标
    int i = indexOf(o);
    if (i == -1)
        return false;
    else {
        removeAt(i);
        return true;
    }
}
 
private E removeAt(int i) {
	// assert i >= 0 && i < size;
	modCount++;
	int s = --size;
	if (s == i) // removed last element
		queue[i] = null;
	else {
		E moved = (E) queue[s];
		queue[s] = null;
		siftDown(i, moved);
		if (queue[i] == moved) {
			siftUp(i, moved);
			if (queue[i] != moved)
				return moved;
		}
	}
	return null;
}

2.3. 查找

peek() 获取但不删除队首元素，也就是队列中权值最小的那个元素，获取不到返回null。根据小顶堆的性质，堆顶那个元素就是全局最小的那个；由于堆用数组表示，根据下标关系，0下标处的那个元素既是堆顶元素。所以直接返回数组0下标处的那个元素即可。

public E peek() {
    return (size == 0) ? null : (E) queue[0]; // 0下标处的那个元素就是最小的那个
}

2.4. 基于集合构造优先队列

PriorityQueue提供了initFromCollection方法将传入的集合构造成优先队列：

private void initFromCollection(Collection c) {
	// 拷贝元素创建初始堆
	initElementsFromCollection(c);
	// 将初始堆调整为最小(大)二叉堆
	heapify();
}
 
private void initElementsFromCollection(Collection c) {
	Object[] a = c.toArray();
	// If c.toArray incorrectly doesn't return Object[], copy it.
	if (a.getClass() != Object[].class)
		a = Arrays.copyOf(a, a.length, Object[].class);
	int len = a.length;
	if (len == 1 || this.comparator != null)
		for (int i = 0; i < len; i++)
			if (a[i] == null)
				throw new NullPointerException();
	this.queue = a;
	this.size = a.length;
}
 
private void heapify() {
	for (int i = (size >>> 1) - 1; i >= 0; i--)
        siftDown(i, (E) queue[i]);
}