Spring Boot @Aspect 切面编程实现访问请求日志记录

aop切面编程想必大家都不陌生了，aspect可以很方便开发人员对请求指定拦截层，一般是根据条件切入到controller控制层，做一些鉴权、分析注解、获取类名方法名参数、记录操作日志等。

在SpringBoot中使用aop首先是要导入依赖如下：

<!-- 切面编程 @Aspect、@Pointcut等依赖 -->
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-aop</artifactId>
</dependency>

然后基本使用如下：

@Aspect
@Component
@Order(1)
public class WebLogAspect {private static final Logger LOGGER = LoggerFactory.getLogger(WebLogAspect.class);@Pointcut("execution(public * flutter.dio.model.controller.*.*(..))")public void webLog() {}@Before("webLog()")public void doBefore(JoinPoint joinPoint) throws Throwable {}@AfterReturning(value = "webLog()", returning = "ret")public void doAfterReturning(Object ret) throws Throwable {}/*** 环绕通知** @param joinPoint* @return* @throws Throwable*/@Around("webLog()")public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {... ...return result;}}

@Pointcut 定义切入点标记注解,比如我这里是指定路径下的controller

其他注解描述

• @Before：前置增强，在某个JoinPoint执行前的增强

• @After：final增强，不管抛异常还是正常退出都执行的增强

• @AfterReturning：后置增强，方法正常退出时执行

• @AfterThrowing：异常抛出增强，抛出异常后执行

• @Around：环绕增强，包围一个连接点的增强，最强大的一个方式，且常用

• ProceedingJoinPoint 和 JoinPoint 是 Spring 中 AOP 框架中两个常用的接口，它们的主要区别在于使用场景不同。

• JoinPoint 是 Spring AOP 中最常用的接口，它表示在程序执行过程中明确的点。这个接口提供了许多方法，可以访问到当前被拦截方法的信息。

• ProceedingJoinPoint 是一个特殊的 JoinPoint，它表示可以继续进行被拦截方法的执行。它提供了一个 proceed() 方法，可以执行被拦截的方法。这个接口只能在 @Around 注解修饰的方法中使用。

所以我在 doAround 方法中记录日志信息:

//记录请求开始时间long startTime = System.currentTimeMillis();//获取当前请求对象ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();HttpServletRequest request = attributes.getRequest();//记录请求信息(通过Logstash传入Elasticsearch)WebLog webLog = new WebLog();Object result = joinPoint.proceed();Signature signature = joinPoint.getSignature();MethodSignature methodSignature = (MethodSignature) signature;//获取当前请求方法Method method = methodSignature.getMethod();if (method.isAnnotationPresent(ApiOperation.class)) {ApiOperation log = method.getAnnotation(ApiOperation.class);webLog.setDescription(log.value());}long endTime = System.currentTimeMillis();String urlStr = request.getRequestURL().toString();webLog.setBasePath(StrUtil.removeSuffix(urlStr, URLUtil.url(urlStr).getPath()));//请求IPwebLog.setIp(request.getRemoteUser());//请求方法webLog.setMethod(request.getMethod());//请求参数webLog.setParameter(getParameter(method, joinPoint.getArgs()));//请求结果webLog.setResult(result);//请求时间webLog.setStartTime(startTime);webLog.setSpendTime((int) (endTime - startTime));//请求地址webLog.setUri(request.getRequestURI());webLog.setUrl(request.getRequestURL().toString());LOGGER.info("{}", JSONUtil.parse(webLog));

getParameter 方法主要用来实现获取请求参数，代码如下：

/*** 根据方法和传入的参数获取请求参数*/
private Object getParameter(Method method, Object[] args) {List<Object> argList = new ArrayList<>();Parameter[] parameters = method.getParameters();for (int i = 0; i < parameters.length; i++) {//将RequestBody注解修饰的参数作为请求参数RequestBody requestBody = parameters[i].getAnnotation(RequestBody.class);if (requestBody != null) {argList.add(args[i]);}//将RequestParam注解修饰的参数作为请求参数RequestParam requestParam = parameters[i].getAnnotation(RequestParam.class);if (requestParam != null) {Map<String, Object> map = new HashMap<>();String key = parameters[i].getName();if (!ObjectUtils.isEmpty(requestParam.value())) {key = requestParam.value();}map.put(key, args[i]);argList.add(map);}}if (argList.size() == 0) {return null;} else if (argList.size() == 1) {return argList.get(0);} else {return argList;}
}

执行一个请求，控制台输入日志如下：

我在这里把日志封装入了 WebLog 自定义类中，大家可以根据实际情况来对日志进行保存处理

import lombok.Data;
@Data
public class WebLog {/*** 操作描述*/private String description;/*** 操作用户*/private String username;/*** 操作时间*/private Long startTime;/*** 消耗时间*/private Integer spendTime;/*** 根路径*/private String basePath;/*** URI*/private String uri;/*** URL*/private String url;/*** 请求类型*/private String method;/*** IP地址*/private String ip;private Object parameter;private Object result;
}