标签导航：

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目录已创建，且应用具有写入权限。 日志文件路径中避免特殊字符，以免出错。