Springboot自定义注解+aop实现redis自动清除缓存功能

在Spring Boot应用中，结合自定义注解与AOP（面向切面编程）技术，可以实现一种自动化管理Redis缓存的机制，即在特定方法执行前后自动清除或更新相关的缓存数据。下面将详细介绍这一实现过程，确保内容既专业又易于理解。

1. 自定义注解定义

首先，我们需要定义一个自定义注解，用于标记那些执行后需要清除或更新缓存的方法。比如，定义一个名为 @ClearCache的注解：

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ClearCache {
    String[] cacheNames() default {}; // 缓存名称数组，允许指定多个缓存
}
​

 

 

此注解可以被应用在方法上，通过 cacheNames属性指定需要清除的缓存名称。

2. AOP切面编写

接下来，创建一个切面（Aspect），用来拦截带有 @ClearCache注解的方法调用。在切面中，我们可以在方法执行前后执行缓存清理逻辑：

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Component;

@Aspect
@Component
public class CacheClearAspect {

    @Autowired
    private RedisTemplate<String, Object> redisTemplate;

    @Around("@annotation(clearCache)")
    public Object clearCacheOnMethodExecution(ProceedingJoinPoint joinPoint, ClearCache clearCache) throws Throwable {
        // 在方法执行前的操作
        String[] cacheNames = clearCache.cacheNames();
        for (String cacheName : cacheNames) {
            redisTemplate.delete(cacheName);
            // 或者根据实际需求执行更复杂的缓存处理逻辑
        }

        // 执行原方法
        Object result = joinPoint.proceed();

        // 在方法执行后的操作（如果需要）

        return result;
    }
}
​

 

 

在这个切面中，我们使用 @Around注解来环绕匹配的方法调用，通过 ProceedingJoinPoint获取到方法执行的上下文，再根据 @ClearCache注解中指定的缓存名称来清除相应的缓存。

3. 配置AOP代理

确保Spring Boot应用已经启用了AOP代理，通常情况下，只要引入了Spring AOP的依赖，且切面类被Spring管理（如通过 @Component注解标注），AOP就会自动生效。

4. 使用自定义注解

最后，在需要清除缓存的方法上应用 @ClearCache注解：

@Service
public class UserService {

    @ClearCache(cacheNames = {"userCache"})
    public User getUserById(int id) {
        // 方法实现细节...
    }
}
​

 

 

每当 getUserById方法被调用后，CacheClearAspect就会自动清除名为"userCache"的Redis缓存。