Spring AOP（5种通知类型）

---

一、介绍

• AOP（Aspect Oriented Programming）：面向切面编程，是Spring的两大核心之一
• 是OOP（面向对象编程）的延续
• 开发者可以自由的指定切面的切入点、切面的应用范围、切面中需要执行的任务，切面应用到某种执行流程时，并不需要修改原流程中涉及的任何代码
• 利用AOP可以对业务逻辑的各个部分进行隔离，从而使得业务逻辑各部分之间的耦合度降低
• 面向切面编程并不是Spring独有的，只是Spring提供了一种更快捷的创建、管理切面的做法
• Spring AOP就是基于动态代理实现的， 分为两种代理，jdk动态代理（基于接口）和cglib代理（基于类的），如果目标对象实现了接口，就用jdk动态代理，如果未实现接口就用cglib动态代理

二、应用场景

• 权限控制
• 事务控制
• 收集日志
  • 如果我们想在Controller的接口API出保存接口的请求信息（请求方法、请求参数）、响应信息（响应状态码、相应数据）时
  • 普通的做法就是在需要收集这些信息的接口API处修改代码，增加编写收集这些信息的逻辑
  • 使用AOP实现则只需要增加一个@Log注解、切面类，在这个切面类里编写收集这些信息的逻辑，在需要的接口API方法上添加该注解即可

三、项目整合

1、Spring

1、依赖

<dependency>
    <groupId>aspectjgroupId>
    <artifactId>aspectj-toolsartifactId>
    <version>1.0.6version>
dependency>

<dependency>
    <groupId>org.aspectjgroupId>
    <artifactId>aspectjweaverartifactId>
    <version>1.9.2version>
dependency>

2、开启AOP

<aop:aspectj-autoproxy proxy-target-class="true" />

• proxy-target-class=“false”，表示使用jdk动态代理
• proxy-target-class="true"时，表示使用cglib动态代理
• 当切入的类是接口时，如IUserService，Spring默认使用jdk动态代理
• 当切入的类是类时，Spring默认使用cglib动态代理
• 如果切入的类是接口还想使用cglib动态代理时，设置proxy-target-class=“true”

2、SpringBoot

1、依赖

<dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-aopartifactId>
dependency>

2、配置文件

spring:
  aop:
    # 开启AOP，默认true
    #auto: true
    # 动态代理，默认true
    #proxy-target-class: true

四、代码实现

• 5种类型通知
• 指定切入点支持两种形式
  1. execution表达式

  /*
   * execution(* com.kimi.*.*(..))
   *  第一个*：无论这个方法是什么权限
   *  com.kimi：应用于哪个包
   *  com.kimi.*：com.kimi包下所有的类
   *  com.kimi.*.*：com.kimi包下所有的类的所有方法
   *  com.kimi.*.*(..)：com.kimi包下所有的类的任何参数的方法，(..)表示：方法是任何参数（无参数、一个、多个参数）
   * 示例：
   *  execution(* com.kimi.Controller.*(..))：com.kimi包下的Controller类中的所有方法
   *  execution(* com.kimi.Controller.list(..))：com.kimi包下的Controller类中的list方法
   *  execution(* com.kimi.Controller.list*(..))：com.kimi包下的Controller类中的list开头的方法
   *  execution(* com.kimi.Controller.list(String))：com.kimi包下的Controller类中的list方法，list方法是一个String类型参数
   *  execution(* com.kimi.Controller.list(com.kimi.domain.User))：com.kimi包下的Controller类中的list方法，list方法是一个User类型参数
   */
   
  

  2. 注解：@annotation(controllerLog)

1、@Before（前置通知）

• 在方法执行前执行

1. 属性

//指定切入点
String value();

String argNames() default "";

2. 代码

@Component
//@Aspect表示是一个切面类
@Aspect
public class LogAspect {
    /**
     * 1、Before
     *
     * @param joinPoint 连接点，必须为方法的第一个参数
     * @param controllerLog 目标方法上的切入注解
     */
    @Before("@annotation(controllerLog)")
    public void before(JoinPoint joinPoint,Log controllerLog){
        System.err.println("======================= Before =======================");

        //类的全限定名称
        String className=joinPoint.getTarget().getClass().getName();
        //方法名
        String methodName=joinPoint.getSignature().getName();

        //方法入参：?name=kimi&age=18：[kimi, 18]；{name:'kimi',age:18}[User(name=kimi, age=18)]
        Object[] paramArr=joinPoint.getArgs();

        //注解信息：@com.kimi.aop.annotation.Log(isSaveResponseData=true, isSaveRequestData=true, title=用户模块, businessType=add)
        String title=controllerLog.title();
    }
}

2、@After（后置通知）

• 在目标方法执行后无论是否发生异常，都执行
• 无法获取目标方法的返回值

1. 属性

//指定切入点
String value();

String argNames() default "";

2. 代码

/**
 * 2、After
 *
 * @param joinPoint
 * @param controllerLog
 * @return
 * @throws Throwable
 */
@After("@annotation(controllerLog)")
public void after(JoinPoint joinPoint,Log controllerLog){
    System.err.println("======================= After =======================");

}

3、@AfterRunning（返回通知）

• 当方法成功执行并返回才会执行，如果方法出现异常，则不执行
• 可以获取到目标方法的返回值

1. 属性

//指定切入点
String value() default "";

//指定切入点，pointcut优先级>value
String pointcut() default "";

//指定切入的方法返回值在这的形参
String returning() default "";

String argNames() default "";

2. 代码

/**
 *  3、AfterReturning
 *
 * @param joinPoint
 * @param controllerLog
 * @param jsonResult
 */
@AfterReturning(pointcut="@annotation(controllerLog)", returning = "jsonResult")
public void afterReturning(JoinPoint joinPoint,Log controllerLog,Object jsonResult){
    System.err.println("======================= AfterReturning =======================");

}

4、@AfterThrowing（异常通知）

• 在方法抛出异常之后执行

1. 属性

//指定切入点
String value() default "";

//指定切入点，pointcut优先级>value
String pointcut() default "";

//指定切入的方法抛出异常在这的形参
String throwing() default "";

String argNames() default "";

2. 代码

/**
 * 4、AfterThrowing
 *
 * @param joinPoint
 * @param controllerLog
 * @param e
 */
@AfterThrowing(value="@annotation(controllerLog)", throwing = "e")
public void afterThrowing(JoinPoint joinPoint, Log controllerLog, Exception e){
    String exceptionInfo=e.toString();
}

5、@Around（环绕通知）

• 方法前后都执行
• 环绕通知方法可以包含上面四种通知方法，功能最全面

1. 属性

//指定切入点
String value();

String argNames() default "";

2. 代码

/**
 * 5、Around
 *
 * @param pjp ProceedingJoinPoint仅支持Around，其它4通知使用JoinPoint
 * @return
 * @throws Throwable
 */
@Around("execution(* com.kimi.*.*(..))")
public Object around(ProceedingJoinPoint pjp) throws Throwable {

    //调用目标方法
    Object result=pjp.proceed();

    //切入的方法可能有返回值，应用到切面方法返回，否则原方法的返回值可能会丢失
    //通过这一特性可以控制目标方法是否返回值、改变返回值
    return result;
}