LinkedHashMap

/ Java / 没有评论 / 358浏览

今天我们继续分享有关集合的知识,在上几篇中,我们已经将Java中比较常用的集合类的底层实现及涉及到的数据结构都已经介绍完了。那么如果我们仔细查看JDK的源码就会发现,其实在Java中还有很多个集合类,远远不是我们文章中介绍的那几种。这是因为Java为了满足我们开发时的所有需求,于是创造了很多个具有其它特性的集合类。但它们底层都是采用我们文章中已经提到过的数据结构存储的。

今天我们将介绍一种新的集合类叫做LinkedHashMap。看名字,我们知道此集合的底层是基于HashMap实现的,这就说明底层的数据结构采用的就是哈希表存储的。那么LinkedHashMap和HashMap到底有什么区别呢?我们先通过下面的测试用例来演示一下这两种集合类有何不同,然后在详细分析底层的实现方式。

public class Test {
@org.junit.Test
public void test() throws Exception {
LinkedHashMap linkedHashMap = new LinkedHashMap<>();
linkedHashMap.put(3, 3);
linkedHashMap.put(2, 2);
linkedHashMap.put(1, 1);
HashMap hashMap = new HashMap();
hashMap.put(3, 3);
hashMap.put(2, 2);
hashMap.put(1, 1);
System.out.println(linkedHashMap);
System.out.println(hashMap);
}
}
{3=3, 2=2, 1=1}
{1=1, 2=2, 3=3}

看输出结果我们发现了不同,HashMap集合输出元素的顺序和添加元素的顺序是不同的,确切的说,应该是输出元素的顺序和添加元素的顺序不保证一定相同,这一点我们已经在其它的文章中介绍过了。这是因为在向HashMap中添加元素时,底层会先计算key的hashCode然后通过这个hashCode的值来确定这个元素保存到底层数组的哪个索引位置。

看输出结果我们可以得知LinkedHashMap集合则是输出元素的顺序和添加元素的顺序是相同的。在严谨点,就是必须能够保证输出元素的顺序和添加元素的顺序是相同的,这也是LinkedHashMap相比HashMap的一种新特性。下面我们将重点分析一下在LinkedHashMap的底层是怎么实现这种新特性的。

 我们首先看一下LinkedHashMap集合的定义,来看看它和HashMap集合的关系。

public class LinkedHashMap<K,V>
extends HashMap<K,V>
implements Map<K,V>

通过上述代码,使我们知道原来LinkedHashMap集合就是HashMap集合的子类,并且都实现了Map接口。下面我们来看一下LinkedHashMap集合中put方法。当我们点击put方法跳转到源码时发现居然直接跳转到了HashMap中的源码。这就说明,在LinkedHashMap集合类中并没有重写put方法。既然没有重写put方法,那LinkedHashMap集合是怎么保证添加元素与输出元素的顺序的呢?可想而知一定是在put方法的某一处重写了,而不是重写了整个put方法。我们在看一下HashMap中put的方法,看看在这个方法中,到底哪一个块可以被重写。

final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
boolean evict) {
Node<K,V>[] tab; Node<K,V> p; int n, i;
if ((tab = table) == null || (n = tab.length) == 0)
n = (tab = resize()).length;
if ((p = tab[i = (n - 1) & hash]) == null)
tab[i] = newNode(hash, key, value, null);
else {
Node<K,V> e; K k;
if (p.hash == hash &&
((k = p.key) == key || (key != null && key.equals(k))))
e = p;
else if (p instanceof TreeNode)
e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
else {
for (int binCount = 0; ; ++binCount) {
if ((e = p.next) == null) {
p.next = newNode(hash, key, value, null);
if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
treeifyBin(tab, hash);
break;
}
if (e.hash == hash &&
((k = e.key) == key || (key != null && key.equals(k))))
break;
p = e;
}
}
if (e != null) { // existing mapping for key
V oldValue = e.value;
if (!onlyIfAbsent || oldValue == null)
e.value = value;
afterNodeAccess(e);
return oldValue;
}
}
++modCount;
if (++size > threshold)
resize();
afterNodeInsertion(evict);
return null;
}

上面代码就是HashMap中put方法的核心方法,并且上面的代码逻辑我们已经介绍过了。通过对上面代码的检查,我们发现在LinkedHashMap集合中重写了newNode方法。我们知道这个newNode方法就是添加元素的核心方法就是用它来存储添加的数据的,既然LinkedHashMap集合重写了该方法,那么保证LinkedHashMap集合添加顺序与输出顺序一致的特性就应该是这个方法实现的逻辑了。所以下面我们看一下LinkedHashMap集合中newNode方法的实现逻辑。

