简单分析一下PriorityQueue

简单分析一下PriorityQueue的实现原理

提示：开发学习过程中接触到了一个优先队列【PriorityQueue】这样的数据结构
，PriorityQueue是使用动态数组来实现最小堆的（默认最小堆，也可以在初始化时传入自己制定的Comparator来把它变成最大堆）

---

总体概述：

优先队列的作用是能保证每次取出的元素都是队列中权值最小的元素，元素的大小关系默认按元素本身的自然顺序排序，或者通过构造优先队列是传入的比较器来规定。

Java中 PriorityQueue实现了Queue接口，是一个通过堆，或者说通过完全二叉树实现的小顶堆（任意一个非叶子节点的权值，都不大于其左右子节点的权值）。

Object queue	0	1	2	3	4	5	6	7	8	9
数组下标	3	5	10	7	9	15	11	13	20	12

通过简单的分析上图或者说查找网上的资料，PriorityQueue的元素依次按照从上到下、从左到右的顺序放入数组后，父子节点的数组下标之间有如下的关系：

leftChildNode = parentNode x 2+1
rightChildNode = parentNode x 2+2
parentNode = (childNode-1)/2

通过上述的三个公式，可以轻松的算出某个节点的父节点或者左右子节点的下标。这也是为什么可以直接用数组存储二叉堆的原因。

---

先讲应用：

大体了解优先队列的总体介绍后，再来看下优先队列能用于哪些场景。

举两个例子：
1、作业调度系统中，当一个作业完成后，需要再所有等待调度的作业中选择一个优先级最高的作业来执行，并且也可以添加一个新的作业到作业的优先队列中。
2、银行排队办理业务的时候，当VIP客户进入银行的时候，实际上就进入了队列，我们需要首先处理优先客户再处理普通用户。

在上面的两个例子中，Java的PriorityQueue就会很有帮助；

Tips：

• 优先队列不允许放入null元素！【但是它本身是可以存null甚至里面许多空间存的就是null】，而且不支持non-comparable（不可比较）的对象，比如用户自定义的类。优先队列要求使用Java Comparable和Comparator接口给对象排序，并且在排序时会按照优先级处理其中的元素。
• 当用户自定义的类，没有提供任何类型的排序时。当我们用它建立优先队列时，应该为其提供一个比较器对象。
• 优先队列的头是基于自然排序或者Comparator排序的最小元素。如果有多个对象拥有同样的排序，那么就可能随机地取其中任意一个。当我们获取队列时，返回队列的头对象。
• 优先队列的大小是不受限制的，但在创建时可以指定初始大小。当我们向优先队列增加元素的时候，队列大小会自动增加。
• PriorityQueue是非线程安全的，所以Java提供了PriorityBlockingQueue（实现BlockingQueue接口）用于Java多线程环境。

方法剖析：

初始化

我们先来看PriorityQueue的构造函数

//一个常量，当你调用构造函数时没有传入数组的长度，则这个就是新建数组的默认长度
 private static final int DEFAULT_INITIAL_CAPACITY = 11;

//PriorityQueue中就是维护这个数组，用来存放最小堆
 transient Object[] queue;

//当前堆中的元素个数，初始值为0；这个有什么作用呢？后面就会知道
private int size = 0;

//这其实就是传入一个数字，数字作为上面那个queue数组的初始长度，如果不传则使用上面的初始长度11
//再传入一个比较器，排序时就按照这个比较器中写的来排序
//如果比较器为null,将使用元素的自然排序（数字的自然排序就是从小到大）
 public PriorityQueue(int initialCapacity,Comparator<?super E> comparator) {
        if (initialCapacity < 1)
            throw new IllegalArgumentException();
        this.queue = new Object[initialCapacity];
        this.comparator = comparator;
    }

//无参构造函数，会传入默认的数组数值11（看上面的第一个属性，它默认是11）
//就是说什么都不传入，初始维护的数组大小为11
public PriorityQueue() {
        this(DEFAULT_INITIAL_CAPACITY, null);
    }

//还有一种构造方法，直接将集合传入构造出一个优先队列，传入的集合元素须有自己的排序方法
public PriorityQueue(Collection<? extends E> c) { 
        if (c instanceof SortedSet<?>) {
            SortedSet<? extends E> ss = (SortedSet<? extends E>) c;
            this.comparator = (Comparator<? super E>) ss.comparator();
            initElementsFromCollection(ss);
        }
        else if (c instanceof PriorityQueue<?>) {
            PriorityQueue<? extends E> pq = (PriorityQueue<? extends E>) c;
            this.comparator = (Comparator<? super E>) pq.comparator();
            initFromPriorityQueue(pq);
        }
        else {
            this.comparator = null;
            initFromCollection(c);
        }
    }

add()和offer()

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

//offer(E e)
public boolean offer(E e) {
    if (e == null)//不允许放入null元素
        throw new NullPointerException();
    modCount++;
    int i = size;
    if (i >= queue.length)
        grow(i + 1);//自动扩容
    size = i + 1;
    if (i == 0)//队列原来为空，这是插入的第一个元素
        queue[0] = e;
    else
        siftUp(i, e);//调整
    return true;
}

上述代码中，扩容函数grow()类似于ArrayList里的grow()函数，就是再申请一个更大的数组，并将原数组的元素复制过去，这里不再赘述。需要注意的是siftUp(int k, E x)方法，该方法用于插入元素x并维持堆的特性。

新加入的元素x可能会破坏小顶堆的性质，因此需要进行调整。调整的过程为：从k指定的位置开始，将x逐层与当前点的parent进行比较并交换，直到满足x >= queue[parent]为止。注意这里的比较可以是元素的自然顺序，也可以是依靠比较器的顺序。

//siftUp()
private void siftUp(int k, E x) {
    while (k > 0) {
        int parent = (k - 1) >>> 1;//parentNo = (nodeNo-1)/2
        Object e = queue[parent];
        if (comparator.compare(x, (E) e) >= 0)//调用比较器的比较方法
            break;
        queue[k] = e;
        k = parent;
    }
    queue[k] = x;
}

element()和peek()

element()和peek()的语义完全相同，都是获取但不删除队首元素，也就是队列中权值最小的那个元素，二者唯一的区别是当方法失败时前者抛出异常，后者返回null。根据小顶堆的性质，堆顶那个元素就是全局最小的那个；由于堆用数组表示，根据下标关系，0下标处的那个元素既是堆顶元素。所以直接返回数组0下标处的那个元素即可。

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

remove()和poll()

remove()和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小于或等于左右孩子中的任何一个为止。

//siftDown()
private void siftDown(int k, 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;
}

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;
    int s = --size;
    if (s == i) //情况1
        queue[i] = null;
    else {
        E moved = (E) queue[s];
        queue[s] = null;
        siftDown(i, moved);//情况2
        ......
    }
    return true;
}

Tips：
注意到poll()和remov方法的后面一句么，queue[s] = null 把最后一个元素置为null。
可以看到删除栈元素后，原数组并不会变小，而是把堆的末尾元素置为null，剩余元素再调整顺序来满足堆的定义，所以优先队列不允许插入null。所以全局变量size就有大作用了，size表示堆的元素数量，就可以用来定位堆的最后一个元素在数组中的位置,来确定堆在数组中的位置