Java集合框架源码分析之LinkedHashMap详解

package java.util; 
import java.io.*; 
public class linkedhashmap<k,v> 
  extends hashmap<k,v> 
  implements map<k,v> 
{ 
  private static final long serialversionuid = 3801124242820219131l; 
  //双向循环链表的头结点，整个linkedhashmap中只有一个header， 
  //它将哈希表中所有的entry贯穿起来，header中不保存key-value对，只保存前后节点的引用 
  private transient entry<k,v> header; 
  //双向链表中元素排序规则的标志位。 
  //accessorder为false，表示按插入顺序排序 
  //accessorder为true，表示按访问顺序排序 
  private final boolean accessorder; 
  //调用hashmap的构造方法来构造底层的数组 
  public linkedhashmap(int initialcapacity, float loadfactor) { 
    super(initialcapacity, loadfactor); 
    accessorder = false;  //链表中的元素默认按照插入顺序排序 
  } 
  //加载因子取默认的0.75f 
  public linkedhashmap(int initialcapacity) { 
    super(initialcapacity); 
    accessorder = false; 
  } 
  //加载因子取默认的0.75f，容量取默认的16 
  public linkedhashmap() { 
    super(); 
    accessorder = false; 
  } 
  //含有子map的构造方法，同样调用hashmap的对应的构造方法 
  public linkedhashmap(map<? extends k, ? extends v> m) { 
    super(m); 
    accessorder = false; 
  } 
  //该构造方法可以指定链表中的元素排序的规则 
  public linkedhashmap(int initialcapacity,float loadfactor,boolean accessorder) { 
    super(initialcapacity, loadfactor); 
    this.accessorder = accessorder; 
  } 
  //覆写父类的init()方法（hashmap中的init方法为空）， 
  //该方法在父类的构造方法和clone、readobject中在插入元素前被调用， 
  //初始化一个空的双向循环链表，头结点中不保存数据，头结点的下一个节点才开始保存数据。 
  void init() { 
    header = new entry<k,v>(-1, null, null, null); 
    header.before = header.after = header; 
  } 
  //覆写hashmap中的transfer方法，它在父类的resize方法中被调用， 
  //扩容后，将key-value对重新映射到新的newtable中 
  //覆写该方法的目的是为了提高复制的效率， 
  //这里充分利用双向循环链表的特点进行迭代，不用对底层的数组进行for循环。 
  void transfer(hashmap.entry[] newtable) { 
    int newcapacity = newtable.length; 
    for (entry<k,v> e = header.after; e != header; e = e.after) { 
      int index = indexfor(e.hash, newcapacity); 
      e.next = newtable[index]; 
      newtable[index] = e; 
    } 
  } 
  //覆写hashmap中的containsvalue方法， 
  //覆写该方法的目的同样是为了提高查询的效率， 
  //利用双向循环链表的特点进行查询，少了对数组的外层for循环 
  public boolean containsvalue(object value) { 
    // overridden to take advantage of faster iterator 
    if (value==null) { 
      for (entry e = header.after; e != header; e = e.after) 
        if (e.value==null) 
          return true; 
    } else { 
      for (entry e = header.after; e != header; e = e.after) 
        if (value.equals(e.value)) 
          return true; 
    } 
    return false; 
  } 
  //覆写hashmap中的get方法，通过getentry方法获取entry对象。 
  //注意这里的recordaccess方法， 
  //如果链表中元素的排序规则是按照插入的先后顺序排序的话，该方法什么也不做， 
  //如果链表中元素的排序规则是按照访问的先后顺序排序的话，则将e移到链表的末尾处。 
  public v get(object key) { 
    entry<k,v> e = (entry<k,v>)getentry(key); 
    if (e == null) 
      return null; 
    e.recordaccess(this); 
    return e.value; 
  } 
  //清空hashmap，并将双向链表还原为只有头结点的空链表 
  public void clear() { 
    super.clear(); 
    header.before = header.after = header; 
  } 
  //enty的数据结构，多了两个指向前后节点的引用 
  private static class entry<k,v> extends hashmap.entry<k,v> { 
    // these fields comprise the doubly linked list used for iteration. 
    entry<k,v> before, after; 
    //调用父类的构造方法 
    entry(int hash, k key, v value, hashmap.entry<k,v> next) { 
      super(hash, key, value, next); 
    } 
    //双向循环链表中，删除当前的entry 
    private void remove() { 
      before.after = after; 
      after.before = before; 
    } 
    //双向循环立链表中，将当前的entry插入到existingentry的前面 
    private void addbefore(entry<k,v> existingentry) { 
      after = existingentry; 
      before = existingentry.before; 
      before.after = this; 
      after.before = this; 
    } 
    //覆写hashmap中的recordaccess方法（hashmap中该方法为空）， 
    //当调用父类的put方法，在发现插入的key已经存在时，会调用该方法， 
    //调用linkedhashmap覆写的get方法时，也会调用到该方法， 
    //该方法提供了lru算法的实现，它将最近使用的entry放到双向循环链表的尾部， 
    //accessorder为true时，get方法会调用recordaccess方法 
    //put方法在覆盖key-value对时也会调用recordaccess方法 
    //它们导致entry最近使用，因此将其移到双向链表的末尾 
    void recordaccess(hashmap<k,v> m) { 
      linkedhashmap<k,v> lm = (linkedhashmap<k,v>)m; 
      //如果链表中元素按照访问顺序排序，则将当前访问的entry移到双向循环链表的尾部， 
      //如果是按照插入的先后顺序排序，则不做任何事情。 
      if (lm.accessorder) { 
        lm.modcount++; 
        //移除当前访问的entry 
        remove(); 
        //将当前访问的entry插入到链表的尾部 
        addbefore(lm.header); 
      } 
    } 
    void recordremoval(hashmap<k,v> m) { 
      remove(); 
    } 
  } 
  //迭代器 
  private abstract class linkedhashiterator<t> implements iterator<t> { 
  entry<k,v> nextentry  = header.after; 
  entry<k,v> lastreturned = null; 
  /** 
   * the modcount value that the iterator believes that the backing 
   * list should have. if this expectation is violated, the iterator 
   * has detected concurrent modification. 
   */ 
  int expectedmodcount = modcount; 
  public boolean hasnext() { 
      return nextentry != header; 
  } 
  public void remove() { 
    if (lastreturned == null) 
    throw new illegalstateexception(); 
    if (modcount != expectedmodcount) 
    throw new concurrentmodificationexception(); 
      linkedhashmap.this.remove(lastreturned.key); 
      lastreturned = null; 
      expectedmodcount = modcount; 
  } 
  //从head的下一个节点开始迭代 
  entry<k,v> nextentry() { 
    if (modcount != expectedmodcount) 
    throw new concurrentmodificationexception(); 
      if (nextentry == header) 
        throw new nosuchelementexception(); 
      entry<k,v> e = lastreturned = nextentry; 
      nextentry = e.after; 
      return e; 
  } 
  } 
  //key迭代器 
  private class keyiterator extends linkedhashiterator<k> { 
  public k next() { return nextentry().getkey(); } 
  } 
  //value迭代器 
  private class valueiterator extends linkedhashiterator<v> { 
  public v next() { return nextentry().value; } 
  } 
  //entry迭代器 
  private class entryiterator extends linkedhashiterator<map.entry<k,v>> { 
  public map.entry<k,v> next() { return nextentry(); } 
  } 
  // these overrides alter the behavior of superclass view iterator() methods 
  iterator<k> newkeyiterator()  { return new keyiterator();  } 
  iterator<v> newvalueiterator() { return new valueiterator(); } 
  iterator<map.entry<k,v>> newentryiterator() { return new entryiterator(); } 
  //覆写hashmap中的addentry方法，linkedhashmap并没有覆写hashmap中的put方法， 
  //而是覆写了put方法所调用的addentry方法和recordaccess方法， 
  //put方法在插入的key已存在的情况下，会调用recordaccess方法， 
  //在插入的key不存在的情况下，要调用addentry插入新的entry 
  void addentry(int hash, k key, v value, int bucketindex) { 
    //创建新的entry，并插入到linkedhashmap中 
    createentry(hash, key, value, bucketindex); 
    //双向链表的第一个有效节点（header后的那个节点）为近期最少使用的节点 
    entry<k,v> eldest = header.after; 
    //如果有必要，则删除掉该近期最少使用的节点， 
    //这要看对removeeldestentry的覆写,由于默认为false，因此默认是不做任何处理的。 
    if (removeeldestentry(eldest)) { 
      removeentryforkey(eldest.key); 
    } else { 
      //扩容到原来的2倍 
      if (size >= threshold) 
        resize(2 * table.length); 
    } 
  } 
  void createentry(int hash, k key, v value, int bucketindex) { 
    //创建新的entry，并将其插入到数组对应槽的单链表的头结点处，这点与hashmap中相同 
    hashmap.entry<k,v> old = table[bucketindex]; 
    entry<k,v> e = new entry<k,v>(hash, key, value, old); 
    table[bucketindex] = e; 
    //每次插入entry时，都将其移到双向链表的尾部， 
    //这便会按照entry插入linkedhashmap的先后顺序来迭代元素， 
    //同时，新put进来的entry是最近访问的entry，把其放在链表末尾 ，符合lru算法的实现 
    e.addbefore(header); 
    size++; 
  } 
  //该方法是用来被覆写的，一般如果用linkedhashmap实现lru算法，就要覆写该方法， 
  //比如可以将该方法覆写为如果设定的内存已满，则返回true，这样当再次向linkedhashmap中put 
  //entry时，在调用的addentry方法中便会将近期最少使用的节点删除掉（header后的那个节点）。 
  protected boolean removeeldestentry(map.entry<k,v> eldest) { 
    return false; 
  } 
} 

