开启掘金成长之旅！这是我参与「掘金日新计划 · 12 月更文挑战」的第5天，点击查看活动详情
在开发中，除了系统日志外，很多时候我们还需要记录业务日志。业务日志的记录通常不需要很精细，仅记录关键状态改变的时间点、及前后数据变化即可。当然语言为Java，基于Spring框架。
我们学习Spring AOP时，了解到其应用场景中，比较重要的一个就是可以用来做日志记录。这种的话，可以根据切入点(Point Cut)类型的不同来达到不同的效果。比如可以拦截所有的Controller来记录请求来源IP、请求参数、响应结果、耗时等。
简单的示例，并非本文重点。通过拦截所有的Controller控制器，来记录所有的输入、输出。
@Slf4j
@Aspect
@Order(1)
@Component
public class WebLogAspect {
private static final Set<String> EXCLUDE_LOG_URIS = Set.of(
);
@Pointcut("execution(public * com.example.*.controller.*.*(..))")
public void logPc() {}
@Before("logPc()")
public void doBefore(JoinPoint jp) {
final HttpServletRequest request = getRequest();
if (Objects.isNull(request)) {
return;
}
//long startTime = System.currentTimeMillis();
final WebLog.WebLogBuilder wlb = WebLog.builder();
/* 配合Swagger使用
final MethodSignature signature = (MethodSignature) jp.getSignature();
final Method method = signature.getMethod();
if (method.isAnnotationPresent(ApiOperation.class)) {
ApiOperation ao = method.getAnnotation(ApiOperation.class);
wlb.desc(ao.value());
}
*/final String requestURI = request.getRequestURI();
// 请求入参if (EXCLUDE_LOG_URIS.contains(requestURI)) {
wlb.parameter("***");
} else {
wlb.parameter(jp.getArgs());
}
// 其他参数
wlb.beginTime(startTime);
wlb.methodName(request.getMethod());
wlb.uri(requestURI).ip(CommonUtil.getIpAddress(request));
// 日志输出final WebLog webLog = wlb.build();
log.info("[接口入参] {}", JSONUtil.toJsonStr(webLog));
}
@Around("logPc()")
public Object doAround(ProceedingJoinPoint jp) throws Throwable {
final HttpServletRequest request = getRequest();
if (Objects.isNull(request)) {
return jp.proceed();
}
//final WebLog.WebLogBuilder wlb = WebLog.builder();
long startTime = System.currentTimeMillis();
final Object proceed = jp.proceed();
long endTime = System.currentTimeMillis();
/* 配合Swagger使用
final MethodSignature signature = (MethodSignature) jp.getSignature();
final Method method = signature.getMethod();
if (method.isAnnotationPresent(ApiOperation.class)) {
ApiOperation ao = method.getAnnotation(ApiOperation.class);
wlb.desc(ao.value());
}
*/final String requestURI = request.getRequestURI();
// 请求入参if (EXCLUDE_LOG_URIS.contains(requestURI)) {
wlb.parameter("***").result("***");
} else {
wlb.parameter(jp.getArgs()).result(proceed);
}
// 其他参数
wlb.beginTime(startTime).costTime(endTime-startTime);
wlb.methodName(request.getMethod());
wlb.uri(requestURI).ip(CommonUtil.getIpAddress(request));
// 日志输出final WebLog webLog = wlb.build();
log.info("[接口出参] {}", JSONUtil.toJsonStr(webLog));
//return proceed;
}
private HttpServletRequest getRequest() {
ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
return Optional.ofNullable(attributes).map(ServletRequestAttributes::getRequest).orElse(null);
}
}
复制代码
部分日志重复，在@Before和@Around两处记录。在控制器内可能抛出一些RunTimeException这些会由ExceptionHandler全局异常处理器拦截处理，这里不再细讲。后续单独一篇文章讲解。
在实际使用时，发现有些不重要但查询数据量比较大的接口。比如查询某某分页数据，会导致parameter或result俩参数打印出大量字符串。所以加了一层判断，遇到这种接口忽略其参数和返回值。但保留其他数据。
其实这样打印日志，是存在一些问题的：
lineNo打印。@Slf4j
@RestController
@RequestMapping("leads")
@RequiredArgsConstructor
public class LeadController {
private final LeadService leadService;
@PostMapping
public RestResp<Boolean> addLeads(@Validated @RequestBody LeadReqVO vo) {
final boolean result = leadService.addLead(vo);
return RestResp.ok(result);
}
}
复制代码
模拟请求
### 创建线索
POST <http://localhost:28800/leads>
Content-Type: application/json
{
"username": "小明的妈妈",
"phone": "+5633089972",
"email": "[email protected]",
"channel": "OA-XX-XX",
"subject": "Chinese"
}
复制代码
查看日志
2022-11-30 15:13:36.737 INFO 87959 --- [io-28800-exec-1] c.e.s.c.WebLogAspect : [接口入参] {"costTime":0,"parameter":[{"phone":"+5633089972","subject":"Chinese","channel":"OA-XX-XX","email":"[email protected]","username":"小明的妈妈"}],"ip":"127.0.0.1","methodName":"POST","beginTime":1669792416714,"uri":"/leads"}
2022-11-30 15:13:36.752 INFO 87959 --- [io-28800-exec-1] c.e.s.c.WebLogAspect : [接口出参] {"result":{"msg":"ok","code":200,"data":false},"costTime":37,"parameter":[{"phone":"+5633089972","subject":"Chinese","channel":"OA-XX-XX","email":"[email protected]","username":"小明的妈妈"}],"ip":"127.0.0.1","methodName":"POST","beginTime":1669792416714,"uri":"/leads"}
复制代码