Spring Cache

1.介绍

Spring Cache是Spring框架提供的一种缓存抽象机制，实现了基于注解的缓存功能，只需要简单地加一个注解，就能实现缓存功能。

Spring Cache 提供了一层抽象，底层可以切换不同的缓存实现，例如：

- EHCache

- Caffeine

- Redis(常用)

1.1主要特点

1. 声明式缓存：通过在方法上添加注解（如@Cacheable、@CachePut、@CacheEvict等）来声明缓存的行为，无需手动编写缓存代码。
2. 多种缓存支持：Spring Cache提供了对多种缓存框架的支持，包括Redis、Ehcache、Guava Cache、Caffeine等，可以根据需要选择合适的缓存实现。
3. 缓存策略配置：支持通过配置文件或编程方式配置缓存的策略，包括缓存的过期时间、缓存的淘汰策略等。
4. 注解灵活应用：注解提供了丰富的配置选项，如使用SpEL表达式动态指定缓存的Key和条件等，可以根据业务需求进行灵活配置。
5. 缓存切面自动代理：Spring Cache通过AOP技术，利用代理模式在方法执行前后拦截，自动处理缓存相关的操作，对业务代码无侵入。

1.2 核心注解

• @Cacheable：用于声明一个方法的返回值是可缓存的。当方法被调用时，Spring会先检查缓存中是否存在相同的key，如果存在则直接返回缓存中的值，否则执行方法并将结果缓存起来。

例如：在getById上加注解@Cacheable

/**
	* Cacheable：在方法执行前spring先查看缓存中是否有数据，如果有数据，则直接返回缓存数据；若没有数据，	  *调用方法并将方法返回值放到缓存中
	* value：缓存的名称，每个缓存名称下面可以有多个key
	* key：缓存的key
	*/
	@GetMapping
    @Cacheable(cacheNames = "userCache",key="#id")
    public User getById(Long id){
        User user = userMapper.getById(id);
        return user;
    }

• @CachePut：用于更新缓存中的数据。与@Cacheable不同，@CachePut注解的方法在执行后，无论结果是否被缓存过，都会将结果缓存起来。

例如：在save方法上加上注解 @CachePut，将保存到数据库中的同时也保存在缓存中。

	/**
	* CachePut：将方法返回值放入缓存
	* value：缓存的名称，每个缓存名称下面可以有多个key
	* key：缓存的key
	*/
	@PostMapping
    @CachePut(value = "userCache", key = "#user.id")//key的生成：userCache::1
    public User save(@RequestBody User user){
        userMapper.insert(user);
        return user;
    }

• @CacheEvict：用于清除缓存中的数据。可以指定清除一个或多个缓存中的数据，也可以指定在方法执行前或执行后清除缓存。

例如：在 delete 方法上加注解@CacheEvict

@DeleteMapping
    @CacheEvict(cacheNames = "userCache",key = "#id")//删除某个key对应的缓存数据
    public void deleteById(Long id){
        userMapper.deleteById(id);
    }

	@DeleteMapping("/delAll")
    @CacheEvict(cacheNames = "userCache",allEntries = true)//删除userCache下所有的缓存数据
    public void deleteAll(){
        userMapper.deleteAll();
    }

• @Caching：组合了以上多个注解的功能，可以在一个方法上同时应用多个缓存注解。
• @CacheConfig：在类级别共享缓存的相同配置，可以减少重复配置。

补充说明：key的写法

#user.id : #user指的是方法形参的名称, id指的是user的id属性 , 也就是使用user的id属性作为key ;

#result.id : #result代表方法返回值，该表达式 代表以返回对象的id属性作为key ；

#p0.id：#p0指的是方法中的第一个参数，id指的是第一个参数的id属性,也就是使用第一个参数的id属性作为key ;

#a0.id：#a0指的是方法中的第一个参数，id指的是第一个参数的id属性,也就是使用第一个参数的id属性作为key ;

#root.args[0].id:#root.args[0]指的是方法中的第一个参数，id指的是第一个参数的id属性,也就是使用第一个参数的id属性作为key ;

1.3使用步骤

在Spring Boot项目中使用Spring Cache的大致步骤如下：

1. 引入相关依赖：在项目的pom.xml文件中引入Spring Boot的缓存启动器依赖spring-boot-starter-cache，以及具体的缓存实现依赖（如Redis、Ehcache等）。

```xml
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-cache</artifactId>  		            		       	 <version>2.7.3</version> 
</dependency>

        2.开启缓存支持：在启动类上添加@EnableCaching注解来开启缓存支持。

package com.itheima;

import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cache.annotation.EnableCaching;

@Slf4j
@SpringBootApplication
@EnableCaching//开启缓存注解功能
public class CacheDemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(CacheDemoApplication.class,args);
        log.info("项目启动成功...");
    }
}

        3.配置缓存：根据需要配置缓存管理器（CacheManager）和缓存（Cache）的相关属性，如缓存名称、过期时间、淘汰策略等。（在用户端接口SetmealController的 list 方法上加入@Cacheable注解）

        4.使用注解：在需要缓存的方法上添加相应的缓存注解，并配置相应的属性。（在管理端接口SetmealController的 save、delete、update、startOrStop等方法上加入CacheEvict注解）

例如：

/**
     * 新增套餐
     *
     * @param setmealDTO
     * @return
     */
    @PostMapping
    @ApiOperation("新增套餐")
    @CacheEvict(cacheNames = "setmealCache",key = "#setmealDTO.categoryId")//key: setmealCache::100
    public Result save(@RequestBody SetmealDTO setmealDTO) {
        setmealService.saveWithDish(setmealDTO);
        return Result.success();
    }
	/**
     * 批量删除套餐
     *
     * @param ids
     * @return
     */
    @DeleteMapping
    @ApiOperation("批量删除套餐")
    @CacheEvict(cacheNames = "setmealCache",allEntries = true)
    public Result delete(@RequestParam List<Long> ids) {
        setmealService.deleteBatch(ids);
        return Result.success();
    }
	/**
     * 修改套餐
     *
     * @param setmealDTO
     * @return
     */
    @PutMapping
    @ApiOperation("修改套餐")
    @CacheEvict(cacheNames = "setmealCache",allEntries = true)
    public Result update(@RequestBody SetmealDTO setmealDTO) {
        setmealService.update(setmealDTO);
        return Result.success();
    }

    /**
     * 套餐起售停售
     *
     * @param status
     * @param id
     * @return
     */
    @PostMapping("/status/{status}")
    @ApiOperation("套餐起售停售")
    @CacheEvict(cacheNames = "setmealCache",allEntries = true)
    public Result startOrStop(@PathVariable Integer status, Long id) {
        setmealService.startOrStop(status, id);
        return Result.success();
    }

五、总结

        Spring Cache通过提供一套缓存抽象机制，简化了应用中的缓存操作，提高了系统的性能和响应速度。它支持多种缓存实现和灵活的缓存策略配置，通过声明式的方式管理缓存，对业务代码无侵入。在Spring Boot项目中，只需简单几步即可轻松集成Spring Cache。