Java集合系列之LinkedHashMap源码分析

private static class Entry<K,V> extends HashMap.Entry<K,V> {
  //当前结点在双向链表中的前继结点的引用
  Entry<K,V> before;
  //当前结点在双向链表中的后继结点的引用
  Entry<K,V> after;

  Entry(int hash, K key, V value, HashMap.Entry<K,V> next) {
    super(hash, key, value, next);
  }

  //从双向链表中移除该结点
  private void remove() {
    before.after = after;
    after.before = before;
  }

  //将当前结点插入到双向链表中一个已存在的结点前面
  private void addBefore(Entry<K,V> existingEntry) {
    //当前结点的下一个结点的引用指向给定结点
    after = existingEntry;
    //当前结点的上一个结点的引用指向给定结点的上一个结点
    before = existingEntry.before;
    //给定结点的上一个结点的下一个结点的引用指向当前结点
    before.after = this;
    //给定结点的上一个结点的引用指向当前结点
    after.before = this;
  }

  //按访问顺序排序时, 记录每次获取的操作
  void recordAccess(HashMap<K,V> m) {
    LinkedHashMap<K,V> lm = (LinkedHashMap<K,V>)m;
    //如果是按访问顺序排序
    if (lm.accessOrder) {
      lm.modCount++;
      //先将自己从双向链表中移除
      remove();
      //将自己放到双向链表尾部
      addBefore(lm.header);
    }
  }
  
  void recordRemoval(HashMap<K,V> m) {
    remove();
  }
}

//父类put方法中会调用的该方法
void addEntry(int hash, K key, V value, int bucketIndex) {
  //调用父类的addEntry方法
  super.addEntry(hash, key, value, bucketIndex);
  //下面操作是方便LRU缓存的实现, 如果缓存容量不足, 就移除最老的元素
  Entry<K,V> eldest = header.after;
  if (removeEldestEntry(eldest)) {
    removeEntryForKey(eldest.key);
  }
}

//父类的addEntry方法中会调用该方法
void createEntry(int hash, K key, V value, int bucketIndex) {
  //先获取HashMap的Entry
  HashMap.Entry<K,V> old = table[bucketIndex];
  //包装成LinkedHashMap自身的Entry
  Entry<K,V> e = new Entry<>(hash, key, value, old);
  table[bucketIndex] = e;
  //将当前结点插入到双向链表的尾部
  e.addBefore(header);
  size++;
}

public class LinkedHashMap<K,V> extends HashMap<K,V> implements Map<K,V> {
  //双向链表头结点
  private transient Entry<K,V> header;
  //是否按访问顺序排序
  private final boolean accessOrder;
  ...
  public LinkedHashMap(int initialCapacity, float loadFactor, boolean accessOrder) {
    super(initialCapacity, loadFactor);
    this.accessOrder = accessOrder;
  }
  //根据key获取value值
  public V get(Object key) {
    //调用父类方法获取key对应的Entry
    Entry<K,V> e = (Entry<K,V>)getEntry(key);
    if (e == null) {
      return null;
    }
    //如果是按访问顺序排序的话, 会将每次使用后的结点放到双向链表的尾部
    e.recordAccess(this);
    return e.value;
  }
  private static class Entry<K,V> extends HashMap.Entry<K,V> {
    ...
    //将当前结点插入到双向链表中一个已存在的结点前面
    private void addBefore(Entry<K,V> existingEntry) {
      //当前结点的下一个结点的引用指向给定结点
      after = existingEntry;
      //当前结点的上一个结点的引用指向给定结点的上一个结点
      before = existingEntry.before;
      //给定结点的上一个结点的下一个结点的引用指向当前结点
      before.after = this;
      //给定结点的上一个结点的引用指向当前结点
      after.before = this;
    }
    //按访问顺序排序时, 记录每次获取的操作
    void recordAccess(HashMap<K,V> m) {
      LinkedHashMap<K,V> lm = (LinkedHashMap<K,V>)m;
      //如果是按访问顺序排序
      if (lm.accessOrder) {
        lm.modCount++;
        //先将自己从双向链表中移除
        remove();
        //将自己放到双向链表尾部
        addBefore(lm.header);
      }
    }
    ...
  }
  //父类put方法中会调用的该方法
  void addEntry(int hash, K key, V value, int bucketIndex) {
    //调用父类的addEntry方法
    super.addEntry(hash, key, value, bucketIndex);
    //下面操作是方便LRU缓存的实现, 如果缓存容量不足, 就移除最老的元素
    Entry<K,V> eldest = header.after;
    if (removeEldestEntry(eldest)) {
      removeEntryForKey(eldest.key);
    }
  }
  //是否删除最老的元素, 该方法设计成要被子类覆盖
  protected boolean removeEldestEntry(Map.Entry<K,V> eldest) {
    return false;
  }
}

public class LRUMap<K, V> extends LinkedHashMap<K, V> {
  
  private int capacity;
  
  LRUMap(int capacity) {
    //调用父类构造器, 设置为按访问顺序排序
    super(capacity, 1f, true);
    this.capacity = capacity;
  }
  
  @Override
  public boolean removeEldestEntry(Map.Entry<K, V> eldest) {
    //当键值对大于等于哈希表容量时
    return this.size() >= capacity;
  }
  
  public static void main(String[] args) {
    LRUMap<Integer, String> map = new LRUMap<Integer, String>(4);
    map.put(1, "a");
    map.put(2, "b");
    map.put(3, "c");
    System.out.println("原始集合:" + map);
    String s = map.get(2);
    System.out.println("获取元素:" + map);
    map.put(4, "d");
    System.out.println("插入之后:" + map);
  }
  
}