SpringBoot2中如何實現按API接口路徑動態保存Log4j2日志?

SpringBoot2中如何實現按API接口路徑動態保存Log4j2日志?

springBoot2應用中基于API接口路徑的log4j2動態日志記錄

本文介紹如何在SpringBoot2應用中利用Log4j2實現動態日志記錄,并根據API接口路徑將日志保存到指定文件。這不同于簡單的RollingFileAppender,需要一種機制根據運行時請求動態創建日志文件。

用戶需求:根據API接口地址(例如/paypage/createorder/addsave和/merchant/goodlist/getlistbyquery?currentpage=1&size=10)將日志分別保存到JAR包目錄下的/logs/paypage/createorder/addsave/yyyy-mm-dd.log和/logs/merchant/goodlist/getlistbyquery/yyyy-mm-dd.log文件中。用戶嘗試在main函數和攔截器中動態設置Log4j2配置文件文件名,但由于RollingFileAppender在初始化時就確定了文件名,因此未能成功。

解決方案:使用Log4j2的RoutingAppender。RoutingAppender允許根據運行時條件將日志消息路由到不同的Appender。結合ThreadContext,我們可以將API路徑作為路由鍵,動態生成日志文件。

實現步驟:

  1. 配置RoutingAppender: 在log4j-spring.xml中配置RoutingAppender,并使用元素定義路由規則。一個重要的規則應使用元素且不設置key屬性,匹配所有未被其他規則匹配的請求,并根據ThreadContext中的路由鍵動態生成文件名。配置示例:
<configuration monitorInterval="5" status="debug">   <appenders>     <routing name="routing">       <routes pattern="${ctx:routingkey}">         <route>           <rollingFile filename="./logs/${ctx:routingkey}/${date:yyyy-mm-dd}.log"                        filePattern="./logs/${date:yyyy-mm}/${ctx:routingkey}-%d{yyyy-mm-dd}-%i.log.gz"                        name="rolling-${ctx:routingkey}">             <PatternLayout pattern="%d{iso8601} [%t] %p %c{3} - %m%n"/>             <Policies>               <TimeBasedTriggeringPolicy interval="1" modulate="true"/>               <SizeBasedTriggeringPolicy size="10MB"/>             </Policies>           </rollingFile>         </route>       </routes>     </routing>   </appenders>   <loggers>     <root level="info">       <appender-ref ref="routing"/>     </root>   </loggers> </configuration>
  1. 攔截器設置路由鍵: 創建一個攔截器,在preHandle方法中獲取API路徑,并將其設置為ThreadContext中名為routingkey的鍵值。在postHandle中移除該鍵,避免干擾其他請求。代碼示例:
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");     } }
  1. 注冊攔截器: 在Spring配置類中注冊該攔截器,使其攔截所有請求。

通過以上步驟,即可實現根據API接口路徑動態創建日志文件,并將日志保存到對應路徑。 請確保/logs目錄已創建,且應用具有寫入權限。 日志文件路徑中避免特殊字符,以免出錯。

? 版權聲明
THE END
喜歡就支持一下吧
點贊5 分享