早睡身体好！SpringAOP学习笔记

记录这篇文章是因为在项目开发过程中，需要建立一个日志模块。设想如果每个功能都需要添加一个添加日志的逻辑，就算能运用面向对象编程思想，将方法封装，是大大的增加了代码复用率。但是也需要每个方法添加封装的方法，一样是不能接受的。后续经过查资料，知道了AOP的用法，果然AOP就是为了日志管理、权限管理这些公用的功能而生的。

什么是SpringAOP？

AOP（Aspect Oriented Programing）面向切面编程。在整个程序贯穿之下，存在N个切点，而切点会连接着横切面。若程序执行到了连接点后，就会进入到横切面中执行你的逻辑增强。整个程序中，面向对象编程是纵向编程（接口、实现类）等而AOP是在原先程序的基础上，增加了非业务功能，而不是在业务逻辑中再添加各种非业务逻辑。

AOP相关注解

@Pointcut

该注解是指定一个切点，拦截你需要拦截的东西，在这个切点处进入切面，两种常用的表达式：execution()和annotation()

execution(* * com.service..*(..))

该表达式的意思是，监听了com.service包和其下的子包里的所有方法，包含所有参数，其中两个句点..指的是service包下的子包。

第一个*号表示返回类型，*表示所有返回类型

第二个*号表示类名，*表示所有类名

第三个*号表示方法，而（..）两个句点表示了所有参数

@annotation(com.annotation.MyAnnotation)

该表达式的意思是，监听所有加上了MyAnnotation注解的方法，MyAnnotation可以使自定义注解也可以是RequestMapping、GetMapping等注解。

若使用execution表达式觉得范围太大，则可以使用annotation表达式，就是需要自己去配置注解，略显麻烦。

可以在@Before、@After等注解中直接使用，也可以编写一个方法，使用 @Pointcut注解。

   @Pointcut("@annotation(com.headyonder.dmp.aop.annotation.SystemLogAnno)")
    public void activePointCut() {
    }

@Before

前置播报

就是监听切点定义的所有方法，在监听的方法进入切面之前就执行你的逻辑操作。

@Before(value = "activePointCut()")
public void doAfterReturning(JoinPoint jp){
            User u = UserUtil.getUser();
            MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();
            String method = methodSignature.getName();
            SystemLogAnno anno = methodSignature.getMethod().getAnnotation(SystemLogAnno.class);
            log.info("=={}已经操作{}方法==", u.getName(), method);
}

@After

后置绝对播报

就是监听切点定义的所有方法，在监听的方法完成后（无论是否出现异常）都会进入切面执行你的逻辑操作。

@After(value = "activePointCut()")
public void doAfterReturning(JoinPoint jp){
            User u = UserUtil.getUser();
            MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();
            String method = methodSignature.getName();
            SystemLogAnno anno = methodSignature.getMethod().getAnnotation(SystemLogAnno.class);
            log.info("=={}已经操作{}方法==", u.getName(), method);
}

@AfterReturing

后置完成播报

和After不一样的是，AfterReturing只会在方法成功执行并返回参数的时候才会执行你的逻辑增强。

@AfterReturning(value = "activePointCut()", returning = "result")
public void doAfterReturning(JoinPoint jp,String result){
            User u = UserUtil.getUser();
            MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();
            String method = methodSignature.getName();
            SystemLogAnno anno = methodSignature.getMethod().getAnnotation(SystemLogAnno.class);
            log.info("=={}已经操作{}方法==", u.getName(), method);
}

需要注意的是，注解中returning的值必须与方法的第二个参数一致，否则程序会编译错误。 

@AfterThrowing

异常播报

监听方法进入切面后，抛出的异常执行你的逻辑增强。

@AfterThrowing(value = "activePointCut()", throwing = "e")
public void doThrowing(JoinPoint joinPoint, Exception e) {
       //与doAfterReturing类似
}

@Around

环绕播报（全程播报）

该注解的优先级大于Before和After。该注解的方法第一个参数需要为ProceedingJoinPoint，而其中最重要的是proceed()方法，该方法是执行目标对象。

就可以在该注解下进行前置增强和后置增强。

  @Around(value = "activePointCut()&&args(argNames,argName1)",argNames = "pjp,argNames,argName1")
    public void doAround(ProceedingJoinPoint pjp,String argNames,String argName1){
        try{
            MethodSignature methodSignature = (MethodSignature) pjp.getSignature();
            String method = methodSignature.getName();
            SystemLogAnno anno = methodSignature.getMethod().getAnnotation(SystemLogAnno.class);
            log.info("执行目标方法前");
            pjp.proceed(pjp.getArgs());
            log.info("执行目标方法后");
            //pjp.proceed();
        }catch (Throwable throwable) {
            throwable.printStackTrace();
        }
    }

注：每个逻辑增强中，都可以增加参数。但是需要在value中使用&&args(args1,args2,args3...)然后第二个参数，argNames就需要添加方法中所有的参数。如下：

@Around(value = "activePointCut()&&args(argNames,argName1)",argNames = "pjp,argNames,argName1")