Spring Aop 打印controller的输入输出

关于切面：
Spring AOP 使用示例：使用AOP打印所有controller接口得输入输出打印。

1.引入依赖

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.4.5</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

2.切面

package com.$$$.$$$.commom;

import dm.jdbc.stat.support.json.JSONObject;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.Signature;
import org.aspectj.lang.annotation.*;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;

/**
 * Created with IntelliJ IDEA.
 *
 * @Author: TWLZ
 * @Date: 2021/12/09/16:42
 * @Description:
 */
@Slf4j
@Aspect
@Component
public class LogAspect {

    @Pointcut("within(com.$$$.$$$.standardOutline.StandardOutlineController ||" +
            "com.$$$.$$$.standard.StandardRecordController ||" +
            "com.$$$.$$$.check.CheckController)")
    public void showInOrOut(){

    }

    @Before("showInOrOut()")
    public void showInputParams(JoinPoint joinPoint){
        Object[] args = joinPoint.getArgs();
        Signature signature = joinPoint.getSignature();
        MethodSignature methodSignature = (MethodSignature) signature;
        String[] parameterNames = methodSignature.getParameterNames();
        StringBuilder paramDes = new StringBuilder();
        paramDes.append("\n类：").append(signature.getDeclaringTypeName()).
                append("中，方法：").append(methodSignature.getMethod().getName()).append("(..)被调用, 入参如下");

        for (int i = 0; i < args.length; i++){
            paramDes.append("\n").append(parameterNames[i]).append(": ").append(args[i]);
        }
        log.info(paramDes.toString());

    }

    @AfterReturning(value = "showInOrOut()" , returning = "retVal")
    public void showOutput(JoinPoint joinPoint, Object retVal){
        Signature signature = joinPoint.getSignature();
        MethodSignature methodSignature = (MethodSignature) signature;
        StringBuilder ret = new StringBuilder();
        ret.append("\n类：").append(signature.getDeclaringTypeName()).
                append("中，方法：").append(methodSignature.getMethod().getName()).append("(..)被调用, 返回值：");
        ret.append("\n").append(retVal.toString());
        log.info(ret.toString());
    }
}

3 、相关知识点

3.1 常用的切点标识符

• execution: 用于匹配方法执行连接点。 这是使用Spring AOP时使用的主要切点标识符。 可以匹配到方法级别 ，细粒度。
• within: 只能匹配类这级，只能指定类， 类下面的某个具体的方法无法指定， 粗粒度
• 自定义标签，可以标注到类或者方法上，但是会影响到springboot的启动速度。

3.2 通知类型

• Before(前置通知): 连接点之前执行，除非抛异常，否则没有能力中断执行流（@Before 注解）
• After(后置通知): 无论连接点是通过什么方式退出的(正常返回或者抛出异常)都会在结束后执行这些Advice（@After 注解）
• After Retuning(返回通知): 在连接点正常结束之后(没有抛出异常正常返回)执行的Advice（@AfterReturning 注解）
• After Throwing(异常通知): 如果方法通过抛出异常来退出的话，这个Advice就会被执行（@AfterThrowing 注解）
• Around(环绕通知): 围绕连接点执行的Advice，就你一个方法调用（相对于合并前置后置）（ @Around 注解）

3.3 底层原理

• AOP是通过动态代理实现的。如果我们为Spring的某个bean配置了切面，那么Spring在创建这个bean的时候，实际上创建的是这个bean的一个代理对象，我们后续对bean中方法的调用，实际上调用的是代理类重写的代理方法。而Spring的AOP使用了两种动态代理，分别是JDK的动态代理，以及CGLib的动态代理。
• Spring默认使用JDK动态代理，只有在类没有实现接口时，才会使用CGLib。

3.3.1 JDK动态代理

• 实现原理
  JDK的动态代理是基于反射实现。JDK通过反射，生成一个代理类，这个代理类实现了原来那个类的全部接口，并对接口中定义的所有方法进行了代理。当我们通过代理对象执行原来那个类的方法时，代理类底层会通过反射机制，回调我们实现的InvocationHandler接口的invoke方法。并且这个代理类是Proxy类的子类。这就是JDK动态代理大致的实现方式。
• 优点
  1. JDK动态代理是JDK原生的，不需要任何依赖即可使用；
  2. 通过反射机制生成代理类的速度要比CGLib操作字节码生成代理类的速度更快；
• 缺点
  1. 如果要使用JDK动态代理，被代理的类必须实现了接口，否则无法代理；
  2. JDK动态代理无法为没有在接口中定义的方法实现代理，假设我们有一个实现了接口的类，我们为它的一个不属于接口中的方法配置了切面， Spring仍然会使用JDK的动态代理，但是由于配置了切面的方法不属于接口，为这个方法配置的切面将不会被织入。
  3. JDK动态代理执行代理方法时，需要通过反射机制进行回调，此时方法执行的效率比较低；

3.3.2 CGLIB

• 实现原理
  CGLib实现动态代理的原理是，底层采用了ASM字节码生成框架，直接对需要代理的类的字节码进行操作，生成这个类的一个子类，并重写了类的所有可以重写的方法，在重写的过程中，将我们定义的额外的逻辑（简单理解为Spring中的切面）织入到方法中，对方法进行了增强。而通过字节码操作生成的代理类，和我们自己编写并编译后的类没有太大区别。
• 优点
  1. 使用CGLib代理的类，不需要实现接口，因为CGLib生成的代理类是直接继承自需要被代理的类；
  2. CGLib生成的代理类是原来那个类的子类，这就意味着这个代理类可以为原来那个类中，所有能够被子类重写的方法进行代理；
  3. CGLib生成的代理类，和我们自己编写并编译的类没有太大区别，对方法的调用和直接调用普通类的方式一致，所以CGLib执行代理方法的效率要高于JDK的动态代理；
• 缺点
  1. 由于CGLib的代理类使用的是继承，这也就意味着如果需要被代理的类是一个final类，则无法使用CGLib代理；
  2. 由于CGLib实现代理方法的方式是重写父类的方法，所以无法对final方法，或者private方法进行代理，因为子类无法重写这些方法；
  3. CGLib生成代理类的方式是通过操作字节码，这种方式生成代理类的速度要比JDK通过反射生成代理类的速度更慢；