Spring Boot 2.0 中使用 AOP 切面统一处理请求日志,打印进出参相关参数。
一、先看看日志输出效果
Spring Boot AOP 打印日志
可以看到,每个对于每个请求,开始与结束一目了然,并且打印了以下参数:
URL: 请求接口地址;
HTTP Method: 请求的方法,是 POST, GET, 还是 DELETE 等;
Class Method: 对应 Controller 的全路径以及调用的哪个方法;
IP: 请求 IP 地址;
Request Args: 请求入参,以 JSON 格式输出;
Response Args: 响应出参,以 JSON 格式输出;
Time-Consuming: 请求耗时;
效果应该还不错吧!接下来就让我们一步一步去实现该功能, 首先,新建一个 Spring Boot Web 项目。
二、添加 Maven 依赖
在项目 pom.xml 文件中添加依赖:
```xml
<!-- aop 依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<!-- 用于日志切面中,以 json 格式打印出入参(本来使用阿里的 FASTJSON, 但是对于文件上传的接口,打印参数会报错,换为 Gson) -->
<dependency>
<groupId>com.google.code.gson</groupId>
<artifactId>gson</artifactId>
<version>2.8.5</version>
</dependency>
三、配置 AOP 切面
在配置 AOP 切面之前,我们需要了解下 aspectj 相关注解的作用:
@Aspect:声明该类为一个注解类;
@Pointcut:定义一个切点,后面跟随一个表达式,表达式可以定义为某个 package 下的方法,也可以是自定义注解等;
切点定义好后,就是围绕这个切点做文章了:
@Before: 在切点之前,织入相关代码;
@After: 在切点之后,织入相关代码;
@AfterReturning: 在切点返回内容后,织入相关代码,一般用于对返回值做些加工处理的场景;
@AfterThrowing: 用来处理当织入的代码抛出异常后的逻辑处理;
@Around: 在切入点前后织入代码,并且可以自由的控制何时执行切点;
接下来,定义一个 WebLogAspect.java 切面类,代码如下:
```java
package com.job.campus.cmsapi.config;
import com.google.gson.Gson;
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.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import javax.servlet.http.HttpServletRequest;
/**
* @author Thomas
* @date 2020/01/04
* @discription 切面类
**/
@Aspect
@Component
public class WebLogAspect {
private final static Logger logger = LoggerFactory.getLogger(WebLogAspect.class);
/** 以 controller 包下定义的所有请求为切入点 */
@Pointcut("execution(public * com.job.campus.cmsapi.controller..*.*(..))")
public void webLog() {}
/**
* 在切点之前织入
* @param joinPoint
* @throws Throwable
*/
@Before("webLog()")
public void doBefore(JoinPoint joinPoint) throws Throwable {
// 开始打印请求日志
ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
HttpServletRequest request = attributes.getRequest();
// 打印请求相关参数
logger.info("========================================== Start ==========================================");
// 打印请求 url
logger.info("请求URL : {}", request.getRequestURL().toString());
// 打印 Http method
// logger.info("HTTP Method : {}", request.getMethod());
// 打印调用 controller 的全路径以及执行方法
logger.info("请求接口: {}.{}", joinPoint.getSignature().getDeclaringTypeName(), joinPoint.getSignature().getName());
// 打印请求的 IP
// logger.info("IP : {}", request.getRemoteAddr());
// 打印请求入参
logger.info("请求参数: {}", new Gson().toJson(joinPoint.getArgs()));
}
/**
* 在切点之后织入
* @throws Throwable
*/
@After("webLog()")
public void doAfter() throws Throwable {
logger.info("=========================================== End ===========================================");
}
/**
* 环绕
* @param proceedingJoinPoint
* @return
* @throws Throwable
*/
@Around("webLog()")
public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
long startTime = System.currentTimeMillis();
Object result = proceedingJoinPoint.proceed();
// 打印出参
logger.info("返回参数: {}", new Gson().toJson(result));
// 执行耗时
logger.info("请求耗时: {} ms", System.currentTimeMillis() - startTime);
// 每个请求之间空一行
logger.info("");
return result;
}
}
我们通过 @Aspect 声明了 WebLogAspect.java 为切面类,之后,通过 @Pointcut 定义了打印请求日志的切点,切点为 site.exception.springbootaopwebrequest.controller 包下所有的请求接口。
切点定义好后,我们通过 @Before 在切点之前打印请求的相关参数,通过 @Around 打印了请求接口的耗时时间,最后通过 @After 做了请求的收尾工作。
到这里,切面相关的代码就完成了!