java缓存Guava Cache用法介绍

tiger_angel

已于 2022-08-23 19:12:49 修改

阅读量2.2k

点赞数 1

分类专栏： java工具笔记文章标签：缓存 guava

于 2022-08-23 17:19:52 首次发布

本文链接：https://blog.csdn.net/qq_38567039/article/details/126488902

版权

java工具笔记专栏收录该内容

94 篇文章 4 订阅

订阅专栏

一、背景

在日常开发中，有很多这种场合：有一些数据量不是很大，不会经常改动，并且访问非常频繁；但是，由于受限于硬盘IO的性能，或者远程网络等原因，获取可能非常耗时，导致我们的程序非常慢。这在某些业务上是不能忍的！缓存正是解决这类问题的神器！缓存的主要作用是：暂时在内存中保存业务系统的数据处理结果，等待下次访问使用。

Guava cache 属于集中式内存缓存。

Guava Cache 与 ConcurrentMap 很相似，但也不完全一样。最基本的区别是：ConcurrentMap 会一直保存所有添加的元素，直到显式地移除。相对地，Guava Cache 为了限制内存占用，通常都设定为自动回收元素。在某些场景下，尽管 LoadingCache 不回收元素，它也是很有用的，因为它会自动加载缓存。Guava Cache 是在内存中缓存数据，相比较于数据库或redis存储，访问内存中的数据会更加高效。

二、构建缓存对象

接口Cache代表一块缓存，它有如下方法：

public interface Cache<K, V> {
    V get(K key, Callable<? extends V> valueLoader) throws ExecutionException;
    ImmutableMap<K, V> getAllPresent(Iterable<?> keys);
    void put(K key, V value);
    void putAll(Map<? extends K, ? extends V> m);
    void invalidate(Object key);
    void invalidateAll(Iterable<?> keys);
    void invalidateAll();
    long size();
    CacheStats stats();
    ConcurrentMap<K, V> asMap();
    void cleanUp();
}

可以通过CacheBuilder类构建一个缓存对象，CacheBuilder类采用builder设计模式，它的每个方法都返回CacheBuilder本身，直到build方法被调用。构建一个缓存对象的代码如下：

public class StudyGuavaCache {
    public static void main(String[] args) {
        Cache<String,String> cache = CacheBuilder.newBuilder().build();
        cache.put("word","Hello Guava Cache");
        System.out.println(cache.getIfPresent("word"));
    }
}

上面的代码通过CacheBuilder.newBuilder().build()语句创建了一个Cache缓存对象，并在缓存对象中存储了key为word、value为Hello Guava Cache的一条记录。可以看到，Cache非常类似于JDK中的Map，但是相比于Map，Guava Cache提供了很多更强大的功能。

从LoadingCache查询的正规方式是使用get(K)方法。这个方法要么返回已经缓存的值，要么使用CacheLoader向缓存原子地加载新值（通过load(String key) 方法加载）。由于CacheLoader可能抛出异常，LoadingCache.get(K)也声明抛出ExecutionException异常。如果你定义的CacheLoader没有声明任何检查型异常，则可以通过getUnchecked(K)查找缓存。必须注意，一旦CacheLoader声明了检查型异常，就不可以调用getUnchecked(K)

三、设置最大存储

Guava Cache可以在构建缓存对象时指定缓存所能够存储的最大记录数量。当Cache中的记录数量达到最大值后，再调用put方法向其中添加对象，Guava会先从当前缓存的对象记录中选择一条删除掉，腾出空间后，再将新的对象存储到Cache中。

public class StudyGuavaCache {
    public static void main(String[] args) {
        Cache<String,String> cache = CacheBuilder.newBuilder()
                .maximumSize(2)
                .build();
        cache.put("key1","value1");
        cache.put("key2","value2");
        cache.put("key3","value3");
        System.out.println("第一个值：" + cache.getIfPresent("key1"));
        System.out.println("第二个值：" + cache.getIfPresent("key2"));
        System.out.println("第三个值：" + cache.getIfPresent("key3"));
    }
}

上面代码在构造缓存对象时，通过CacheBuilder类的maximumSize方法指定Cache最多可以存储2条数据，然后调用Cache的put方法向其中添加了3个对象。

四、设置过期时间