// 将“key-value”添加到hashmap中   
public v put(k key, v value) {   
  // 若“key为null”，则将该键值对添加到table[0]中。   
  if (key == null)   
    return putfornullkey(value);   
  // 若“key不为null”，则计算该key的哈希值，然后将其添加到该哈希值对应的链表中。   
  int hash = hash(key.hashcode());   
  int i = indexfor(hash, table.length);   
  for (entry<k,v> e = table[i]; e != null; e = e.next) {   
    object k;   
    // 若“该key”对应的键值对已经存在，则用新的value取代旧的value。然后退出！   
    if (e.hash == hash && ((k = e.key) == key || key.equals(k))) {   
      v oldvalue = e.value;   
      e.value = value;   
      e.recordaccess(this);   
      return oldvalue;   
    }   
  }   
  // 若“该key”对应的键值对不存在，则将“key-value”添加到table中   
  modcount++;  
  //将key-value添加到table[i]处  
  addentry(hash, key, value, i);   
  return null;   
} 

//覆写hashmap中的recordaccess方法（hashmap中该方法为空）， 
//当调用父类的put方法，在发现插入的key已经存在时，会调用该方法， 
//调用linkedhashmap覆写的get方法时，也会调用到该方法， 
//该方法提供了lru算法的实现，它将最近使用的entry放到双向循环链表的尾部， 
//accessorder为true时，get方法会调用recordaccess方法 
//put方法在覆盖key-value对时也会调用recordaccess方法 
//它们导致entry最近使用，因此将其移到双向链表的末尾 
   void recordaccess(hashmap<k,v> m) { 
     linkedhashmap<k,v> lm = (linkedhashmap<k,v>)m; 
  //如果链表中元素按照访问顺序排序，则将当前访问的entry移到双向循环链表的尾部， 
  //如果是按照插入的先后顺序排序，则不做任何事情。 
     if (lm.accessorder) { 
       lm.modcount++; 
    //移除当前访问的entry 
       remove(); 
    //将当前访问的entry插入到链表的尾部 
       addbefore(lm.header); 
     } 
   } 