Node<K,V> newNode(int hash, K key, V value, Node<K,V> e) {
LinkedHashMap.Entry<K,V> p = new LinkedHashMap.Entry<K,V>(hash, key, value, e); // 创建一个新的对象来存储数据
linkNodeLast(p); // 设置节点的前驱节点与后继节点
return p;
}
static class Entry<K,V> extends HashMap.Node<K,V> {
Entry<K,V> before, after; // 定义一个Entry对象用来保存元素的前驱节点和后继节点 这块和HashMap中有些不同,在HashMap的节点对象中只会存储后继节点
Entry(int hash, K key, V value, Node<K,V> next) {
super(hash, key, value, next); // 直接调用HashMap中Node节点对象的构造方法保存数据
}
}
private void linkNodeLast(LinkedHashMap.Entry<K,V> p) {
LinkedHashMap.Entry<K,V> last = tail; // 获取上一次保存的节点对象,如果是第一次保存则此值为null
tail = p; // 将当前已经保存信息的节点p赋值给tail
if (last == null) // last为空说明LinkedHashMap集合是第一次调用put方法
head = p; // 将新添加的元素信息设置为链表的头节点
else { // last不为空,说明LinkedHashMap集合中已经保存了其它元素了
p.before = last; // 将当前节点的前驱节点设置为LinkedHashMap集合中上一次添加的节点
last.after = p; // 将LinkedHashMap集合中上一次添加的节点的后继节点设置为当前添加的节点信息         // 上两句代码核心逻辑是将添加到LinkedHashMap集合中的元素采用双链表的方法存储,而HashMap中存储元素的方法则是采用的是单向链表,只保存当前元素的后继节点
}
}

虽然上面的代码我们已经明白了它的实现逻辑,但是貌似还是没有解释为什么LinkedHashMap集合是可以保证元素的添加顺序和输出顺序一致的。别着急我们继续往下分析,在文章的开头我们输出了LinkedHashMap集合的信息也就是下面的信息。

{3=3, 2=2, 1=1}

这时可能有人会有些不解,为什么我们直接打印LinkedHashMap对象的引用就会把集合中内容输出出来。这是因为在System.out.println方法中会默认调用参数对象的toString方法,如果参数对象没有重写toString方法,则默认会执行Object中toString方法。我们可以通过下面的源码来证明我们上述的说法。

public void println(Object x) {
String s = String.valueOf(x);
synchronized (this) {
print(s);
newLine();
}
}
public static String valueOf(Object obj) {
return (obj == null) ? "null" : obj.toString();
}

现在我们知道了,为什么我们直接调用System.out.println方法就会直接输出LinkedHashMap集合的内容。一定是LinkedHashMap集合重写了toString方法,否则System.out.println方法就会直接打印对象的地址,向数组一样,而不会打印集合中的元素。所以我们只要知道LinkedHashMap集合中是怎么重写toString方法的就知道了该集合是怎么保证元素的输出顺序与添加顺序一致的问题了。所以下面我们重点分析一下LinkedHashMap集合中的toString方法。

public String toString() {
Iterator<Entry<K,V>> i = entrySet().iterator();
if (! i.hasNext())
return "{}";

StringBuilder sb = new StringBuilder();
sb.append('{');
for (;;) {
Entry<K,V> e = i.next();
K key = e.getKey();
V value = e.getValue();
sb.append(key == this ? "(this Map)" : key);
sb.append('=');
sb.append(value == this ? "(this Map)" : value);
if (! i.hasNext())
return sb.append('}').toString();
sb.append(',').append(' ');
}
}

上面的toString方法并不是在LinkedHashMap集合中重写的,而是它的父类AbstractMap类中写的。上面方法的逻辑比较简单就是调用了Iterator接口迭代输出集合中的内容。因为我们知道在集合中都实现了迭代器接口,用来方便我们遍历集合中的元素。所以我们只要知道在LinkedHashMap集合中迭代器接口的实现逻辑,就可以知道LinkedHashMap集合保证顺序的原因了。也就是上面代码的entrySet方法的实现逻辑。entrySet方法是在AbstractMap类中定义的抽象方法,具体的方法逻辑则是在LinkedHashMap集合中实现的。

public abstract Set<Entry<K,V>> entrySet();

下面代码是LinkedHashMap集合中实现entrySet方法的逻辑。

public Set<Map.Entry<K,V>> entrySet() {
Set<Map.Entry<K,V>> es;
return (es = entrySet) == null ? (entrySet = new LinkedEntrySet()) : es; // 创建LinkedEntrySet对象
}
final class LinkedEntrySet extends AbstractSet<Map.Entry<K,V>> {
public final int size() { return size; }
public final void clear() { LinkedHashMap.this.clear(); }
public final Iterator<Map.Entry<K,V>> iterator() {
return new LinkedEntryIterator();
}
public final boolean contains(Object o) {
if (!(o instanceof Map.Entry))
return false;
Map.Entry<?,?> e = (Map.Entry<?,?>) o;
Object key = e.getKey();
Node<K,V> candidate = getNode(hash(key), key);
return candidate != null && candidate.equals(e);
}
public final boolean remove(Object o) {
if (o instanceof Map.Entry) {
Map.Entry<?,?> e = (Map.Entry<?,?>) o;
Object key = e.getKey();
Object value = e.getValue();
return removeNode(hash(key), key, value, true, true) != null;
}
return false;
}
public final Spliterator<Map.Entry<K,V>> spliterator() {
return Spliterators.spliterator(this, Spliterator.SIZED |
Spliterator.ORDERED |
Spliterator.DISTINCT);
}
public final void forEach(Consumer<? super Map.Entry<K,V>> action) {
if (action == null)
throw new NullPointerException();
int mc = modCount;         // 循环遍历集合中双链表的数据 head为链表中的开始节点 这也是LinkedHashMap集合能够保证插入元素顺序与输出顺序一致的根本原因
for (LinkedHashMap.Entry<K,V> e = head; e != null; e = e.after)
action.accept(e);
if (modCount != mc)
throw new ConcurrentModificationException();
}
}