Spring Boot 自定义注解，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 文件中添加依赖：

1. <dependency>
2.     <groupId>org.springframework.boot</groupId>
3.     <artifactId>spring-boot-starter-aop</artifactId>
4. </dependency>
6. <dependency>
7.     <groupId>com.google.code.gson</groupId>
8.     <artifactId>gson</artifactId>
9.     <version>2.8.5</version>
10. </dependency>

复制代码

三、自定义日志注解

让我们来自定义一个日志注解，如下所示：

• ①：什么时候使用该注解，我们定义为运行时；
  
• ②：注解用于什么地方，我们定义为作用于方法上；
  
• ③：注解是否将包含在 JavaDoc 中；
  
• ④：注解名为 WebLog;
  
• ⑤：定义一个属性，默认为空字符串；
  

源代码如下：

1. package site.exception.springbootaopwebrequest.aspect;
2. import java.lang.annotation.*;
3. /**
4. * @date 2023/10/6
5. * @time 下午9:19
6. * @discription
7. **/
8. @Retention(RetentionPolicy.RUNTIME)
9. @Target({ElementType.METHOD})
10. @Documented
11. public @interface WebLog {
12.     /**
13.     * 日志描述信息
14.     * @return
15.     **/
16.     String description() default "";
17. }

复制代码

到这里，一个完整的自定义注解就定义完成了。
四、配置 AOP 切面

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

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

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

• @Before: 在切点之前，织入相关代码；
  
• @After: 在切点之后，织入相关代码;
  
• @AfterReturning: 在切点返回内容后，织入相关代码，一般用于对返回值做些加工处理的场景；
  
• @AfterThrowing: 用来处理当织入的代码抛出异常后的逻辑处理;
  
• @Around: 环绕，可以在切入点前后织入代码，并且可以自由的控制何时执行切点；
  

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

然后，定义 @Around 环绕，用于何时执行切点：

• ①：记录一下调用接口的开始时间；
  
• ②：执行切点，执行切点后，会去依次调用  @Before -> 接口逻辑代码 -> @After -> @AfterReturning；
  
• ③：打印出参；
  
• ④：打印接口处理耗时；
  
• ⑤：返回接口返参结果；
  

再来看看 @Before 方法：

看注释功能说明，因为注释说得还是比较清楚的！
最后，用 @After 来做个收尾：


我们在每个接口的最后，打印日志结束标志。最后再看下项目包结构：

到这里，切面相关的代码就完成了！
上完整代码：

