17370845950

Spring Boot 2 与 Log4j2：基于 API 接口路径的动态日志记录

本文介绍如何在 Spring Boot 2 应用中利用 Log4j2 实现动态日志记录，并根据 API 接口路径将日志保存到指定文件。 目标是解决如何将不同 API 接口的日志分别存储到不同目录下的问题，例如 /paypage/createorder/addsave 接口的日志应保存至 jar包目录/logs/paypage/createorder/addsave/yyyy-mm-dd.log。

直接修改 Log4j2 配置文件在运行时无效，因为配置文件通常在应用启动时加载。 因此，本文采用 Log4j2 的 RoutingAppender 来解决此问题。 RoutingAppender 允许根据运行时条件将日志路由到不同的 Appender。

解决方案：结合 RoutingAppender 和 ThreadContext

我们使用 ThreadContext 在拦截器中设置上下文变量 routingkey，其值为 API 接口路径。 RoutingAppender 根据 routingkey 的值将日志路由到不同的 RollingFileAppender。

1. Log4j2 配置 (log4j-spring.xml):

以下是一个 log4j-spring.xml 配置文件片段示例：

2. 拦截器 (Log4j2Interceptor):

拦截器用于获取 API 接口路径并将其存储到 ThreadContext 中。

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); // 注意：此处 key 为 routingkey
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        ThreadContext.remove("routingkey");
    }
}

工作原理:

• 拦截器在每个请求前执行，获取请求路径并将其作为 routingkey 存储到 ThreadContext。
• Log4j2 使用 RoutingAppender，根据 ThreadContext 中的 routingkey 选择对应的 RollingFileAppender。
• 日志被写入到根据 routingkey (API 路径) 动态生成的日志文件中。
• 拦截器在请求处理后清除 routingkey，避免干扰后续请求。

注意事项:

• 需要确保 ./logs 目录存在，并且应用有写入该目录的权限。
• 可以根据实际需求调整日志文件路径、文件名格式以及 RollingFileAppender 的其他配置参数。
• routingkey 的大小写敏感，请与配置文件中的 pattern 保持一致。

此方法有效地解决了在 Spring Boot 2 中使用 Log4j2 根据 API 接口路径动态保存日志的问题，实现了灵活的日志管理。