Guava Cache 缓存数据被移除后的监听器RemovalListener

最新推荐文章于 2025-10-18 19:36:13 发布
原创 最新推荐文章于 2025-10-18 19:36:13 发布 · 1.6w 阅读 · 7 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#guava cache监听 #RemovalListener使用

Guava Cache的RemovalListener允许在数据被移除时接收通知，便于进行额外处理。当使用invalidate()清除缓存时，注册的监听器会被触发，RemovalNotification携带key、value和移除原因。默认情况下，监听器同步执行可能导致调用者线程阻塞。为避免这种情况，可以使用异步监听器RemovalListeners.asynchronous()来提高效率。

之前文章已经介绍了guava的容量管理，有4种方式可以将数据从缓存中移除。有的时候，我们需要在缓存被移除的时候，得到这个通知，并做一些额外处理工作。这个时候RemovalListener就派上用场了。

public class Main {

	// 创建一个监听器
	private static class MyRemovalListener implements RemovalListener<Integer, Integer> {
	@Override
	public void onRemoval(RemovalNotification<Integer, Integer> notification) {
		String tips = String.format("key=%s,value=%s,reason=%s", notification.getKey(), notification.getValue(), notification.getCause());
		System.out.println(tips);
	}
	}

	public static void main(String[] args) {

	// 创建一个带有RemovalListener监听的缓存
	Cache<Integer, Integer> cache = CacheBuilder.newBuilder().removalListener(new MyRemovalListener()).build();

	cache.put(1, 1);

	// 手动清除
	cache.invalidate(1);

	System.out.println(cache.getIfPresent(1)); // null
	}

}


使用invalidate()清除缓存数据之后，注册的回调被触发了。



RemovalNotification中包含了缓存的key、value以及被移除的原因RemovalCause。通过源码可以看出，移除原因与容量管理方式是相对应的。

public enum RemovalCause {
  /**
   * The entry was manually removed by the user. This can result from the user invoking
   * {@link Cache#invalidate}, {@link Cache#invalidateAll(Iterable)}, {@link Cache#invalidateAll()},
   * {@link Map#remove}, {@link ConcurrentMap#remove}, or {@link Iterator#remove}.
   */
  EXPLICIT {
    @Override
    boolean wasEvicted() {
      return false;
    }
  },

  /**
   * The entry itself was not actually removed, but its value was replaced by the user. This can
   * result from the user invoking {@link Cache#put}, {@link LoadingCache#refresh}, {@link Map#put},
   * {@link Map#putAll}, {@link ConcurrentMap#replace(Object, Object)}, or
   * {@link ConcurrentMap#replace(Object, Object, Object)}.
   */
  REPLACED {
    @Override
    boolean wasEvicted() {
      return false;
    }
  },

  /**
   * The entry was removed automatically because its key or value was garbage-collected. This
   * can occur when using {@link CacheBuilder#weakKeys}, {@link CacheBuilder#weakValues}, or
   * {@link CacheBuilder#softValues}.
   */
  COLLECTED {
    @Override
    boolean wasEvicted() {
      return true;
    }
  },

  /**
   * The entry's expiration timestamp has passed. This can occur when using
   * {@link CacheBuilder#expireAfterWrite} or {@link CacheBuilder#expireAfterAccess}.
   */
  EXPIRED {
    @Override
    boolean wasEvicted() {
      return true;
    }
  },

  /**
   * The entry was evicted due to size constraints. This can occur when using
   * {@link CacheBuilder#maximumSize} or {@link CacheBuilder#maximumWeight}.
   */
  SIZE {
    @Override
    boolean wasEvicted() {
      return true;
    }
  };

  /**
   * Returns {@code true} if there was an automatic removal due to eviction (the cause is neither
   * {@link #EXPLICIT} nor {@link #REPLACED}).
   */
  abstract boolean wasEvicted();
}

监听器使用很简单，有几个特点需要注意下：

1、默认情况下，监听器方法是被同步调用的（在移除缓存的那个线程中执行）。如果监听器方法比较耗时，会导致调用者线程阻塞时间变长。下面这段代码，由于监听器执行需要2s，所以main线程调用invalidate()要2s后才能返回。