在构建Cache对象时，可以通过CacheBuilder类的expireAfterAccess和expireAfterWrite两个方法为缓存中的对象指定过期时间，使用CacheBuilder构建的缓存不会“自动”执行清理和逐出值，也不会在值到期后立即执行或逐出任何类型。相反，它在写入操作期间执行少量维护，或者在写入很少的情况下偶尔执行读取操作。其中，expireAfterWrite方法指定对象被写入到缓存后多久过期，expireAfterAccess方法指定对象多久没有被访问后过期。

下面代码是使用expireAfterWrite方法的例子。

public class StudyGuavaCache {
    public static void main(String[] args) throws InterruptedException {
        Cache<String,String> cache = CacheBuilder.newBuilder()
                .maximumSize(2)
                .expireAfterWrite(3,TimeUnit.SECONDS)
                .build();
        cache.put("key1","value1");
        int time = 1;
        while(true) {
            System.out.println("第" + time++ + "次取到key1的值为：" + cache.getIfPresent("key1"));
            Thread.sleep(1000);
        }
    }
}

上面的代码在构造Cache对象时，通过CacheBuilder的expireAfterWrite方法，指定“写入Cache中的对象”在3秒后会过期。在Cache对象中存储一条对象记录后，每隔1秒读取一次这条记录。

下面代码是使用expireAfterAccess方法的例子:

public class StudyGuavaCache {
    public static void main(String[] args) throws InterruptedException {
        Cache<String,String> cache = CacheBuilder.newBuilder()
                .maximumSize(2)
                .expireAfterAccess(3,TimeUnit.SECONDS)
                .build();
        cache.put("key1","value1");
        int time = 1;
        while(true) {
            Thread.sleep(time*1000);
            System.out.println("睡眠" + time++ + "秒后取到key1的值为：" + cache.getIfPresent("key1"));
        }
    }
}

通过CacheBuilder的expireAfterAccess方法，指定如果Cache中存储的对象超过3秒没有被访问，就会过期。while中的代码每sleep一段时间，就会访问一次Cache中存储的对象key1；每次访问key1之后，下次sleep的时间会加长一秒。

也可以同时用expireAfterAccess和expireAfterWrite方法指定过期时间，这时只要对象满足两者中的一个条件，就会被自动过期删除。

Guava Cache缓存过期后，不一定会立马被清理，一般会在Cache整体被读取一定次数后清理。这中策略对性能是有好处的，如果想强制清理，可以手动调用`Cache.cleanup()`或者使用`ScheduledExecutorService`来完成定期清理。

五、弱引用

通过weakKeys和weakValues方法，可以指定Cache只保存“对缓存记录key和value的弱引用”。这样，当没有其他强引用指向key和value时，key和value对象就会被垃圾回收器回收。

public class StudyGuavaCache {
    public static void main(String[] args) throws InterruptedException {
        Cache<String,Object> cache = CacheBuilder.newBuilder()
                .maximumSize(2)
                .weakValues()
                .build();
        Object value = new Object();
        cache.put("key1",value);
        value = new Object();//原对象不再有强引用
        System.gc();
        System.out.println(cache.getIfPresent("key1"));
    }
}

上面代码的输出结果是null。构建Cache时，通过weakValues方法指定Cache只保存记录值的一个弱引用。当给value引用赋值一个新的对象之后，就不再有任何一个强引用指向原对象。System.gc()触发垃圾回收后，原对象就被清除了。

六、显示清除缓存

调用Cache的invalidateAll或invalidate方法，可以显示删除Cache中的记录。invalidate方法一次只能删除Cache中一个记录，接收的参数是要删除记录的key。invalidateAll方法可以批量删除Cache中的记录；当没有传任何参数时，invalidateAll方法将清除Cache中的全部记录。invalidateAll也可以接收一个Iterable类型的参数，参数中包含要删除记录的所有key值。下面代码对此做了示例。

public class StudyGuavaCache {
    public static void main(String[] args) throws InterruptedException {
        Cache<String,String> cache = CacheBuilder.newBuilder().build();
        Object value = new Object();
        cache.put("key1","value1");
        cache.put("key2","value2");
        cache.put("key3","value3");
        List<String> list = new ArrayList<String>();
        list.add("key1");
        list.add("key2");
        cache.invalidateAll(list);  //批量清除list中全部key对应的记录
        System.out.println(cache.getIfPresent("key1"));
        System.out.println(cache.getIfPresent("key2"));
        System.out.println(cache.getIfPresent("key3"));
    }
}

可以看出，代码中构造了一个集合list用于保存要删除记录的key值，然后调用invalidateAll方法批量删除key1和key2对应的记录，只剩下key3对应的记录没有被删除。

七、移除动作监听器

可以为Cache对象添加一个移除监听器。这样，当有记录被删除时，可以感知到这个事件。

下面代码是使用移除动作监听器的示例。

public class StudyGuavaCache {
    public static void main(String[] args) throws InterruptedException {
        RemovalListener<String, String> listener = new RemovalListener<String, String>() {
            public void onRemoval(RemovalNotification<String, String> notification) {
                System.out.println("[" + notification.getKey() + ":" + notification.getValue() + "] is removed!");
            }
        };
        Cache<String,String> cache = CacheBuilder.newBuilder()
                .maximumSize(3)
                .removalListener(listener)
                .build();
        Object value = new Object();
        cache.put("key1","value1");
        cache.put("key2","value2");
        cache.put("key3","value3");
        cache.put("key4","value3");
        cache.put("key5","value3");
        cache.put("key6","value3");
        cache.put("key7","value3");
        cache.put("key8","value3");
    }
//这个存在问题,当内存数据清理掉时候,不会触发-见https://blog.csdn.net/qq_21383435/article/details/108835568?spm=1001.2101.3001.6661.1&utm_medium=distribute.pc_relevant_t0.none-task-blog-2%7Edefault%7ECTRLIST%7EPayColumn-1-108835568-blog-84993988.pc_relevant_default&depth_1-utm_source=distribute.pc_relevant_t0.none-task-blog-2%7Edefault%7ECTRLIST%7EPayColumn-1-108835568-blog-84993988.pc_relevant_default&utm_relevant_index=1

}

emovalListener方法为Cache指定了一个移除监听器，当有记录从Cache中被删除时，监听器listener就会感知到这个事件。

这个存在问题,当内存数据清理掉时候,RemovalListener不会触发-见https://blog.csdn.net/qq_21383435/article/details/108835568?spm=1001.2101.3001.6661.1&utm_medium=distribute.pc_relevant_t0.none-task-blog-2%7Edefault%7ECTRLIST%7EPayColumn-1-108835568-blog-84993988.pc_relevant_default&depth_1-utm_source=distribute.pc_relevant_t0.none-task-blog-2%7Edefault%7ECTRLIST%7EPayColumn-1-108835568-blog-84993988.pc_relevant_default&utm_relevant_index=1

需要和来一起使用,才能触发

cache.cleanUp();

八、自动加载

Cache的get方法有两个参数，第一个参数是从Cache中获取记录的key，第二个记录是一个Callable对象。当缓存中已经存在key对应的记录时，get方法直接返回key对应的记录。如果缓存中不包含key对应的记录，Guava会启动一个线程执行Callable对象中的call方法，call方法的返回值会作为“key对应的值”被存储到缓存中，并且被get方法返回。

下面是一个多线程使用Cache自动加载的例子：

public class StudyGuavaCache {
    private static Cache<String,String> cache = CacheBuilder.newBuilder()
            .maximumSize(3)
            .build();
    public static void main(String[] args) throws InterruptedException {
        new Thread(new Runnable() {
            public void run() {
                System.out.println("thread1");
                try {
                    String value = cache.get("key", new Callable<String>() {
                        public String call() throws Exception {
                            System.out.println("load1"); //加载数据线程执行标志
                            Thread.sleep(1000); //模拟加载时间
                            return "auto load by Callable";
                        }
                    });
                    System.out.println("thread1 " + value);
                } catch (ExecutionException e) {
                    e.printStackTrace();
                }
            }
        }).start();
        new Thread(new Runnable() {
            public void run() {
                System.out.println("thread2");
                try {
                    String value = cache.get("key", new Callable<String>() {
                        public String call() throws Exception {
                            System.out.println("load2"); //加载数据线程执行标志
                            Thread.sleep(1000); //模拟加载时间
                            return "auto load by Callable";
                        }
                    });
                    System.out.println("thread2 " + value);
                } catch (ExecutionException e) {
                    e.printStackTrace();
                }
            }
        }).start();
    }
}

这段代码中，有两个线程共享同一个Cache对象，两个线程同时调用get方法获取同一个key对应的值。由于key对应的值不存在，所以两个线程都在get方法处阻塞。此处在call方法中调用Thread.sleep(1000)，模拟程序从外存加载数据的时间消耗。

虽然是两个线程同时调用get方法，但只有一个get方法中的Callable会被执行(没有打印出load2)。Guava可以保证当有多个线程同时访问Cache中的一个key时，如果key对应的记录不存在，Guava只会启动一个线程执行get方法中Callable参数对应的任务，加载数据存到缓存。当加载完数据后，任何线程中的get方法都会获取到key对应的值。

九、统计信息

可以对Cache的命中率、加载数据时间等信息进行统计。在构建Cache对象时，通过CacheBuilder的recordStats方法，可以开启统计信息的开关。开关开启后，Cache会自动对缓存的各种操作进行统计，调用Cache的stats方法可以查看统计后的信息。

下面代码是使用Cache统计信息的示例。

public class StudyGuavaCache {
    public static void main(String[] args) throws InterruptedException {
        Cache<String,String> cache = CacheBuilder.newBuilder()
                .maximumSize(3)
                .recordStats() //开启统计信息开关
                .build();
        cache.put("key1","value1");
        cache.put("key2","value2");
        cache.put("key3","value3");
        cache.put("key4","value4");
        cache.getIfPresent("key1");
        cache.getIfPresent("key2");
        cache.getIfPresent("key3");
        cache.getIfPresent("key4");
        cache.getIfPresent("key5");
        cache.getIfPresent("key6");
        System.out.println(cache.stats()); //获取统计信息
    }
}

十、LoadingCache

LoadingCache是Cache的子接口，相比较于Cache，当从LoadingCache中读取一个指定key的记录时，如果该记录不存在，则LoadingCache可以自动执行加载数据到缓存的操作。LoadingCache接口的定义如下：

public interface LoadingCache<K, V> extends Cache<K, V>, Function<K, V> {
    V get(K key) throws ExecutionException;
    V getUnchecked(K key);
    ImmutableMap<K, V> getAll(Iterable<? extends K> keys) throws ExecutionException;
    V apply(K key);
    void refresh(K key);
    @Override
    ConcurrentMap<K, V> asMap();
}

与构建Cache类型的对象类似，LoadingCache类型的对象也是通过CacheBuilder进行构建。不同的是，在调用CacheBuilder的build方法时，必须传递一个CacheLoader类型的参数，CacheLoader的load方法需要我们提供具体实现。当调用LoadingCache的get方法时，如果缓存不存在对应key的记录，则CacheLoader中的load方法会被自动调用从外存加载数据，“load方法的返回值”会作为“key对应的value”存储到LoadingCache中，并从get方法返回。

下面代码是使用LoadingCache统计信息的示例。

public class StudyGuavaCache {
    public static void main(String[] args) throws ExecutionException {
        CacheLoader<String, String> loader = new CacheLoader<String, String> () {
            public String load(String key) throws Exception {
                Thread.sleep(1000); //休眠1s，模拟加载数据
                System.out.println(key + " is loaded from a cacheLoader!");
                return key + "'s value";
            }
        };
        LoadingCache<String,String> loadingCache = CacheBuilder.newBuilder()
                .maximumSize(3)
                .build(loader);//在构建时指定自动加载器
        loadingCache.get("key1");
        loadingCache.get("key2");
        loadingCache.get("key3");
    }
}

tiger_angel

关注

1
点赞
踩
6

收藏

觉得还不错? 一键收藏
0
评论
java缓存Guava Cache用法介绍

在日常开发中，有很多这种场合：有一些数据量不是很大，不会经常改动，并且访问非常频繁；但是，由于受限于硬盘IO的性能，或者远程网络等原因，获取可能非常耗时，导致我们的程序非常慢。这在某些业务上是不能忍的！缓存正是解决这类问题的神器！缓存的主要作用是：暂时在内存中保存业务系统的数据处理结果，等待下次访问使用。Guava cache 属于集中式内存缓存。Guava Cache 与 ConcurrentMap 很相似，但也不完全一样。
复制链接

扫一扫