《Java源码分析》：PriorityQueue
看了PriorityBlockingQueue的源码之后，发现这个类的实现是基于二叉堆来实现的，然而自己以前对二叉堆基本上没有认真的研究过，这是自己第一次看到关于二叉堆的“插入元素”、“取出元素”等相关操作的一个具体实现。于是，想想，PriorityQueue里面的内部实现也应该是这样的，因此也就看了下PriorityQueue的源码，下面一点点的进行介绍。有了PriorityBlockingQueue类中关于二叉堆的相关操作的基础，看PriorityQueue类就比较简单了。
1、PriorityQueue的继承体系
public class PriorityQueue<E> extends AbstractQueue<E>
implements java.io.Serializable
PriorityQueue继承了AbstractQueue类，而AbstractQueue类是实现了Queue接口。
2、PriorityQueue的相关属性介绍
PriorityQueue类相关属性介绍
1、默认容量
private static final int DEFAULT_INITIAL_CAPACITY = 11;
2、最大容量
private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;
3、二叉堆
//基于二叉堆来实现优先队列，queue[i]的子节点为queue[2*i+1]/queue[2*i+2];
transient Object[] queue; // non-private to simplify nested class access
4、优先队列元素个数
private int size = 0;
5、比较器，优先队列中的元素就是按照此比较器进行排序。
private final Comparator
3、PriorityQueue构造函数介绍
PriorityQueue类相关构造函数介绍
1）、创建一个优先队列对象，默认大小为11，队列中的元素按照自然顺序排序。
public PriorityQueue() {
this(DEFAULT_INITIAL_CAPACITY, null);
}
2）、创建一个指定大小的优先队列对象，队列中的元素按照自然顺序排序。
public PriorityQueue(int initialCapacity) {
this(initialCapacity, null);
}
3）、创建一个默认大小(11)的优先队列对象，队列中的元素按照指定比较器进行排序。
public PriorityQueue(Comparator<? super E> comparator) {
this(DEFAULT_INITIAL_CAPACITY, comparator);
}
4）、根据指定的大小和比较器来创建一个优先队列对象。
public PriorityQueue(int initialCapacity,
Comparator<? super E> comparator) {
// Note: This restriction of at least one is not actually needed,
// but continues for 1.5 compatibility
if (initialCapacity < 1)
throw new IllegalArgumentException();
this.queue = new Object[initialCapacity];
this.comparator = comparator;
}
4、PriorityQueue的add(e)/offer(e)方法介绍
add函数的功能：插入一个元素到优先队列中
add方法的源代码如下：
public boolean add(E e) {
return offer(e);
}
从源码中可以看出add方法直接调用了offer方法。
offer方法代码如下：（有详细的注释）
public boolean offer(E e) {
if (e == null) //检查是否为null，如果为null，则抛空指针异常
throw new NullPointerException();
modCount++;
int i = size;
if (i >= queue.length)//如果容量不够，则进行扩容操作
grow(i + 1);
//将元素e加入到queue[i]为位置上
size = i + 1;
if (i == 0)
queue[0] = e;
else
siftUp(i, e); //需要向上调整，使之保持为二叉堆的特性。
return true;
}
offer(E e)方法的实现思路如下：
1）首先检查要添加的元素e是否为null，如果为null，则抛空指针异常，如果不为null，则进行2
2）判断数组是否已满，如果已满，则进行扩容，否则将元素加入到数组末尾即可。但是由于这个数组表示的是一个“二叉堆”，因此还需要进行相应的调整操作，使得这个数组在添加元素之后依然保持的是二叉堆的特性。
下面介绍了在offer(E e)方法中设计到了grow、siftUp方法。
grow(int minCapacity)方法介绍
//添加数组的容量
private void grow(int minCapacity) {
int oldCapacity = queue.length;
// Double size if small; else grow by 50%
//如果比较小，则扩容为原来的2倍，否则只扩容为原来的1.5倍
int newCapacity = oldCapacity + ((oldCapacity < 64) ?
(oldCapacity + 2) :
(oldCapacity >> 1));
// overflow-conscious code
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;
}
grow方法比较简单哈，就是进行2倍或者是1.5倍的扩容。只是对Interger.MAX_VALUE附近大小的时候扩容有一点特殊的考虑处理。
siftUp(int k, E x)方法介绍
siftUp(int k, E x)方法功能：将元素x插入到queue[k]位置上，并进行调整使之具有二叉堆特性。
private void siftUp(int k, E x) {
if (comparator != null)
siftUpUsingComparator(k, x);
else
siftUpComparable(k, x);
}
siftUpUsingComparator和siftUpComparable源码如下：这两个函数的思想就是二叉堆插入元素的思想，比较好理解。
@SuppressWarnings("unchecked")
private void siftUpComparable(int k, E x) {
Comparable<? super E> key = (Comparable<? super E>) x;
while (k > 0) {
int parent = (k - 1) >>> 1;
Object e = queue[parent];
if (key.compareTo((E) e) >= 0)
break;
queue[k] = e;
k = parent;
}
queue[k] = key;
}
@SuppressWarnings("unchecked")
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;
}
5、PriorityQueue的poll()方法介绍
取出优先队列中的第一个元素。
@SuppressWarnings("unchecked")
public E poll() {
if (size == 0) //如果没有元素，则返回null
return null;
int s = --size;
modCount++;
E result = (E) queue[0];
E x = (E) queue[s];
queue[s] = null;
if (s != 0) //队列中不只有一个元素
siftDown(0, x);
return result;
}
poll方法的思想为：取出queue[0]元素，然后将queue[size-1]插入到queue[0],然后向下沉来保持二叉堆的特性。
//将元素x存储在queue[k],并进行相应的调整
private void siftDown(int k, E x) {
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;
int half = size >>> 1; // loop while a non-leaf
while (k < half) {
int child = (k << 1) + 1; // assume left child is least
Object c = queue[child];
int right = child + 1;
if (right < size &&
((Comparable<? super E>) c).compareTo((E) queue[right]) > 0)
c = queue[child = right];
if (key.compareTo((E) c) <= 0)
break;
queue[k] = c;
k = child;
}
queue[k] = key;
}
@SuppressWarnings("unchecked")
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;
}
“向下沉”的思想比较简单哈，siftDownComparable/siftDownUsingComparator就是二叉堆中“插入元素并调整元素”的一个实现，如果对上面的代码实现不太懂，可以先了解下二叉堆“插入元素”的思想。
6、PriorityQueue的remove方法的介绍
函数功能：移除指定元素
public boolean remove(Object o) {
int i = indexOf(o);
if (i == -1) //没有在数组中找到
return false;
else {
removeAt(i);
return true;
}
}
remove(Object o)方法的思想为：
1）找到这个元素在数组中的位置，如果没有找到，则直接返回false。否则进行2
2）调用removeAt进行删除并调整操作。
indexOf(Object o)方法的代码如下
函数功能：找到对象o在数组中出现的第一个索引
private int indexOf(Object o) {
if (o != null) {
for (int i = 0; i < size; i++)
if (o.equals(queue[i]))
return i;
}
return -1;
}
removeAt(int i)方法介绍
removeAt方法的源码如下：
@SuppressWarnings("unchecked")
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;
}
removeAt(int i)方法的实现思想如下
首先删除queue[i]，用queue[size-1]位置的元素用填补queue[i],然后先下沉queue[i],如果没有下沉成功，则上浮。
小结
关于PriorityQueue类比较简单，是借助于“二叉堆”来实现的，此类的所有操作基本就是一个“二叉堆”的相关操作的实现。
说明：博文中有的函数的注释确实相当少，没有注释的原因是这些函数都是“二叉堆”相关操作的一个实现，自己刚好对这一块比较了解，因此，就没有添加相应的注释。
