Spring AOP实现缓存

AOP（Aspect Oriented Programming），即面向切面编程，可以说是OOP（Object Oriented Programming，面向对象编程）的补充和完善。OOP引入封装、继承、多态等概念来建立一种对象层次结构，用于模拟公共行为的一个集合。不过OOP允许开发者定义纵向的关系，但并不适合定义横向的关系，例如日志功能。日志代码往往横向地散布在所有对象层次中，而与它对应的对象的核心功能毫无关系对于其他类型的代码，如安全性、异常处理和透明的持续性也都是如此，这种散布在各处的无关的代码被称为横切（cross cutting），在OOP设计中，它导致了大量代码的重复，而不利于各个模块的重用。

AOP技术恰恰相反，它利用一种称为”横切”的技术，剖解开封装的对象内部，并将那些影响了多个类的公共行为封装到一个可重用模块，并将其命名为”Aspect”，即切面。所谓”切面”，简单说就是那些与业务无关，却为业务模块所共同调用的逻辑或责任封装起来，便于减少系统的重复代码，降低模块之间的耦合度，并有利于未来的可操作性和可维护性。

使用”横切”技术，AOP把软件系统分为两个部分：核心关注点和横切关注点。业务处理的主要流程是核心关注点，与之关系不大的部分是横切关注点。横切关注点的一个特点是，他们经常发生在核心关注点的多处，而各处基本相似，比如权限认证、日志、事物。AOP的作用在于分离系统中的各种关注点，将核心关注点和横切关注点分离开来。

AOP的核心概念

横切关注点:对哪些方法进行拦截，拦截后怎么处理，这些关注点称之为横切关注点
切面（aspect）:类是对物体特征的抽象，切面就是对横切关注点的抽象
连接点（joinpoint）:被拦截到的点，因为Spring只支持方法类型的连接点，所以在Spring中连接点指的就是被拦截到的方法，实际上连接点还可以是字段或者构造器
切入点（pointcut）:对连接点进行拦截的定义
通知（advice:所谓通知指的就是指拦截到连接点之后要执行的代码，通知分为前置、后置、异常、最终、环绕通知五类
目标对象:代理的目标对象
织入（weave）:将切面应用到目标对象并导致代理对象创建的过程
引入（introduction）:在不修改代码的前提下，引入可以在运行期为类动态地添加一些方法或字段

Spring对AOP的支持

Spring中AOP代理由Spring的IOC容器负责生成、管理，其依赖关系也由IOC容器负责管理。因此，AOP代理可以直接使用容器中的其它bean实例作为目标，这种关系可由IOC容器的依赖注入提供。Spring创建代理的规则为：

默认使用Java动态代理来创建AOP代理，这样就可以为任何接口实例创建代理了
当需要代理的类不是代理接口的时候，Spring会切换为使用CGLIB代理，也可强制使用CGLIB
AOP编程其实是很简单的事情，纵观AOP编程，程序员只需要参与三个部分：
定义普通业务组件
定义切入点，一个切入点可能横切多个业务组件
定义增强处理，增强处理就是在AOP框架为普通业务组件织入的处理动作,所以进行AOP编程的关键就是定义切入点和定义增强处理，一旦定义了合适的切入点和增强处理，AOP框架将自动生成AOP代理，即：代理对象的方法=增强处理+被代理对象的方法。

以上慨念来自博客 Spring AOP详解

AOP实现缓存

自定义注解标记业务组件

Cache注解实现缓存

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface Cache {
    Class type();
    String cacheKey() default "";
}

CacheClear注解实现清除缓存

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface CacheClear {
    Class type();
    String cacheKey() default "";
}

定义一个业务组件

@Service("aopService")
public class AopService {
    @Cache(type = AopService.class,cacheKey = "test")
    public IMapEntry getGame(){
        DICLogger.info("从数据库查询数据");
        IMapEntry result = new MapEntry<>();
        result.put("name","英雄联盟");
        result.put("level",1);
        return result;
    }
    @CacheClear(type = AopService.class,cacheKey = "test")
    public IMapEntry updateGame(){
        IMapEntry result = new MapEntry<>();
        result.put("name","英雄联盟2");
        result.put("level",1);
        return result;
    }
}

一个普通的service,模拟从数据库查询游戏和修改游戏信息。在查询游戏时缓存查询结果，修改游戏信息时清除缓存。

定义缓存工具

缓存工具CacheUtil，简单实现缓存功能，实际可以使用Redis。

