【SpringBoot】AOP 自定义注解的使用详解_spring boot aop注解

        Spring 中的切面 Aspect，这是 Spring 的一大优势。面向切面编程往往让我们的开发更加低耦合，也大大减少了代码量，同时呢让我们更专注于业务模块的开发，把那些与业务无关的东西提取出去，便于后期的维护和迭代。

一、什么是 AOP？

        AOP 的全称为 Aspect Oriented Programming，译为面向切面编程，是通过预编译方式和运行期动态代理实现核心业务逻辑之外的横切行为的统一维护的一种技术。AOP 是面向对象编程（OOP）的补充和扩展。 利用 AOP 可以对业务逻辑各部分进行隔离，从而达到降低模块之间的耦合度，并将那些影响多个类的公共行为封装到一个可重用模块，从而到达提高程序的复用性，同时提高了开发效率，提高了系统的可操作性和可维护性。 

        AOP 是 Spring 框架中的一个核心内容。在 Spring 中，AOP 代理可以用 JDK 动态代理或者 CGLIB 代理 CglibAopProxy 实现。Spring 中 AOP 代理由 Spring 的 IOC 容器负责生成和管理，其依赖关系也由 IOC 容器负责管理。

二、为什么要用 AOP？

        在实际的 Web 项目开发中，我们常常需要对各个层面实现日志记录，性能统计，安全控制，事务处理，异常处理等等功能。如果我们对每个层面的每个类都独立编写这部分代码，那久而久之代码将变得很难维护，所以我们把这些功能从业务逻辑代码中分离出来，聚合在一起维护，而且我们能灵活地选择何处需要使用这些代码。

三、AOP 的核心概念

四、相关注解

其中 @Before、@After、@AfterReturning、@Around、@AfterThrowing 都属于通（Advice）。 

五、添加 AOP Maven 依赖

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

六、第一个实例

接下来我们先看一个例子，利用AOP+Swagger注解实现日志记录功能，所有接口请求完成时，打印日志记录。

具体实现如下：

1、创建一个 AOP 切面类，只要在类上加个 @Aspect 注解即可。@Aspect 注解用来描述一个切面类，定义切面类的时候需要打上这个注解。@Component 注解将该类交给 Spring 来管理。在这个类里实现 advice：

@Aspect
@Slf4j
@Component
@Order(1)
public class WebLogAspect {
 
    private ThreadLocal<Long> startTime = new Thre
 
    // 定义一个切点：所有接口中被@ApiOperation 注解修饰的方法会织入advice
    @Pointcut("@annotation(operation)")
    public void logPointcut(ApiOperation operation
    }
    // Before 表示 before 将在目标方法执行前执行
    @Before(value = "logPointcut(operation)", argN
    public void before(JoinPoint joinPoint, ApiOperation operation) {
        startTime.set(System.currentTimeMillis());
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        String[] moduleName = getModuleName(joinPoint, operation);
        log.info("[{}]-[{}]-start {}", moduleName[0], moduleName[1], request.getRequestURL().toString());
        log.info("参数 : {}", Arrays.toString(joinPoint.getArgs()));
    }
    @AfterReturning(returning = "ret", pointcut = "logPointcut(operation) ", argNames = "joinPoint,ret,operation")
    public void after(JoinPoint joinPoint, Object ret, ApiOperation operation) {
        // 处理完请求，返回内容
        String[] moduleName = getModuleName(joinPoint, operation);
        String retMesage = JSON.toJSONString(ret);
        log.info("[{}]-[{}]-end [{}ms] 响应:{}", moduleName[0], moduleName[1], (System.currentTimeMillis() - startTime.get()), retMesage);
        startTime.remove();
    }
    private String[] getModuleName(JoinPoint joinPoint, ApiOperation operation) {
        Class<?> clazz = joinPoint.getTarget().getClass();
        Api api = clazz.getAnnotation(Api.class);
        String pInfo = Optional.ofNullable(api).map(Api::value).orElse(clazz.getName());
        return new String[]{pInfo, operation.value()};
    }
}

2、创建一个接口类，在方法上加上 swagger 的 @ApiOperation 的注解

