SpringCache使用详解

SpringCache

- - 1.新建测试项目SpringCache
  - 2.SpringCache整合redis
  - - 2.1.@Cacheable
    - 2.2.@CacheEvict
    - 2.3.@Cacheput
    - 2.4.@Caching
    - 2.5.@CacheConfig
  - 3.SpringCache问题
  - 4.SpringCache实现多级缓存

1.新建测试项目SpringCache

引入依赖

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
    </dependency>
    <!--Mysql数据库驱动-->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>
    <!-- MyBatis-->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.4.0</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

实体类

@Data
public class User {

    private Long id;
    private String name;
    private Integer age;

}

mapper

@Mapper
public interface UserMapper extends BaseMapper<User> {

}

application.yml

spring:
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/test?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
    username: root
    password: 123456
    driver-class-name: com.mysql.cj.jdbc.Driver
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

测试下没问题就搭建完成，开始springcache的测试

2.SpringCache整合redis

spring cache官方文档
spEl语法说明官方文档

下面是以redis为例，其他缓存也是下面这些步骤,一般来说要把cache抽出成一个类，下面为了测试方便直接在controller里做

1.引入依赖

<!-- redis -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

2.配置类

@EnableCaching //开启缓存
@Configuration
public class CacheConfig {

    @Bean
    public CacheManager redisCacheManager(RedisConnectionFactory factory) {
        // 配置序列化（解决乱码的问题）,过期时间600秒
        RedisCacheConfiguration config = RedisCacheConfiguration.defaultCacheConfig()
                //过期时间
                .entryTtl(Duration.ofSeconds(600))
                //缓存key
                .serializeKeysWith(RedisSerializationContext.SerializationPair.fromSerializer(new StringRedisSerializer()))
                //缓存组件value
                .serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(new GenericJackson2JsonRedisSerializer()))
                //value不为空,为空报错
                .disableCachingNullValues()
                .computePrefixWith(cacheName -> cacheName + ":");

        RedisCacheManager cacheManager = RedisCacheManager.builder(factory)
                .cacheDefaults(config)
                .build();
        return cacheManager;
    }
}

3.application.yml

spring:
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/test?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
    username: root
    password: 123456
    driver-class-name: com.mysql.cj.jdbc.Driver
  redis:
    host: 127.0.0.1
    port: 6379
    password: 123456
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

4.controller

@RestController
@CacheConfig(cacheNames = "user", cacheManager = "redisCacheManager")
public class UserController {
    @Autowired
    UserMapper userMapper;

    @GetMapping("/list")
    @Cacheable(key = "#root.method.name")
    public List<User> list() {
        return userMapper.selectList(null);
    }
}

5.访问http://localhost:8080/list测试，数据被缓存到redis中了

2.1.@Cacheable

@Cacheable：触发缓存填充。

注解属性

注解属性	作用
value / cacheNames	用于指定缓存的名称，可以指定一个或多个缓存名称
key	用于指定缓存的键，可以使用 SpEL 表达式
condition	用于指定一个条件，如果条件成立，则执行缓存
unless	用于指定一个条件，如果条件不成立，则执行缓存
keyGenerator	用于指定自定义的缓存键生成器
cacheManager	用于指定自定义的缓存管理器
sync	用于指定是否使用同步模式，当设置为 true 时，表示在方法执行时，阻塞其他请求，直到缓存更新完成

SpEL上下文数据

属性名称	描述	示例
methodName	正在调用的方法的名称	#root.methodName
method	正在调用的方法	#root.method.name
target	正在调用的目标对象	#root.target
targetClass	被调用目标的class	#root.targetClass
args	用于调用目标的参数	#root.args[0]
caches	当前被调用的方法使用的Cache	#root.caches[0].name
result	方法调用的结果	#result

/**
 * 生成的缓存：myCache:qwer  value："9999"
 * condition = "#param.length() > 3" 参数长度大于3进行缓存
 * unless = "#result == null"        结果等于null不进行缓存
 */
@GetMapping("/getCachedValue")
@Cacheable(value = "myCache", key = "#param", condition = "#param.length() > 3", unless = "#result == null")
public String getCachedValue(@RequestParam("param") String param) {
    return "9999";
}

访问：http://localhost:8080/getCachedValue?param=qwer测试，成功缓存，修改代码return null;再测试，就不会进行缓存

/**
 * 可以缓存null值，但会乱码，不影响使用
 * 缓存null值有两种情况：
 * 1.return null；
 * 2.方法返回值为void
 */
@GetMapping("/getUser")
@Cacheable(key = "#uid")
public User getUser(@RequestParam("uid") Long uid) {
    return userMapper.selectById(uid);
}

在这里插入图片描述

2.2.@CacheEvict

@CacheEvict：触发缓存逐出。

@GetMapping("/cacheEvict")
@CacheEvict(key = "'list'")//清除键为key的缓存
public void cacheEvict(){
}

@GetMapping("/cacheEvictAll")
@CacheEvict(key = "'user'", allEntries = true)//清除user分区下的所有缓存
public void cacheEvictAll() {
}

2.3.@Cacheput

@CachePut：在不干扰方法执行的情况下更新缓存。

@GetMapping("/getUser")
@Cacheable(key = "#uid")
public User getUser(@RequestParam("uid") Long uid) {
    return userMapper.selectById(uid);
}

@GetMapping("/update")
@CachePut(key = "#uid")
public User update(@RequestParam("uid") Long uid) {
    User user = new User();
    user.setId(uid);
    user.setName("lisi9999");
    userMapper.updateById(user);
    return user;
}

1.先http://localhost:8080/getUser?uid=2进行缓存
2.再http://localhost:8080/update?uid=2刷新缓存
3.再http://localhost:8080/getUser?uid=2查缓存
可以看到缓存被正确更新

注意：update方法返回值不能写void，否则会触发缓存空值的情况，缓存被刷新成乱码了

2.4.@Caching

@Caching：重新组合要应用于方法的多个缓存操作。

/**
 * @Cacheable(key = "'allBooks'")：表示方法的返回值应该被缓存，使用 allBooks 作为缓存的键。
 * @CacheEvict(key = "#isbn")：表示在调用这个方法时，会清除缓存中键为 #isbn 的缓存项。
 * @CacheEvict(key = "'popularBooks'")：表示在调用这个方法时，会清除缓存中键为 'popularBooks' 的缓存项。
 */
@Caching(
        cacheable = @Cacheable(key = "'allBooks'"),
        evict = {
                @CacheEvict(key = "#isbn"),
                @CacheEvict(key = "'popularBooks'")
        }
)
public String updateBookByIsbn(String isbn, String newTitle) {
    System.out.println("Updating book in the database for ISBN: " + isbn);
    // Simulate updating data in a database
    return newTitle;
}

2.5.@CacheConfig

@CacheConfig：在类级别共享一些常见的缓存相关设置。

@CacheConfig(cacheNames = "user", cacheManager = "redisCacheManager")
public class UserCache {

}

3.SpringCache问题

springCache的这些注解也受@Transactional的事务控制

@Transactional
@Cacheable(value = "myCache", key = "#id")
public String getCachedValueById(long id) {
    // 查询底层数据源，如果缓存中没有数据
    return fetchDataFromDataSource(id);
}