public class CacheUtil {
    public static Map<String,Object> cacheMap = new HashMap<>();
    public static Object getCache(String key){
        return cacheMap.get(key);
    }
    public static void setCache(String key,Object value){
        cacheMap.put(key,value);
    }
    public static void removeCache(String key){
        cacheMap.remove(key);
    }
}

编写切面

@Aspect
@Component
public class CacheAspect {
    /**
     * Service层切点 使用到了定义的 Cache 作为切点表达式。
     * 此表达式基于 annotation。并且用于内建属性为查询的方法之上
     */
    @Pointcut("@annotation(com.study.ims.aop.Cache)")
    public void cacheAspect(){}
    /**
     * Service层切点 使用到了定义的 CacheClear 作为切点表达式。
     * 此表达式基于 annotation。并且用于内建属性为修改的方法之上
     */
    @Pointcut("@annotation(com.study.ims.aop.CacheClear)")
    public void cacheClearAspect(){}
    public String getName(){
        return "CacheAspect";
    }
    /**
    * 
    */
    @Around("cacheAspect()")
    public Object cache(ProceedingJoinPoint joinPoint)throws Throwable{
        Signature signature = joinPoint.getSignature();
        String className = joinPoint.getTarget().getClass().getName();
        String methodName = signature.getName();
        Object[] args = joinPoint.getArgs();
        DICLogger.info("类名：{}，方法名：{}，参数：{}",className,methodName,args);
        Method method = ((MethodSignature)signature).getMethod();
        Cache annoCache =  method.getAnnotation(Cache.class);
        String cacheKey = annoCache.type().getName();
        if(StringUtils.isNotBlank(annoCache.cacheKey())){
            cacheKey = cacheKey+"_"+annoCache.cacheKey();
        }
        Object cacheValue = CacheUtil.getCache(cacheKey);
        Class returnType = ((MethodSignature)signature).getReturnType();
        Object returnResult = null;
        if(null==cacheValue){
            DICLogger.info("未从缓存中获取到数据");
            returnResult = joinPoint.proceed(args);
            DICLogger.info("查询到数据：{}", JSONUtil.toJSONString(returnResult));
            CacheUtil.setCache(cacheKey,returnResult);
        }else{
            DICLogger.info("从缓存中获取到数据");
            returnResult = cacheValue;
        }
        return returnResult;
    }
    @Around("cacheClearAspect()")
    public Object cacheClear(ProceedingJoinPoint joinPoint) throws Throwable{
        Signature signature = joinPoint.getSignature();
        Method method = ((MethodSignature)signature).getMethod();
        CacheClear annoCacheClear =  method.getAnnotation(CacheClear.class);
        String cacheKey = annoCacheClear.type().getName();
        if(StringUtils.isNotBlank(annoCacheClear.cacheKey())){
            cacheKey = cacheKey+"_"+annoCacheClear.cacheKey();
        }
        DICLogger.info("清除緩存，key:{}",cacheKey);
        CacheUtil.removeCache(cacheKey);
        return joinPoint.proceed(joinPoint.getArgs());
    }
}

上面使用了@around通知，同样还有@before和@after两个通知。

@before：在所拦截方法执行之前执行一段逻辑
@after：在所拦截方法执行之后执行一段逻辑
@around：可以同时在所拦截方法的前后执行一段逻辑

@around通知十分强大，他可以完全阻止目标方法执行（不调用joinPoint.proceed(args)方法）、自行决定目标方法的执行时机、共享某些资源（可以在proceed方法中替换参数）。

上面cacheClear方法可以将@around换成@before

测试controller如下：

@RestController
public class TestController {
    @Autowired
    AopService aopService;
    @RequestMapping("/getGame")
    public Object getGame(HttpServletRequest request){
        return aopService.getGame();
    }
    @RequestMapping("/updateGame")
    public Object updateGame(HttpServletRequest request){
        return aopService.updateGame();
    }
}

第一次调用getGame接口，打印

[study]   INFO [CacheAspect:39] 类名：com.study.ims.test.service.AopService，方法名：getGame，参数：[]
[study]   INFO [CacheAspect:51] 未从缓存中获取到数据
[study]   INFO [AopService:18] 从数据库查询数据
[study]   INFO [CacheAspect:53] 查询到数据：{"level":1,"name":"英雄联盟"}

再次调用getGame接口，打印

1 2	[study] INFO [CacheAspect:39] 类名：com.study.ims.test.service.AopService，方法名：getGame，参数：[] [study] INFO [CacheAspect:56] 从缓存中获取到数据

调用updateGame接口，打印

1	[study] INFO [CacheAspect:70] 清除緩存，key:com.study.ims.test.service.AopService_test