public class Main {

    // 创建一个监听器
    private static class MyRemovalListener implements RemovalListener<Integer, Integer> {
        @Override
        public void onRemoval(RemovalNotification<Integer, Integer> notification) {
            String tips = String.format("key=%s,value=%s,reason=%s", notification.getKey(), notification.getValue(), notification.getCause());
            System.out.println(tips);

            try {
                // 模拟耗时
                Thread.sleep(2000);
            } catch (InterruptedException e) {
                e.printStackTrace();
            }

        }
    }

    public static void main(String[] args) {

        // 创建一个带有RemovalListener监听的缓存
        final Cache<Integer, Integer> cache = CacheBuilder.newBuilder().removalListener(new MyRemovalListener()).build();
        cache.put(1, 1);
        cache.put(2, 2);

        System.out.println("main...begin.");
        cache.invalidate(1);// 耗时2s
        System.out.println("main...over.");
    }

}

解决这个问题的方法是：使用异步监听RemovalListeners.asynchronous(RemovalListener, Executor)。

public class Main {

    // 创建一个监听器
    private static class MyRemovalListener implements RemovalListener<Integer, Integer> {
        @Override
        public void onRemoval(RemovalNotification<Integer, Integer> notification) {
            String tips = String.format("key=%s,value=%s,reason=%s", notification.getKey(), notification.getValue(), notification.getCause());
            System.out.println(tips);

            try {
                // 模拟耗时
                Thread.sleep(2000);
            } catch (InterruptedException e) {
                e.printStackTrace();
            }

        }
    }

    public static void main(String[] args) {

        RemovalListener<Integer, Integer> async = RemovalListeners.asynchronous(new MyRemovalListener(), Executors.newSingleThreadExecutor());
        // 创建一个带有RemovalListener监听的缓存
        final Cache<Integer, Integer> cache = CacheBuilder.newBuilder().removalListener(async).build();
        cache.put(1, 1);
        cache.put(2, 2);

        System.out.println("main...begin.");
        cache.invalidate(1);// main线程立刻返回
        System.out.println("main...over.");
    }

}


2、创建cache的时候只能添加1个监听器，这个监听器对象会被多个线程共享，所以如果监听器需要操作共享资源，那么一定要做好同步控制。下面这段代码可以看出：2个线程会交替执行监听器的发方法。 

public class Main {

    // 创建一个监听器
    private static class MyRemovalListener implements RemovalListener<Integer, Integer> {
        @Override
        public void onRemoval(RemovalNotification<Integer, Integer> notification) {
            String tips = String.format("key=%s,value=%s,reason=%s", notification.getKey(), notification.getValue(), notification.getCause());
            System.out.println(tips);

            try {
                // 模拟耗时
                Thread.sleep(2000);
            } catch (InterruptedException e) {
                e.printStackTrace();
            }

            System.out.println("process over.");
        }
    }

    public static void main(String[] args) {

        // 创建一个带有RemovalListener监听的缓存
        final Cache<Integer, Integer> cache = CacheBuilder.newBuilder().removalListener(new MyRemovalListener()).build();
        cache.put(1, 1);
        cache.put(2, 2);

        new Thread(new Runnable() {
            @Override
            public void run() {
                System.out.println("thread1...trigger RemovalListener begin.");
                cache.invalidate(1);
                System.out.println("thread1...trigger RemovalListener over.");
            }
        }).start();

        new Thread(new Runnable() {
            @Override
            public void run() {
                System.out.println("thread2...trigger RemovalListener begin.");
                cache.invalidate(2);
                System.out.println("thread2...trigger RemovalListener over.");
            }
        }).start();
    }

}



3、监听器中抛出的任何异常，在被记录到日志后，会被guava丢弃，不会导致监听器不可用。下面这段代码可以看到：监听器中抛出的异常只是被记录了(打印到了控制台)，并没有导致JVM退出，之后缓存被移除一样可以再次触发。
public class Main {

    // 创建一个监听器
    private static class MyRemovalListener implements RemovalListener<Integer, Integer> {
        @Override
        public void onRemoval(RemovalNotification<Integer, Integer> notification) {
            String tips = String.format("key=%s,value=%s,reason=%s", notification.getKey(), notification.getValue(), notification.getCause());
            System.out.println(tips);

            throw new RuntimeException();
        }
    }