//覆写hashmap中的addentry方法，linkedhashmap并没有覆写hashmap中的put方法， 
//而是覆写了put方法所调用的addentry方法和recordaccess方法， 
//put方法在插入的key已存在的情况下，会调用recordaccess方法， 
//在插入的key不存在的情况下，要调用addentry插入新的entry 
  void addentry(int hash, k key, v value, int bucketindex) { 
  //创建新的entry，并插入到linkedhashmap中 
    createentry(hash, key, value, bucketindex); 
    //双向链表的第一个有效节点（header后的那个节点）为近期最少使用的节点 
    entry<k,v> eldest = header.after; 
  //如果有必要，则删除掉该近期最少使用的节点， 
  //这要看对removeeldestentry的覆写,由于默认为false，因此默认是不做任何处理的。 
    if (removeeldestentry(eldest)) { 
      removeentryforkey(eldest.key); 
    } else { 
    //扩容到原来的2倍 
      if (size >= threshold) 
        resize(2 * table.length); 
    } 
  } 
  void createentry(int hash, k key, v value, int bucketindex) { 
  //创建新的entry，并将其插入到数组对应槽的单链表的头结点处，这点与hashmap中相同 
    hashmap.entry<k,v> old = table[bucketindex]; 
  entry<k,v> e = new entry<k,v>(hash, key, value, old); 
    table[bucketindex] = e; 
  //每次插入entry时，都将其移到双向链表的尾部， 
  //这便会按照entry插入linkedhashmap的先后顺序来迭代元素， 
  //同时，新put进来的entry是最近访问的entry，把其放在链表末尾 ，符合lru算法的实现 
    e.addbefore(header); 
    size++; 
  } 

 //该方法是用来被覆写的，一般如果用linkedhashmap实现lru算法，就要覆写该方法， 
  //比如可以将该方法覆写为如果设定的内存已满，则返回true，这样当再次向linkedhashmap中put 
  //entry时，在调用的addentry方法中便会将近期最少使用的节点删除掉（header后的那个节点）。 
  protected boolean removeeldestentry(map.entry<k,v> eldest) { 
    return false; 
  } 
} 

//覆写hashmap中的get方法，通过getentry方法获取entry对象。 
//注意这里的recordaccess方法， 
//如果链表中元素的排序规则是按照插入的先后顺序排序的话，该方法什么也不做， 
//如果链表中元素的排序规则是按照访问的先后顺序排序的话，则将e移到链表的末尾处。 
  public v get(object key) { 
    entry<k,v> e = (entry<k,v>)getentry(key); 
    if (e == null) 
      return null; 
    e.recordaccess(this); 
    return e.value; 
  }