SpringBoot缓存机制与实战-优快云博客

本文链接：https://blog.youkuaiyun.com/try_try_try/article/details/80666185

本文介绍了Spring的缓存抽象，包括CacheManager接口和Cache接口的使用，以及SpringBoot中基于注解的缓存配置和操作。详细阐述了@Cacheable、@CacheEvict、@CachePut和@Caching等注解的含义和应用，并展示了SpringBoot默认配置和如何通过@Cacheable注解在Service中实现缓存。此外，还讨论了如何在SpringBoot中切换到EhCache作为缓存管理系统。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一.Spring的缓存抽象

1.简介

Spring从3.1开始定义了org.springframework.cache.Cache和org.springframework.cache.CacheManager接口来统一不同的缓存技术；并支持使用JCache（JSR-107）注解简化我们开发。

CacheManager是Spring提供的各种缓存技术抽象接口;

Cache接口为缓存的组件规范定义，包含缓存的各种操作集合；Cache接口下Spring提供了各种xxxCache的实现；如RedisCache，EhCacheCache , ConcurrentMapCache等。

2.主要注解

`1. @Cacheable`，方法级注解，它指定了被注解方法的返回值是可以被缓存的。

其工作原理是Spring首先会在缓存中查找数据，如果有数据，可以不执行该方法，直接返回远程数据；如果没有则执行方法并缓存结果，然后返回数据。

@Cacheable(cacheNames = {"emp"},key="#id",/*"keyGenerator = "myKeyGenerator"*/,
condition = "#a0>2",unless ="#id==2")
    public Employee getEmp(Integer id){
        System.out.println("查询"+id+"号员工");
        Employee emp = employeeMapper.getEmpById(id);
        return emp;
    }

@Cacheable的常用属性：

缓存名称：必须指定一个。
       @Cacheable("emp")
       @Cacheable(value="emp")
       @Cacheable(cacheNames = {"emp1"，"emp2"})
       @Cacheable(cacheNames="emp")
key：缓存数据使用的key，默认是使用方法参数的值。

1.缓存本质上就是键值对，key是使用keyGenerator生成的，默认使用SimpleKeyGenerator生成key；

SimpleKeyGenerator生成key的默认策略如下：

 如果没有参数；key=new SimpleKey()；
 如果有一个参数：key=参数的值
 如果有多个参数：key=new SimpleKey(params)；

 2.除了自动的生成策略，还可以根据实际需要自定义缓存的键，主要实现方式是通过 SqEL表达式。

 3.除通过 key 属性自定义键，还可以通过 keyGenerator 来指定一个 KeyGenerator（key的生成器）。

 4.注意key/keyGenerator：二选一使用;

cacheManager：指定缓存管理器；或者cacheResolver指定获取解析器,二者选其一；

condition：指定符合条件的情况下才缓存；
condition = "#a0>1"：第一个参数的值>1的时候才进行缓存;

unless:否定缓存；当unless指定的条件为true，方法的返回值就不会被缓存；
unless = "#a0==2":如果第一个参数的值等于2，结果不缓存；
sync：是否使用异步模式

`2.@CachePut`，方法级注解，更新缓存，并且会将方法的返回值放进缓存中。[先调用方法，再更新缓存]

@CachePut和@Cacheable的属性一致;

与@Cacheable 不同，它每次都会触发真实方法的调用;

需要注意的是在同一个方法上同时使用 @CachePut、@Cacheable 将产生不确定的行为，千万不要这么做。

`3.@CacheEvict`，方法级注解，将一条或者多条数据从缓存中删除.

主要属性：value、key、condition、allEntries、beforeInvocation    

allEntries：是否清空所有缓存内容，缺省为 false，如果指定为 true，则方法调用后将立即清空所有缓存；

beforeInvocation：是否在方法执行前就清空，缺省为 false，如果指定为 true，则在方法还没有执行的时候就清空缓存，
缺省情况下，如果方法执行抛出异常，则不会清空缓存    ；

`4.Caching`，方法级注解，组注解，可以通过@Caching注解组合多个注解策略在同一个方法上.

@Caching 是一个组注解，可以为一个方法定义提供基于@Cacheable、@CacheEvict或者@CachePut注解的数组。

`5.@CacheConfig`，类级别的全局缓存注解，抽取缓存的公共配置。

Spring4.0之前并没有类级别的全局缓存注解。

如果在一个类的所有方法的缓存上需要使用相同的缓存名字、自定义的 KeyGenerator、
或自定义的 CacheManager，甚至是自定义的 CacheResolver，那么可以通过在类上使用 @CacheConfig 来完成。

二.SpringBoot缓存使用-基于注解

默认的配置类：SimpleCacheConfiguration
默认的CacheManager：ConcurrentMapCacheManager

1.数据准备：本示例默认这些操作已完成，专注于缓存的实现

数据库建表以及数据库配置
JavaBean封装
整合MyBatis操作数据库（包括Mapper、controller的实现）

2.引入依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-cache</artifactId>
</dependency>

3.在启动类开启基于注解的缓存：@EnableCaching

@MapperScan("com.springboot.cache.mapper")
@SpringBootApplication
@EnableCaching
public class SpringbootCacheExamApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringbootCacheExamApplication.class, args);
    }
}

4.在service中使用缓存

@Service
public class EmployeeService {

    @Autowired
    EmployeeMapper employeeMapper;

    //key默认为参数
    @Cacheable(value="emp")
    public Employee getEmp(Integer id){
        Employee emp = employeeMapper.getEmpById(id);
        System.out.println(emp);
        return emp;
    }

    //@CachePut要达到同步更新缓存的目的，则要保证取缓存的key，和存缓存的key要相同。
    @CachePut(value = "emp",key = "#result.id")
        public Employee updateEmp(Employee employee){
            System.out.println("updateEmp:"+employee);
            employeeMapper.updateEmp(employee);
            return employee;
        }
      }

    @Caching(
            cacheable = {
                @Cacheable(value="emp",key = "#lastName")
            },
            put = {
                @CachePut(value="emp",key = "#result.id"),
            }
       )
    public Employee getEmpByLastName(String lastName){
        return employeeMapper.getEmpByLastName(lastName);
    }

5.测试

第一次访问：http://localhost:8080/emp/1,查询id=1的员工，控制台打印SQL，并输出Employee；

这里写图片描述

再次访问：http://localhost:8080/emp/1,可查出员工信息，但是控制台无输出，可见第二次是从缓存中取得。

6.SpringBoot整合Mybatis如何在控制台打印SQL？

//application.yml
方法一：
mybatis: 
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl 

方法二：
#com.springboot.cache.mapper是你的mapper文件所在包路径
logging:
  level:
    com.springboot.cache.mapper: debug

三.SpringBoot切换缓存

切换为EhCache作为缓存

1.在pom.xml文件中引入依赖

<dependency>
     <groupId>net.sf.ehcache</groupId>
     <artifactId>ehcache</artifactId>
</dependency>

2.在src/main/resources目录下创建：ehcache.xml，框架只要发现该文件，就会创建EhCache的缓存管理器。

<ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="ehcache.xsd">

    <cache name="userAutoId"
           maxElementsInMemory="10000"
           eternal="false"
           overflowToDisk="false"
           memoryStoreEvictionPolicy="LRU"
           timeToLiveSeconds="36000">
    </cache>

</ehcache>