com.dahuatech.hutool.cache.impl.LFUCache Maven / Gradle / Ivy

Go to download
package com.dahuatech.hutool.cache.impl;

import java.util.HashMap;
import java.util.Iterator;

/**
 * LFU(least frequently used) 最少使用率缓存

 * 根据使用次数来判定对象是否被持续缓存

 * 使用率是通过访问次数计算的。

 * 当缓存满时清理过期对象。

 * 清理后依旧满的情况下清除最少访问（访问计数最小）的对象并将其他对象的访问数减去这个最小访问数，以便新对象进入后可以公平计数。
 *
 * @author Looly,jodd
 * @param  键类型
 * @param  值类型
 */
public class LFUCache extends AbstractCache {
  private static final long serialVersionUID = 1L;

  /**
   * 构造
   *
   * @param capacity 容量
   */
  public LFUCache(int capacity) {
    this(capacity, 0);
  }

  /**
   * 构造
   *
   * @param capacity 容量
   * @param timeout 过期时长
   */
  public LFUCache(int capacity, long timeout) {
    if (Integer.MAX_VALUE == capacity) {
      capacity -= 1;
    }

    this.capacity = capacity;
    this.timeout = timeout;
    cacheMap = new HashMap>(capacity + 1, 1.0f);
  }

  // ---------------------------------------------------------------- prune

  /**
   * 清理过期对象。

   * 清理后依旧满的情况下清除最少访问（访问计数最小）的对象并将其他对象的访问数减去这个最小访问数，以便新对象进入后可以公平计数。
   *
   * @return 清理个数
   */
  @Override
  protected int pruneCache() {
    int count = 0;
    CacheObj comin = null;

    // 清理过期对象并找出访问最少的对象
    Iterator> values = cacheMap.values().iterator();
    CacheObj co;
    while (values.hasNext()) {
      co = values.next();
      if (co.isExpired() == true) {
        values.remove();
        onRemove(co.key, co.obj);
        count++;
        continue;
      }

      // 找出访问最少的对象
      if (comin == null || co.accessCount < comin.accessCount) {
        comin = co;
      }
    }

    // 减少所有对象访问量，并清除减少后为0的访问对象
    if (isFull() && comin != null) {
      long minAccessCount = comin.accessCount;

      values = cacheMap.values().iterator();
      CacheObj co1;
      while (values.hasNext()) {
        co1 = values.next();
        co1.accessCount -= minAccessCount;
        if (co1.accessCount <= 0) {
          values.remove();
          onRemove(co1.key, co1.obj);
          count++;
        }
      }
    }

    return count;
  }
}