Spring Boot 2中如何使用Log4j2实现按API接口路径动态保存日志?

Spring Boot 2中如何使用Log4j2实现按API接口路径动态保存日志?

spring Boot 2结合log4j2实现API接口路径动态日志保存

本文介绍如何在spring boot 2应用中利用Log4j2,根据API接口路径动态生成并保存日志文件。这需要比简单使用RollingFileAppender更灵活的日志记录机制。

目标:为每个API接口(例如/paypage/createorder/addsave,/merchant/goodlist/getlistbyquery)创建独立的日志文件,保存在jar包目录/logs/接口路径/yyyy-mm-dd.log下。

问题:直接在main函数或拦截器中修改Log4j2配置文件文件名无效,因为配置文件加载时机过早。

解决方案:使用Log4j2的RoutingAppender。RoutingAppender根据运行时条件将日志路由到不同的Appender。结合ThreadContext,我们可以将API路径作为路由键,动态控制日志文件路径。

实现步骤:

  1. 配置RoutingAppender: 在log4j-spring.xml中配置RoutingAppender,定义路由规则。规则根据ThreadContext中的键值匹配,将日志路由到对应的RollingFileAppender。${ctx:routingkey}获取运行时动态设置的路由键(API路径)。
<Routing name="routing">   <Routes pattern="${ctx:routingkey}">     <Route>       <RollingFile name="rolling-${ctx:routingkey}"                    filename="./logs/${ctx:routingkey}/${date:yyyy-mm-dd}.log"                    filePattern="./logs/${date:yyyy-mm}/${ctx:routingkey}-%d{yyyy-mm-dd}-%i.log.gz">         <PatternLayout pattern="%d{iso8601} [%t] %p %c{3} - %m%n"/>         <Policies>           <TimeBasedTriggeringPolicy interval="1" modulate="true"/>           <SizeBasedTriggeringPolicy size="10MB"/>         </Policies>       </RollingFile>     </Route>   </Routes> </Routing>
  1. 拦截器设置路由键: 创建一个拦截器,在preHandle方法中使用ThreadContext.put(“routingkey”, apiPath)设置路由键(apiPath为API接口路径)。在postHandle方法中使用ThreadContext.remove(“routingkey”)清除路由键,避免影响后续请求。
public class Log4j2Interceptor implements HandlerInterceptor {     @Override     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {         String apiPath = request.getRequestURI();         ThreadContext.put("ROUTINGKEY", apiPath);         return true;     }      @Override     public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {         ThreadContext.remove("ROUTINGKEY");     } }

通过以上步骤,Spring Boot 2应用即可根据API接口路径动态生成日志文件,实现更精细的日志管理。 请确保日志目录存在且具有写入权限。 RoutingAppender的路由规则可根据实际需求调整。

© 版权声明
THE END
喜欢就支持一下吧
点赞6 分享