【大白话系列】-- AOP实战

本文主要介绍如何优雅的在Spring Boot中使用自定义注解，AOP切面统一打印出入参日志

一. 首先看看切面日志输出效果：

 

从上图中可以看到，每个对于每个请求，开始与结束一目了然，并且打印了以下参数：

• URL: 请求接口地址；

• Description: 接口的中文说明信息；

• HTTP Method: 请求的方法，是 POST, GET, 还是 DELETE 等；

• Class Method: 被请求的方法路径 : 包名 + 方法名;

• IP: 请求方的 IP 地址；

• Request Args: 请求入参，以 JSON 格式输出；

• Response Args: 响应出参，以 JSON 格式输出；

• Time-Consuming: 请求耗时，以此估算每个接口的性能指数；

二、添加 AOP Maven 依赖

在项目 pom.xml 文件中添加依赖：

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

		<!-- 用于日志切面中，以 json 格式打印出入参 -->
		<dependency>
			<groupId>com.google.code.gson</groupId>
			<artifactId>gson</artifactId>
			<version>2.8.5</version>
		</dependency>

三、自定义一个日志注解

首先自定义一个日志注解，如下所示：

 

• Retention注解：使用该注解的时机，我们定义为运行时；

• Target注解：使用注解的地点，此处我们定义为作用于方法上；@Target({ElementType.METHOD, ElementType.TYPE})即表示可以作用于方法或者类、接口等。

• @interface：使用@interface即自定义一个注解，注解名为 WebLog;

• body：定义一个属性，默认为空字符串；

源代码如下：

package com.example.demo.annotion;

import java.lang.annotation.*;

/**
 * 自定义一个注解
 *
 * @author lupeng11@meituan.com
 * @date 2020/5/7 15:20
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
@Documented
public @interface WebLog {
    /**
     * 日志描述信息
     */
    String description() default "";
}

到这里，一个完整的自定义注解就定义完成了。

四、配置 AOP 切面

在配置 AOP 切面之前，我们需要了解下 aspectj 相关注解的作用：

• @Aspect：声明该类为一个注解类；

• @Pointcut：定义一个切点，后面跟随一个表达式，表达式可以定义为切某个注解，也可以切某个 package 下的方法；

切点定义好后，就是围绕这个切点做文章了：

• @Before: 在切点之前，织入相关代码；

• @After: 在切点之后，织入相关代码;

• @AfterReturning: 在切点返回内容后，织入相关代码，一般用于对返回值做些加工处理的场景；

• @AfterThrowing: 用来处理当织入的代码抛出异常后的逻辑处理;

• @Around: 环绕，可以在切入点前后织入代码，并且可以自由的控制何时执行切点；

  

 

接下来，定义一个 WebLogAspect.java 切面类，声明一个切点：

 

然后，定义 @Around 环绕，用于记录调用时间和处理耗时：

​

• ①：记录一下调用接口的开始时间；

• ②：执行切点，执行切点后，会去依次调用 @Before -> 接口逻辑代码 -> @After -> @AfterReturning；

   

接下来是 @Before 方法：​

最后是 @After ：

​

在最后进行换行，这样日志看的一目了然！

上 WebLogAspect.java 完整代码

package com.example.demo.aspect;

import com.example.demo.annotion.WebLog;
import com.google.gson.Gson;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Profile;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import java.lang.reflect.Method;

/**
 * 定义一个切面
 *
 * @author lupeng11@meituan.com
 * @date 2020/5/7 15:24
 */
@Aspect
@Component
public class WebLogAspect {
    private final static Logger logger = LoggerFactory.getLogger(WebLogAspect.class);
    /** 换行符 */
    private static final String LINE_SEPARATOR = System.lineSeparator();

    /** 以自定义的WebLog为切点，即使用@webLog的地方**/
    @Pointcut("@annotation(com.example.demo.annotion.WebLog)")
    public void webLog(){}