    @PostMapping("/getSupplierOrderDetailInfo")
    @ApiOperation(value = "售卖渠道订单查询", notes = "售卖渠道订单查询")
    public ApiResultResponse<SupplierOrderDetailResponse> getSupplierOrderDetailInfo(@RequestBody @Valid SupplierOrderDetailRequest request) {
        SupplierOrderDetailResponse response = appVipOrderService.getSupplierOrderDetailInfo(request);
        return ApiResponseUtils.buildSuccessMsg(response);
    }

3、项目启动后，请求该接口时，日志打印如下：

INFO  n.b.z.c.l.WebLogAspect - [售卖渠道信息相关]-[售卖渠道资金池余额查询接口]-start http://localhost:8080/openapi/supplier/getSupplier
INFO  n.b.z.c.l.WebLogAspect - 参数 : [SupplierAssetsPoolRequest(supplierId=8)]
INFO  n.b.z.c.l.WebLogAspect - [售卖渠道信息相关]-[售卖渠道资金池余额查询接口]-end [136ms] 响应:{"apiResult":{"balance":2910},"retCode":"000000","retMsg":"成功","retState":"SUCCESS"}

七、第二个实例

下面将问题复杂化一些，该例的场景是：

1、自定义一个注解 SupplierCheck 

2、创建一个切面类，切点设置为校验所有标注 SupplierCheck 的方法，截取到接口的参数，进行简单的 ip 白名单校验

3、将 SupplierCheck 标注在接口类上面的方法上

具体的实现步骤：

1、让我们来自定义一个注解，注解名为 SupplierCheck，如下所示

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
@Documented
public @interface SupplierCheck {
    /**
     * 校验白名单
     * 标识该方法是否需要校验白名单（默认校验），白话文就是说是否需要执行该校验白名单方法
     */
    boolean checkIpWhite() default true;
}

1、@Target 注解

用于指明被修饰的注解最终可以作用的目标是谁，也就是指明，你的注解到底是用来修饰方法的？修饰类的？还是用来修饰字段属性的。可以指定多个位置（@Target({ElementType.METHOD, ElementType.FIELD})），语法如下：

作用：用于描述注解的使用范围（即：被描述的注解可以用在什么地方） 

2、@Rerention 注解

该注解指定了被修饰的注解的生命周期，语法如下：

作用：表示需要在什么级别保存该注释信息，用于描述注解的生命周期（即：被描述的注解在什么范围内有效） 

3、@Documented

        @Documented 注解表示被它修饰的注解将被 javadoc 工具提取成文档。

4、Inherited

        @Inherited 注解表示被它修饰的注解具有继承性，即如果一个类声明了被 @Inherited 修饰的注解，那么它的子类也将具有这个注解。

2、创建一个 AOP 切面类

只要在类上加个 @Aspect 注解即可。@Aspect 注解用来描述一个切面类，定义切面类的时候需要打上这个注解。@Component 注解将该类交给 Spring 来管理。在这个类里面实现第一步白名单校验逻辑：

@Aspect
@Order(3)
@Slf4j
@Component
public class SupplierAspect {
 
    @Around("@annotation(supplierCheck)")
    public Object around(ProceedingJoinPoint pjp, SupplierCheck supplierCheck) throws Throwable {
        try {
            Object obj = pjp.getArgs()[0];
            // 业务逻辑
            doCheck(obj, supplierCheck);
            return pjp.proceed(pjp.getArgs());
        } catch (BizException e) {
            log.warn(e.getLogMsg());
            return buildErrorMsg(e.getApiCode(), e.getApiMsg());
        } catch (Exception e) {
            log.error("SupplierAspect 调用失败 ", e);
            return buildErrorMsg(ResponseCode.FAILED.code, ResponseCode.FAILED.desc);
        }
 
    }
 
    private void doCheck(Object obj, SupplierCheck，supplierCheck) throws BizException {
        AppAuthRequest authRequest = JSON.parseObject(JSON.toJSONString(obj), AppAuthRequest.class);
        log.info("authRequest = {}", authRequest);
        //白名单校验
        if (supplierCheck.checkIpWhite()) {
            // 白名单业务逻辑
        }
    }

3、创建接口类，并在目标方法上标注自定义注解 SupplierCheck ：

    @PostMapping("/getSupplierOrderDetailInfo")
    @ApiOperation(value = "售卖渠道订单查询", notes = "售卖渠道订单查询")
    @SupplierCheck
    public ApiResultResponse<SupplierOrderDetailResponse> getSupplierOrderDetailInfo(@RequestBody @Valid SupplierOrderDetailRequest request) {
        SupplierOrderDetailResponse response = appVipOrderService.getSupplierOrderDetailInfo(request);
        return ApiResponseUtils.buildSuccessMsg(response);
    }

3、有人会问，上面一个接口设置了多个切面类进行了校验怎么办？这些切面的执行顺序如何管理？

很简单，一个自定义的 AOP 注解可以对应多个切面类，这些切面类执行顺序由 @Order 注解管理，该注解后的数字越小，所在切面类越先执行。

比如上面接口中 @ApiOperation 增强的注解中（第一个实例介绍的）的 @Order(1)，那么这个注解先执行，@SupplierCheck 白名单校验的注解的 @Order(3) 后面执行。