PriorityQueue中元素为对象类型时的比较

前言：

上篇总结了优先级队列，优先级队列在插入元素时有个要求：插入的元素不能是null 或者元素之间必须要能够进行比较。 此时元素为 Integer 类型时能够比较，如果元素类型为 自定义类型对象 时该如何比较呢？

---

一、PriorityQueue 中插入对象

class Card {
	public int rank; // 数值
	public String suit; // 花色
	
	public Card(int rank, String suit) {
		this.rank = rank;
		this.suit = suit;
	}
}

public class TestPriorityQueue {
	public static void TestPriorityQueue(){
		PriorityQueue<Card> p = new PriorityQueue<>();
		p.offer(new Card(1, "♠"));
		p.offer(new Card(2, "♠"));
	}
	public static void main(String[] args) {
		TestPriorityQueue();
	}
}

优先级队列底层使用堆，而向堆中插入元素时，为了满足堆的性质，必须要进行元素的比较，而此时 Card 是自定义类型，是没有办法直接进行比较的，因此抛出异常。

那么如何让自定义类型对象可以比较呢？有以下几种方式：

• 复写基类的 equals
• 实现 Comparble 接口，重写 compareTo 方法
• 基于比较器比较

二、使自定义类型对象可比较

1.复写基类的 equals

public class Card {
	public int rank; // 数值
	public String suit; // 花色
	
	public Card(int rank, String suit) {
		this.rank = rank;
		this.suit = suit;
	}
	@Override
	public boolean equals(Object o) {
		if (this == o) {
			return true;
		}
		// o如果是null对象，或者o不是Card的子类
		if (o == null || !(o instanceof Card)) {
			return false;
		}
		// 注意基本类型可以直接比较，但引用类型最好调用其equal方法
		Card c = (Card)o;
		return rank == c.rank && suit.equals(c.suit);
	}
}

注意： 一般复写 equals 的套路就是上面演示的

1. 如果指向同一个对象，返回 true
2. 如果传入的为 null，返回 false
3. 如果传入的对象类型不是 Card，返回 false
4. 按照类的实现目标完成比较，例如这里只要花色和数值一样，就认为是相同的牌
5. 注意调用其他引用类型的比较也需要 equals，例如这里的 suit 的比较

覆写基类equal的方式虽然可以比较，但缺陷是：equal只能按照相等进行比较，不能按照大于、小于的方式进行比较。

2.实现 Comparble 接口，重写 compareTo 方法

Comparble 是 JDK 提供的泛型的比较接口类，源码实现具体如下：

public interface Comparable<E> {
	// 返回值:
	// < 0: 表示 this 指向的对象小于 o 指向的对象
	// == 0: 表示 this 指向的对象等于 o 指向的对象
	// > 0: 表示 this 指向的对象大于 o 指向的对象
	int compareTo(E o);
}

对用户自定义类型，如果要想按照大小与方式进行比较时：在定义类时，实现Comparble接口即可，然后在类中重写 compareTo 方法。

public class Card implements Comparable<Card>{
	public int rank; // 数值
	public String suit; // 花色
	
	public Card(int rank, String suit) {
		this.rank = rank;
		this.suit = suit;
	}

	// 根据数值比较，不管花色
	// 这里我们认为 null 是最小的
	@Override
	public int compareTo(Card o) {
		if (o == null) {
			return 1;
		}
		return rank - o.rank;
	}
}

3.基于比较器比较

按照比较器方式进行比较，具体步骤如下：

• 用户自定义比较器类，实现Comparator接口
• 覆写Comparator中的compare方法

Comparator 接口，源码实现具体如下：

public interface Comparator<T> {
	// 返回值:
	// < 0: 表示 o1 指向的对象小于 o2 指向的对象
	// == 0: 表示 o1 指向的对象等于 o2 指向的对象
	// > 0: 表示 o1 指向的对象等于 o2 指向的对象
	int compare(T o1, T o2);
}

注意区分 Comparable 和 Comparator.

重写 Comparator 中的 compare 方法：

import java.util.Comparator;
class Card {
	public int rank; // 数值
	public String suit; // 花色
	
	public Card(int rank, String suit) {
		this.rank = rank;
		this.suit = suit;
	}
}
class CardComparator implements Comparator<Card> {
	// 根据数值比较，不管花色
	// 这里我们认为 null 是最小的
	@Override
	public int compare(Card o1, Card o2) {
		if (o1 == o2) {
			return 0;
		}
		if (o1 == null) {
			return -1;
		}
		if (o2 == null) {
			return 1;
		}
		return o1.rank - o2.rank;
	}
	public static void main(String[] args){
		Card p = new Card(1, "♠");
		Card q = new Card(2, "♠");
		Card o = new Card(1, "♠");
		// 定义比较器对象
		CardComparator cmptor = new CardComparator();
		// 使用比较器对象进行比较
		System.out.println(cmptor.compare(p, o)); // == 0，表示牌相等
		System.out.println(cmptor.compare(p, q)); // < 0，表示 p 比较小
		System.out.println(cmptor.compare(q, p)); // > 0，表示 q 比较大
	}
}

4. 三种方式对比

复写的方法	说明
Object.equals	因为所有类都是继承自 Object 的，所以直接覆写即可，不过只能比较相等与否
Comparable.compareTo	需要手动实现接口，侵入性比较强，但一旦实现，每次用该类都有顺序，属于内部顺序
Comparator.compare	需要实现一个比较器对象，对待比较类的侵入性弱，但对算法代码实现侵入性强

三、集合框架中 PriorityQueue 的比较方式

集合框架中的 PriorityQueue 底层使用堆结构，因此其内部的元素必须要能够比大小，PriorityQueue 采用了 Comparble 和 Comparator 两种方式。

1. Comparble 是默认的内部比较方式，如果用户插入自定义类型对象时，该类对象必须要实现Comparble 接口，并覆写 compareTo 方法
2. 用户也可以选择使用比较器对象，如果用户插入自定义类型对象时，必须要提供一个比较器类，让该类实现 Comparator 接口并覆写 compare 方法。

JDK 中 PriorityQueue 的实现，源码：

// JDK中PriorityQueue的实现：
public class PriorityQueue<E> extends AbstractQueue<E> implements java.io.Serializable {
	// 默认容量
	private static final int DEFAULT_INITIAL_CAPACITY = 11;
	// 内部定义的比较器对象，用来接收用户实例化PriorityQueue对象时提供的比较器对象
	private final Comparator<? super E> comparator;
	// 用户如果没有提供比较器对象，使用默认的内部比较，将comparator置为null
	public PriorityQueue() {
		this(DEFAULT_INITIAL_CAPACITY, null);
	}
	// 如果用户提供了比较器，采用用户提供的比较器进行比较
	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;
	}
	// 向上调整：
	// 如果用户没有提供比较器对象，采用Comparable进行比较
	// 否则使用用户提供的比较器对象进行比较
	private void siftUp(int k, E x) {
		if (comparator != null)
			siftUpUsingComparator(k, x);
		else
			siftUpComparable(k, x);
	}
	// 使用Comparable
	@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;
	}
}