    /**
     * 环绕
     * @param proceedingJoinPoint
     * @return
     * @throws Throwable
     */
    @Around("webLog()")
    public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
        long startTime = System.currentTimeMillis();
        Object result = proceedingJoinPoint.proceed();
        // 打印出参
        logger.info("Response Args  : {}", new Gson().toJson(result));
        // 执行耗时
        logger.info("Time-Consuming : {} ms", System.currentTimeMillis() - startTime);
        return result;
    }

    /**
     * 在切点之前织入
     * @param joinPoint
     * @throws Throwable
     */
    @Before("webLog()")
    public void doBefore(JoinPoint joinPoint) throws Throwable {
        // 开始打印请求日志
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();

        // 获取 @WebLog 注解的描述信息
        String methodDescription = getAspectLogDescription(joinPoint);

        // 打印请求相关参数
        logger.info("========================================== Start ==========================================");
        // 打印请求 url
        logger.info("URL            : {}", request.getRequestURL().toString());
        // 打印描述信息
        logger.info("Description    : {}", methodDescription);
        // 打印 Http method
        logger.info("HTTP Method    : {}", request.getMethod());
        // 打印调用 controller 的全路径以及执行方法
        logger.info("Class Method   : {}.{}", joinPoint.getSignature().getDeclaringTypeName(), joinPoint.getSignature().getName());
        // 打印请求的 IP
        logger.info("IP             : {}", request.getRemoteAddr());
        // 打印请求入参
        logger.info("Request Args   : {}", new Gson().toJson(joinPoint.getArgs()));
    }

    /**
     * 在切点之后织入
     * @throws Throwable
     */
    @After("webLog()")
    public void doAfter() throws Throwable {
        // 接口结束后换行，方便分割查看
        logger.info("=========================================== End ===========================================" + LINE_SEPARATOR);
    }



    /**
     * 获取切面注解的描述
     *
     * @param joinPoint 切点
     * @return 描述信息
     * @throws Exception
     */
    public String getAspectLogDescription(JoinPoint joinPoint) throws Exception {
        String targetName = joinPoint.getTarget().getClass().getName();
        String methodName = joinPoint.getSignature().getName();
        Object[] arguments = joinPoint.getArgs();
        Class targetClass = Class.forName(targetName);
        Method[] methods = targetClass.getMethods();
        StringBuilder description = new StringBuilder("");
        for (Method method : methods) {
            if (method.getName().equals(methodName)) {
                Class[] clazzs = method.getParameterTypes();
                if (clazzs.length == arguments.length) {
                    description.append(method.getAnnotation(WebLog.class).description());
                    break;
                }
            }
        }
        return description.toString();
    }


}

以上就是用Spring Boot自定义注解，切面完成日记记录的全部过程。

 

代码补充：

包结构：

​

 

User.java

以上就是用Spring Boot自定义注解，切面完成日记记录的全部过程。

package com.example.demo.entity;

import lombok.Data;

import java.util.Date;

/**
 * 功能说明
 *
 * @author lupeng11@meituan.com
 * @date 2020/5/7 15:54
 */
@Data
public class User {
    /**
     * 用户名
     */
    private String username;
    /**
     * 密码
     */
    private String password;
    /**
     * 创建时间
     */
    private Date createTime;
}

TestController.java

package com.example.demo.controller;

import com.example.demo.annotion.WebLog;
import com.example.demo.entity.User;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.*;

/**
 * 功能说明
 *
 * @author lupeng11@meituan.com
 * @date 2020/5/7 15:53
 */
@RestController
public class TestController {
    private final static Logger logger = LoggerFactory.getLogger(TestController.class);

    /**
     * POST 方式接口测试
     * @param user
     * @return
     */
    @PostMapping("/user/login")
    @WebLog(description = "请求了用户登录接口")
    public User userLogin(@RequestBody User user) {
        logger.info("user login ...");
        return user;
    }

    /**
     * GET 方式接口测试
     * @return
     */
    @GetMapping("/user/{id}")
    @WebLog(description = "请求了用户登录接口")
    public String findUserInfo(@PathVariable("id") String userId) {
        logger.info("find user info ...");
        return "success";
    }

    /**
     * GET 方式接口测试
     * @return
     */
    @GetMapping("/test")
    public String test() {
        logger.info("testGet ...");
        return "success";
    }
}