在Web应用程序中,对Web请求日志的记录可以辅助开发人员快速的找到问题并且解决问题。同时对请求日志的请求处理时间的分析也可以准确的找到系统的并发瓶颈可以优化系统性能,通过日志分析还可以发现一些Web攻击行为保证系统的安全性。最重要的一点就是支持大数据分析,通过对用户请求的分析来进行用户推荐系统的建设。
而AOP技术是在SpringBoot中常用的日志记录技术,我们可以使用AOP来完成对于Web请求日志的统一管理处理,下面我们就来看看如何在SpringBoot应用程序中通过AOP技术来实现Web请求日志的记录。
引入依赖
第一步、就是在pom.xml文件中引入关于Spring AOP和Spring Boot Starter Web依赖配置,如下所示。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
定义AOP切面
这里我们通过最简单的方式来对所有的Controller层的业务处理类来进行切面切入,如下所示。通过@Aspect注解来定义切面逻辑。
@Aspect
@Component
public class WebLogAspect {
private static final Logger logger = LoggerFactory.getLogger(WebLogAspect.class);
@Pointcut("execution(public * com.yourpackage.controller..*.*(..))")
public void webLog() {}
@Before("webLog()")
public void doBefore(JoinPoint joinPoint) throws Throwable {
// 接收到请求,记录请求内容
ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
HttpServletRequest request = attributes.getRequest();
// 记录下请求内容
logger.info("URL : " + request.getRequestURL().toString());
logger.info("HTTP_METHOD : " + request.getMethod());
logger.info("IP : " + request.getRemoteAddr());
logger.info("CLASS_METHOD : " + joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
logger.info("ARGS : " + java.util.Arrays.toString(joinPoint.getArgs()));
}
@AfterReturning(returning = "ret", pointcut = "webLog()")
public void doAfterReturning(Object ret) throws Throwable {
// 处理完请求,返回内容
logger.info("RESPONSE : " + ret);
}
@AfterThrowing(pointcut = "webLog()", throwing = "e")
public void doAfterThrowing(Throwable e) throws Throwable {
// 记录异常信息
logger.error("EXCEPTION : " + e.getMessage());
}
@Around("webLog()")
public Object doAround(ProceedingJoinPoint pjp) throws Throwable {
long startTime = System.currentTimeMillis();
Object result = pjp.proceed();
long elapsedTime = System.currentTimeMillis() - startTime;
logger.info("TIME TAKEN : " + elapsedTime + " ms");
return result;
}
}
在代码中使用了使用了@Pointcut注解定义了一个切点,然后通过execution(public * com.yourpackage.controller..*.*(..))进行匹配,这里需要将包路径改成自己业务系统的包路径。
然后通过@Before、@AfterReturning、@AfterThrowing、@Around注解分别在切点执行之前、切点正常返回之后,和切点发生异常的时候进行记录处理操作。
在实际使用的时候,可以根据实际需求进行调整,例如增加更多详细信息,可以修改日志的格式等操作,或者是将日志直接通过异步的方式存储到持久化存储器中,要确保在生产环境中不会记录敏感信息
总结
通过上面的这种方式,我们就实现了对所有通过Controller的请求进行了统一的日志记录,通过详细的日志记录,我们可以监控系统运行的情况,以及能够利用日志信息快速的定位问题并且解决问题,同时通过异常请求的监控也可以保护系统不会受到一些异常的攻击,在实际开发中,通过AOP技术记录日志是一种常见业务处理方式,当然还有其他的处理方式,有兴趣的读者可以自己了解一下。