    public static void main(String[] args) {

        // 创建一个带有RemovalListener监听的缓存
        final Cache<Integer, Integer> cache = CacheBuilder.newBuilder().removalListener(new MyRemovalListener()).build();
        cache.put(1, 1);
        cache.put(2, 2);

        cache.invalidate(1);
        cache.invalidate(2);
    }

}



【guava】GuavaCache缓存失效的时候做一些操作 RemovalListener
九师兄
09-27 4361
1.概述 转载:https://blog.youkuaiyun.com/chen_kkw/article/details/81144169 以为需要我使用guava缓存我的数据库连接，但是因为设置了1分钟失效就关闭，但是关闭的时候，我希望能做些操作，最好是关闭连接，代码如下 private static class MyRemovalListener implements RemovalListener<Integer, Integer> { @Override public voi
GuavaCache RemovalListener 失效
旧时光 | YoungChen's 博客
07-21 2872
问题 最近接触到 Google 的 Java 工具包 Guava，确实很好用，特别是其中的 GuavaCache 算是经常使用到的本地缓存，这次遇到一个需求是希望在 xxx min 之后做一个延时操作，虽然可以开一个定时任务做，但是由于当时代码里正好使用到了 GuavaCache，想起来可以基于 Key 的过期做一个回调方法不就行了嘛，猜测 GuavaCache 肯定是支持这样的回调 API 的...
Caffeine本地缓存学习
m0_46360888的博客
05-27 1859
caffeine
Guava Cache 原理分析与最佳实践
Java Punk
07-27 6656
本讲主要针对本地 Cache 的老大哥 Guava Cache 进行介绍和分析。
Guava Cache 使用详解
最新发布
油墨香^-^的博客
10-18 644
摘要：GuavaCache是Google提供的本地缓存解决方案，具有线程安全、高性能特性，支持自动加载、多种过期策略和容量控制。核心功能包括：通过CacheBuilder构建缓存，支持大小/时间/引用限制；提供Cache和LoadingCache两种接口；支持数据读写、刷新失效等操作。高级特性包含异步刷新、统计功能和移除监听器。实践案例展示了用户信息缓存、配置缓存等应用场景。性能优化建议合理设置缓存大小和过期策略。文章还探讨了缓存穿透/雪崩等问题的解决方案，并强调监控和测试的重要性。GuavaCache适合
Guava Cache实战—从场景使用到原理分析
python6_quanzhan的博客
11-18 1254
摘要：本文先介绍为什么使用 Guava Cache 缓存；然后讲解 Guava 缓存使用方法、清理方法及使用过程中踩过的坑；接着讲解其底层数据结构，分析其性能优异的原因；最后讲解在使用本地缓存时可以优化的方向。 为什么使用本地缓存 在多线程高并发场景中往往是离不开 cache 的，需要根据不同的应用场景来需要选择不同的 cache，比如分布式缓存如 Redis、memcached，还有本地（进程内）缓存如 ehcache、Guava Cache。缓存相比IO操作，速度快，效率高；Guava 相比 R.
Guava Cache 数据变化实现回调的监听器RemovalListener
zhangjikuan的专栏
07-30 9561
上一篇介绍了guava的使用，实现了项目第一个需求定期清理cache数据，第二个需求，我们需要在缓存被移除的时候，得到通知产生回调，并做一些额外处理工作。这个时候RemovalListener就派上用场了。 下面是获得所有数据改变的监听 [java] view plain copy public class Main {          // 创
Guava库学习：学习Guava Cache（七）RemovalListener（1）
weixin_34362790的博客
12-21 338
2019独角兽企业重金招聘Python工程师标准>>> ...
本地缓存之Guava Cache
PJ码匠人
03-26 1235
Guava cache是一个支持高并发的线程安全的本地缓存。多线程情况下也可以安全的访问或者更新Cache。这些都是借鉴了ConcurrentHashMap的结果。不过，guava cache 又有自己的特性当cache中不存在要查找的entry的时候，它会自动执行用户自定义的加载逻辑，加载成功后再将entry存入缓存并返回给用户未过期的entry，如果不存在或者已过期，则需要load。
Guava-Cache本地缓存案例代码
01-19
Guava Cache是Google Guava库中的一个强大特性，它提供了高效的本地缓存解决方案，用于存储经常访问的数据，以减少对远程服务或计算的调用，从而提高应用性能。本案例代码将详细介绍Guava Cache的使用，包括缓存的...
SpringBoot 整合 Guava Cache 实现本地缓存
sco5282的博客
09-07 3396
美团技术团队-缓存那些事是 Google 开发的 Guava 工具包中一套完善的JVM 本地缓存框架，底层实现的数据结构类似于，但是进行了更多的能力拓展，包括缓存过期时间设置、缓存容量设置、多种淘汰策略、缓存监控等。是一个支持高并发的线程安全的本地缓存。多线程情况下也可以安全的访问或者更新Cache。这些都是借鉴了支持最大容量限制支持两种过期删除策略（插入时间和读取时间）支持简单的统计功能基于 LRU 算法实现。
Guava Cache 高性能本地缓存库详解与使用案例
Lisonseekpan的博客
10-07 1168
Guava Cache 本地缓存库解析 核心特性 Guava Cache 是 Google 提供的 Java 本地缓存库，支持： 基于大小和时间的缓存驱逐策略 软引用/弱引用内存管理 缓存统计和性能监控 手动刷新与异步加载机制 缓存变更监听功能 典型应用场景 单体应用缓存：减少数据库访问压力 分布式系统二级缓存：与 Redis 配合使用 Spring Boot 集成：通过 Bean 配置快速接入 性能优化建议 设置随机过期时间避免缓存雪崩 监控命中率调整缓存策略 使用软引用优化内存管理 定期清理过期缓存项
本地缓存：Guava Cache
玉汝于成
01-07 604
Guava Cache与ConcurrentMap很相似，但也不完全一样。最基本的区别是ConcurrentMap会一直保存所有添加的元素，直到显式地移除。相对地，Guava Cache为了限制内存占用，通常都设定为自动回收元素。在某些场景下，尽管LoadingCache 不回收元素，它也是很有用的，因为它会自动加载缓存。例如当你需要多次访问一个计算或者查询加载耗时成本高时，你就可以考虑使用缓存。例如，计算或检索一个值的代价很高，并且对同样的输入需要不止一次获取值的时候，就应当考虑使用缓存。
Guava入门~RemovalListener
小强快跑~~
09-05 695
1.COLLECTED: key或value被垃圾回收；getCause()获取RemovalCause。5.SIZE:超过了最大限制数量。3.EXPLICIT:手动移除；4.REPLACED:被替换；2.EXPIRED:已过期；实现Map.Entry接口。
Guava1.2——GuavaCache的RemoveListener分析
xocupid的博客
06-22 655
put操作1.prewritevoid preWriteCleanup(long now)void runLockedCleanup(long now)void drainReferenceQueues()void expireEntries(long now)以上是准备工作，和get方法中的准备类似。2.postwritevoid postWriteCleanup()void runUnlockedCleanup();// 该方法会把removalNotificationQueue中的元素清楚掉，并调用o
Guava库学习：学习Guava Cache（七）RemovalListener（2）
weixin_33810006的博客
12-21 301
2019独角兽企业重金招聘Python工程师标准>>> ...
Guava Cache三种被动更新机制与过期监听器removalListener
yangchao2726的博客
02-21 2063
Guava Cache三种被动更新机制：expireAfterWrite与refreshAfterWrite的不同
Guava Cache Removal Listeners
zhixingheyi_tian的博客
11-28 288
You may specify a removal listener for your cache to perform some operation when an entry is removed, via CacheBuilder.removalListener(RemovalListener). The RemovalListener gets passed a RemovalNotifi...
Guava Cache 比较好的加入跟移除监听
06-26
在Guava Cache中，可以通过监听器（`RemovalListener`）来监控缓存元素的加入和移除操作。以下是一些实现元素加入和移除监听的最佳实践： 1. **使用RemovalListener处理缓存失效后的清理逻辑**：当某个缓存项因过期...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值