- 记录工具
- 切面
- logback配置
- 测试
目标:
统计rest接口请求参数,请求地址,请求IP,响应数据,响应时间。方便后续问题排查,以及性能的总体分析。
- 基于springboot
- 会使用面向切面编程
- 基于logback,使用slf4j
package top.lel.ft.config.aop;
import com.alibaba.fastjson.JSON;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.MDC;
import org.springframework.stereotype.Component;
import top.lel.ft.common.utils.IpUtils;
import top.lel.ft.framework.BaseController;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
@Slf4j
@Aspect
@Component
public class UrlLogAspect {
// 使用ThreadLocal记录第一次的请求时间, 统计接口响应时间
// 也可用环绕通知统计接口响应时间
final ThreadLocal tl = new ThreadLocal<>();
// 作用于controller的切点
@Pointcut("execution(public * top.lel.ft.controller.*.*(..))" +
"|| execution(public * top.lel.ft.web.*.*(..))")
public void controllerAspect() {
}
// 记录IP,日志,请求参数
@Before(value = "controllerAspect()")
public void methodBefore(JoinPoint joinPoint) {
List paramList = new ArrayList<>();
Object[] args = joinPoint.getArgs();
if (args != null) {
for (Object arg : args) {
if (!isOriginType(arg)) {
paramList.add(JSON.toJSONString(arg));
}
}
}
String methodName = joinPoint.getSignature().getName();
HttpServletRequest httpReq = BaseController.getServletReq();
String ipAddress = IpUtils.getIpAddr(httpReq);
// 日志增强实现
MDC.put("ip", ipAddress);
MDC.put("traceId", UUID.randomUUID().toString().replaceAll("-", ""));
log.debug("请求路径: {}, 请求方法: {}, 请求参数: {}, 请求IP: {}", httpReq.getRequestURI(), methodName, String.join(", ", paramList), ipAddress);
tl.set(System.currentTimeMillis());
}
@AfterReturning(pointcut = "controllerAspect()", returning = "retVal")
public void afterRet(Object retVal) {
log.info("响应时间: {}毫秒, 响应内容: {}", System.currentTimeMillis() - tl.get(), JSON.toJSONString(retVal));
tl.remove();
MDC.clear();
}
private boolean isOriginType(Object e) {
return e instanceof HttpServletRequest || e instanceof HttpSession;
}
}
logback配置
application.yaml 配置logback.logPath
测试${log.pattern} ${logPath}/${appName}_server.log ${logPath}/%d{yyyyMMdd}/${appName}_server.%i.log 60 50MB ${log.pattern} DEBUG ${logPath}/${appName}_error.log ${logPath}/%d{yyyyMMdd}/${appName}_error.%i.log 60 50MB ${log.pattern} ERROR
or



