快捷導(dǎo)航

Java TimedCache 帶時(shí)間緩存工具類詳解使用

更新時(shí)間：2021年10月27日 16:31:59 作者：劍客阿良_ALiang

工具類是包含集合框架、遺留的 collection 類、事件模型、日期和時(shí)間設(shè)施、國(guó)際化和各種實(shí)用工具類（字符串標(biāo)記生成器、隨機(jī)數(shù)生成器和位數(shù)組、日期Date類、堆棧Stack類、向量Vector類等）。集合類、時(shí)間處理模式、日期工具等各類常用工具包，本文將介紹帶時(shí)間緩存工具類

簡(jiǎn)述

我們?cè)诠ぷ髦袝?huì)碰到需要使用帶過(guò)期時(shí)間的緩存場(chǎng)景。但是使用redis有太重了，畢竟緩存的數(shù)據(jù)很小，放在內(nèi)存夠夠的。hutools提供了TimedCache時(shí)間緩存工具，可以實(shí)現(xiàn)該場(chǎng)景。下面使用到該組件，并為了適配工作場(chǎng)景，對(duì)該工具類做優(yōu)化升級(jí)。

Maven依賴

        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-all</artifactId>
            <version>5.4.6</version>
        </dependency>
        <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
            <version>30.1.1-jre</version>
        </dependency>

簡(jiǎn)單使用

不多說(shuō)了，上代碼。

import cn.hutool.cache.CacheUtil;
import cn.hutool.cache.impl.TimedCache;
import cn.hutool.core.thread.ThreadUtil;
 
/** @Author huyi @Date 2021/10/12 17:00 @Description: */
public class TimedCacheUtils {
  private static final TimedCache<String, String> TIMED_CACHE = CacheUtil.newTimedCache(5000);
 
  static {
    /** 每5ms檢查一次過(guò)期 */
    TIMED_CACHE.schedulePrune(5);
  }
 
  /**
   * 存入鍵值對(duì)，提供消逝時(shí)間
   *
   * @param key
   * @param value
   * @param timeout
   */
  public static void put(String key, String value, Long timeout) {
    /** 設(shè)置消逝時(shí)間 */
    TIMED_CACHE.put(key, value, timeout);
  }
 
  /**
   * 每次重新get一次緩存，均會(huì)重新刷新消逝時(shí)間
   * @param key
   * @return
   */
  public static String get(String key) {
    return TIMED_CACHE.get(key);
  }
 
  public static void main(String[] args) {
    put("haha", "1", 3000L);
    ThreadUtil.sleep(2000);
    //    if (TIMED_CACHE.containsKey("haha")) {
    //      System.out.println("aa");
    //    }
    System.out.println("第1次結(jié)果:" + get("haha"));
    ThreadUtil.sleep(2000);
    System.out.println("第2次結(jié)果:" + get("haha"));
    ThreadUtil.sleep(5000);
    System.out.println("第3次結(jié)果:" + get("haha"));
    // 取消定時(shí)清理
    TIMED_CACHE.cancelPruneSchedule();
  }
}

首先我們看一下執(zhí)行的效果

說(shuō)明:

1、設(shè)置的超時(shí)時(shí)間為3000毫秒，所以第一次打印在2秒鐘，所以可以獲取到值。

2、因?yàn)榈谝淮未蛴≌{(diào)用了get方法，刷新了過(guò)期時(shí)間，所以依然可以獲取到值。

3、第三次打印在5秒后，所以已經(jīng)過(guò)期，無(wú)法獲取到值，打印null。

那么，需要知道是否緩存還在可以使用containsKey方法。如下：

    put("haha", "1", 3000L);
    ThreadUtil.sleep(2000);
    if (TIMED_CACHE.containsKey("haha")) {
      System.out.println("第1次結(jié)果:緩存存在");
    }
//    System.out.println("第1次結(jié)果:" + get("haha"));
    ThreadUtil.sleep(2000);
    System.out.println("第2次結(jié)果:" + get("haha"));
    ThreadUtil.sleep(5000);
    System.out.println("第3次結(jié)果:" + get("haha"));
    // 取消定時(shí)清理
    TIMED_CACHE.cancelPruneSchedule();

執(zhí)行結(jié)果如下:

工具優(yōu)化-監(jiān)聽(tīng)過(guò)期、增加回調(diào)

我們?cè)谑褂肨imedCache會(huì)發(fā)現(xiàn)，一旦緩存過(guò)期我們并不能立馬知道，很多工作場(chǎng)景中需要對(duì)緩存做監(jiān)聽(tīng)回調(diào)。所以我升級(jí)了一下該工具類。

import cn.hutool.cache.CacheUtil;
import cn.hutool.cache.impl.TimedCache;
import cn.hutool.core.thread.ThreadUtil;
import com.google.common.util.concurrent.*;
import org.checkerframework.checker.nullness.qual.Nullable;
 
import java.text.MessageFormat;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.function.Consumer;
 
/** @Author huyi @Date 2021/10/12 10:57 @Description: 時(shí)間緩存工具 */
public class TimedCacheUtils {
  private static final TimedCache<String, String> TIMED_CACHE = CacheUtil.newTimedCache(5000);
  /** 線程池 */
  private static final ExecutorService executorService = Executors.newCachedThreadPool();
 
  private static final ListeningExecutorService listeningExecutorService =
      MoreExecutors.listeningDecorator(executorService);
  /** 回調(diào)方法映射 */
  private static ConcurrentHashMap<String, Consumer<String>> callbackMap;
 
  /**
   * 存入鍵值對(duì)，添加過(guò)期時(shí)間，和消費(fèi)回調(diào)
   *
   * @param key
   * @param timeout
   * @param consumer
   */
  public static void put(String key, String value, Long timeout, Consumer<String> consumer) {
    TIMED_CACHE.put(key, value, timeout);
    addListen(key, consumer);
  }
 
  /**
   * 獲取緩存值
   *
   * @param key
   * @return
   */
  public static String get(String key) {
    return TIMED_CACHE.get(key);
  }
 
  /**
   * 刪除緩存和回調(diào)映射
   *
   * @param key
   */
  public static void remove(String key) {
    callbackMap.remove(key);
    TIMED_CACHE.remove(key);
  }
 
  /**
   * 添加監(jiān)聽(tīng)器
   *
   * @param key
   * @param consumer
   */
  public static void addListen(String key, Consumer<String> consumer) {
    ListenableFuture<String> listenableFuture =
        listeningExecutorService.submit(
            () -> {
              while (TIMED_CACHE.containsKey(key)) {
                ThreadUtil.sleep(500);
              }
              return key;
            });
    Futures.addCallback(
        listenableFuture,
        new FutureCallback<String>() {
          @Override
          public void onSuccess(@Nullable String s) {
            consumer.accept(s);
          }
 
          @Override
          public void onFailure(Throwable throwable) {
            throwable.printStackTrace();
          }
        },
        listeningExecutorService);
  }
 
  public static void main(String[] args) {
    put("haha", "1", 3000L, x -> System.out.println(MessageFormat.format("[{0}] - 緩存消逝", x)));
    ThreadUtil.sleep(2000);
    System.out.println(get("haha"));
    ThreadUtil.sleep(2000);
    System.out.println(get("haha"));
    ThreadUtil.sleep(5000);
    System.out.println(get("haha"));
    // 關(guān)閉監(jiān)聽(tīng)線程池
    listeningExecutorService.shutdown();
  }
}

執(zhí)行結(jié)果: