SpringBoot 缓存 Caffeine使用解析

目录

• Redis和Caffeine的区别
• 相同点
• 不同点
• 联系
• Spring Boot 缓存 Caffeine使用
• 1.需要添加的依赖
• 2.配置
• 3.使用Caffeine缓存
• Caffeine其他常用注解
• 手动添加、获取、删除缓存
• 1.从缓存中获取数据
• 2.向缓存中添加数据
• 3.删除缓存中的数据

Redis和Caffeine的区别

相同点

• 两个都是缓存的方式

不同点

• redis是分布式缓存，通过网络将数据存储到redis服务器内存里
• caffeine是将数据存储在本地应用里
• caffeine和redis相比，没有了网络IO上的消耗

联系

• 一般将两者结合起来，形成一二级缓存。
• 使用流程大致如下：
• 先去一级缓存中查找数据（caffeine-本地应用内），
• 如果没有的话，去二级缓存中查找数据（redis-内存），
• 再没有，再去数据库中查找数据（数据库-磁盘）

Spring Boot 缓存 Caffeine使用

1.需要添加的依赖

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-cache</artifactId>
        </dependency>
        <dependency>
            <groupId>com.github.ben-manes.caffeine</groupId>
            <artifactId>caffeine</artifactId>
            <version>2.8.6</version>
        </dependency>

2.配置

在SpringBoot中配置Caffeine，控制缓存行为（例如过期时间，缓存大小限制等）

import com.github.benmanes.caffeine.cache.Caffeine;
import org.springframework.cache.CacheManager;
import org.springframework.cache.annotation.EnableCaching;
import org.springframework.cache.caffeine.CaffeineCacheManager;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import java.util.concurrent.TimeUnit;
@Configuration
@EnableCaching //开启缓存
public class CaffeinConfig {
    @Bean
    //配置Caffeine缓存行为（例如到期，缓存大小限制等）
    public Caffeine caffeineConfig() {
        Caffeine caffeine = Caffeine.newBuilder()
                .expireAfterWrite(60, TimeUnit.MINUTES)
                .maximumSize(1000);
        return caffeine;
    }
    @Bean
    public CacheManager cacheManager(Caffeine caffeine) {
        CaffeineCacheManager caffeineCacheManager = new CaffeineCacheManager();
        caffeineCacheManager.setCaffeine(caffeine);
        return caffeineCacheManager;
    }
}

Caffeine配置说明：

initialCapacity=[integer]：初始的缓存空间大小

maximumSize=[long]：缓存的最大条数

maximumWeight=[long]：缓存的最大权重

expireAfterAccess=[duration]：最后一次写入或访问后经过固定时间过期

expireAfterWrite=[duration]：最后一次写入后经过固定时间过期

refreshAfterWrite=[duration]：创建缓存或者最近一次更新缓存后经过固定的时间间隔，刷新缓存

recordStats：开发统计功能

注意：

expireAfterWrite和expireAfterAccess同时存在时，以expireAfterWrite为准。

maximumSize和maximumWeight不可以同时使用

3.使用Caffeine缓存

示例1：

使用 @Cacheable(cacheNames = “xxx”) 或 @Cacheable(value = “xxx”) 注解在方法上。

 @Cacheable(value = "caffeinSet_Value")
    public String caffeinSetValue(Integer number) {
        String str = number % 2 == 0 ? number + "是偶数" : number + "是奇数";
        return str;
    }

说明： 每次执行方法 caffeinSetValue 时，会先去 caffeinSet_Value 缓存里根据传入的 number 查找有没有匹配的缓存，有则直接返回结果；没有则执行方法，执行完后将结果加入缓存里，下次如果匹配直接返回。

示例2：

当有多个参数时，@Cacheable 注解里可以使用 key 来选择参数进行判断缓存是否存在。可以使用 condition 来进行条件筛选，只有满足条件的才会加入缓存。

    /**
     * number为偶数时才会缓存，缓存的key是传入的number值
     */
    @Cacheable(value = "caffeinSet_Value", key = "#number", condition = "#number%2==0")
    public String caffeinSetValue(Integer number,String st) {
        String str = number % 2 == 0 ? number + "是偶数" : number + "是奇数";
        return str+st;
    }

说明： 假如传入的参数 number 是2，首先判断 caffeinSet_Value 缓存里有没有 key 是2的，有则直接回结果。没有则执行方法，因为满足 condition 的条件则最后将结果加入缓存。

假如传入的参数 number 是奇数，则每次都会执行方法，因为不满足 condition ，不会被加入缓存。

示例3：

 @Cacheable(value = "caffeinSet_Value", key = "#student.name", condition = "#student.age>10")
    public Student caffeinSetValue(Student student,Integer number) {
        System.out.println(11111);
        return student;
    }

说明： 根据student对象里的name去caffeinSetValue缓存里查找。只有student对象里的age大于10的时候才会缓存结果。

注意：

一个方法A调同一个类里的另一个有缓存注解的方法B，这样是不走缓存的。

例如在同一个CaffeinConsumer 类里面 invalidCache 调用 caffeinSetValue，是不走缓存的，缓存是不生效的；

@Service
public class CaffeinConsumer {
    public String invalidCache(Integer number,String st) {
        String str = caffeinSetValue(number,st);
        return str;
    }

    /**
     * number为偶数时才会缓存，缓存的key是传入的number值
     */
    @Cacheable(value = "caffeinSet_Value", key = "#number", condition = "#number%2==0")
    public String caffeinSetValue(Integer number,String st) {
        String str = number % 2 == 0 ? number + "是偶数" : number + "是奇数";
        return str+st;
    }
}

解决方案：

1.不使用注解的方式，直接取 Ehcache 的 CacheManger 对象，把需要缓存的数据放到里面，类似于使用 Map，缓存的逻辑自己控制；或者可以使用redis的缓存方式去添加缓存；

2.把方法A和方法B放到两个不同的类里面，例如：如果两个方法都在同一个service接口里，把方法B放到另一个service里面，这样在A方法里调B方法，就可以使用B方法的缓存。

Caffeine其他常用注解

1.@CachePut：

被@CachePut标注的方法在执行前不会去检查缓存中是否存在之前执行过的结果，而是每次都会执行该方法，并将执行结果以键值对的形式存入指定的缓存中。

2.@CacheEvict：

@CacheEvict是用来标注在需要清除缓存元素的方法或类上的。当标记在一个类上时表示其中所有的方法的执行都会触发缓存的清除操作。

@CacheEvict可以指定的属性有value、key、condition、allEntries和beforeInvocation。其中value、key和condition的语义与@Cacheable对应的属性类似。

即value表示清除操作是发生在哪些Cache上的（对应Cache的名称）；key表示需要清除的是哪个key，如未指定则会使用默认策略生成的key；condition表示清除操作发生的条件。如果要清除所有缓存可使用属性 allEntries=true

手动添加、获取、删除缓存

上面的一些示例通过注解来进行缓存操作，有时候我们需要在一些方法里对缓存进行操作增删改查：

1.从缓存中获取数据

假设上面示例2中向名为 “caffeinSet_Value”的缓存里加入的键是8，值是"8是偶数!!"。

下面手动获取此缓存：

    @Autowired
    CacheManager cacheManager;
 public String caffeinGetValue() {
        Cache cache = cacheManager.getCache("caffeinSet_Value");
        //获取缓存名称。name为caffeinSetValue
        String name = cache.getName();
        //获取caffeinSetValue缓存里建是8的缓存
        Cache.ValueWrapper value = cache.get(8);
        String str ="";
        if (null != value) {
            //获取值，8是偶数!!
             str = String.valueOf(value.get());
        }
        return str;
    }

2.向缓存中添加数据

    @Autowired
    CacheManager cacheManager;
    public String caffeinPutValue() {
        Cache cache = cacheManager.getCache("caffeinSet_Value");
        //获取缓存名称。name为caffeinSetValue
        String name = cache.getName();
        /*
        //向缓存中put数据。如果不存在key是20的才会加入
  cache.putIfAbsent(number, "添加测试");
  */
        //向缓存中put数据。如果存在key是20的会覆盖原来的数据
        cache.put(20,"20是偶数！！");
        return "成功";
    }

3.删除缓存中的数据

删除caffeinSet_Value缓存中的某条缓存：

    @Autowired
    CacheManager cacheManager;
 public String caffeinDeleteValue() {
        Cache cache = cacheManager.getCache("caffeinSet_Value");
        //获取缓存名称。name为caffeinSetValue
        String name = cache.getName();
        //只有20这条数据存在才会删除
        boolean bo = cache.evictIfPresent(20);
        return String.valueOf(bo);
    }

删除caffeinSet_Value缓存中的所有缓存：

    @Autowired
    CacheManager cacheManager;
 public String caffeinDeleteAllValue() {
        Cache cache = cacheManager.getCache("caffeinSet_Value");
        //获取缓存名称。name为caffeinSetValue
        String name = cache.getName();
        //删除caffeinSet_Value中的所有缓存
        boolean bo = cache.invalidate();
        return String.valueOf(bo);
    }

以上为个人经验，希望能给大家一个参考，也希望大家多多支持我们。