1. package site.exception.springbootaopwebrequest.aspect;
3. import com.google.gson.Gson;
4. import org.aspectj.lang.JoinPoint;
5. import org.aspectj.lang.ProceedingJoinPoint;
6. import org.aspectj.lang.annotation.*;
7. import org.slf4j.Logger;
8. import org.slf4j.LoggerFactory;
9. import org.springframework.context.annotation.Profile;
10. import org.springframework.stereotype.Component;
11. import org.springframework.web.context.request.RequestContextHolder;
12. import org.springframework.web.context.request.ServletRequestAttributes;
14. import javax.servlet.http.HttpServletRequest;
15. import java.lang.reflect.Method;
17. /**
18. * @date 2023/10/6
19. * @time 下午9:19
20. * @discription
21. **/
22. @Aspect
23. @Component
24. @Profile({"dev", "test"})
25. public class WebLogAspect {
27.     private final static Logger logger = LoggerFactory.getLogger(WebLogAspect.class);
28.     /** 换行符 */
29.     private static final String LINE_SEPARATOR = System.lineSeparator();
31.     /** 以自定义 @WebLog 注解为切点 */
32.     @Pointcut("@annotation(site.exception.springbootaopwebrequest.aspect.WebLog)")
33.     public void webLog() {}
35.     /**
36.      * 在切点之前织入
37.      * @param joinPoint
38.      * @throws Throwable
39.      */
40.     @Before("webLog()")
41.     public void doBefore(JoinPoint joinPoint) throws Throwable {
42.         // 开始打印请求日志
43.         ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
44.         HttpServletRequest request = attributes.getRequest();
46.         // 获取 @WebLog 注解的描述信息
47.         String methodDescription = getAspectLogDescription(joinPoint);
49.         // 打印请求相关参数
50.         logger.info("========================================== Start ==========================================");
51.         // 打印请求 url
52.         logger.info("URL            : {}", request.getRequestURL().toString());
53.         // 打印描述信息
54.         logger.info("Description    : {}", methodDescription);
55.         // 打印 Http method
56.         logger.info("HTTP Method    : {}", request.getMethod());
57.         // 打印调用 controller 的全路径以及执行方法
58.         logger.info("Class Method   : {}.{}", joinPoint.getSignature().getDeclaringTypeName(), joinPoint.getSignature().getName());
59.         // 打印请求的 IP
60.         logger.info("IP             : {}", request.getRemoteAddr());
61.         // 打印请求入参
62.         logger.info("Request Args   : {}", new Gson().toJson(joinPoint.getArgs()));
63.     }
65.     /**
66.      * 在切点之后织入
67.      * @throws Throwable
68.      */
69.     @After("webLog()")
70.     public void doAfter() throws Throwable {
71.         // 接口结束后换行，方便分割查看
72.         logger.info("=========================================== End ===========================================" + LINE_SEPARATOR);
73.     }
75.     /**
76.      * 环绕
77.      * @param proceedingJoinPoint
78.      * @return
79.      * @throws Throwable
80.      */
81.     @Around("webLog()")
82.     public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
83.         long startTime = System.currentTimeMillis();
84.         Object result = proceedingJoinPoint.proceed();
85.         // 打印出参
86.         logger.info("Response Args  : {}", new Gson().toJson(result));
87.         // 执行耗时
88.         logger.info("Time-Consuming : {} ms", System.currentTimeMillis() - startTime);
89.         return result;
90.     }
93.     /**
94.      * 获取切面注解的描述
95.      *
96.      * @param joinPoint 切点
97.      * @return 描述信息
98.      * @throws Exception
99.      */
100.     public String getAspectLogDescription(JoinPoint joinPoint)
101.             throws Exception {
102.         String targetName = joinPoint.getTarget().getClass().getName();
103.         String methodName = joinPoint.getSignature().getName();
104.         Object[] arguments = joinPoint.getArgs();
105.         Class targetClass = Class.forName(targetName);
106.         Method[] methods = targetClass.getMethods();
107.         StringBuilder description = new StringBuilder("");
108.         for (Method method : methods) {
109.             if (method.getName().equals(methodName)) {
110.                 Class[] clazzs = method.getParameterTypes();
111.                 if (clazzs.length == arguments.length) {
112.                     description.append(method.getAnnotation(WebLog.class).description());
113.                     break;
114.                 }
115.             }
116.         }
117.         return description.toString();
118.     }
120. }

复制代码

五、怎么使用呢？

因为我们的切点是自定义注解 @WebLog, 所以我们仅仅需要在 Controller 控制器的每个接口方法添加 @WebLog 注解即可，如果我们不想某个接口打印出入参日志，不加注解就可以了：

六、对于文件上传好使不？

是好使的！不论是单文件上传，亦或是多文件上传，切面日志均运行良好，这里测试的东西，小哈就不贴出来了。有兴趣的小伙伴可以试试！
七、只想在开发环境和测试环境中使用？

对于那些性能要求较高的应用，不想在生产环境中打印日志，只想在开发环境或者测试环境中使用，要怎么做呢？我们只需为切面添加 @Profile 就可以了，如下图所示：

这样就指定了只能作用于 dev 开发环境和 test 测试环境，生产环境 prod 是不生效的！
八、多切面如何指定优先级？

假设说我们的服务中不止定义了一个切面，比如说我们针对 Web 层的接口，不止要打印日志，还要校验 token 等。要如何指定切面的优先级呢？也就是如何指定切面的执行顺序？
我们可以通过 @Order(i)注解来指定优先级，注意：i 值越小，优先级则越高。
假设说我们定义上面这个日志切面的优先级为 @Order(10), 然后我们还有个校验 token 的切面 CheckTokenAspect.java，我们定义为了 @Order(11), 那么它们之间的执行顺序如下：

我们可以总结一下：

• 在切点之前，@Order 从小到大被执行，也就是说越小的优先级越高；
  
• 在切点之后，@Order 从大到小被执行，也就是说越大的优先级越高；
  

写在最后

文章持续更新，可以微信搜【小白技术圈】阅读，学习 Java语言可以看发送回复 B01或b01,双手奉上Java相关书籍和面试题！！欢迎大大们催更。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！