如何为Spring Boot应用配置嵌入式与外部Tomcat通用的访问日志格式

问题原因 #

Spring Boot的server.tomcat.accesslog.*系列配置仅对嵌入式Tomcat生效，部署到外部独立Tomcat时，这些配置会被忽略，外部Tomcat将使用自身默认的访问日志格式。

可行解决方案 #

方案1：代码层面统一配置（无需修改外部Tomcat）

通过自定义配置类，同时适配嵌入式和外部Tomcat的访问日志Valve，确保两者使用相同的日志格式：

import org.apache.catalina.valves.AccessLogValve;
import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory;
import org.springframework.boot.web.server.WebServerFactoryCustomizer;
import org.springframework.boot.web.servlet.ServletContextInitializer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.servlet.ServletContext;
import javax.servlet.ServletException;

@Configuration
public class AccessLogConfig {

    // 适配嵌入式Tomcat
    @Bean
    public WebServerFactoryCustomizer<TomcatServletWebServerFactory> tomcatAccessLogCustomizer() {
        return factory -> {
            AccessLogValve valve = new AccessLogValve();
            valve.setEnabled(true);
            valve.setDirectory("log");
            valve.setPattern("%h %l %u [%t] \"%r\" %s %b \"%{Referer}i\" \"%{User-Agent}i\" %D [%I] \"%{Host}i\"");
            valve.setPrefix("localhost_access_log");
            valve.setSuffix(".txt");
            factory.addEngineValves(valve);
        };
    }

    // 适配外部Tomcat
    @Bean
    public ServletContextInitializer externalTomcatAccessLogInitializer() {
        return servletContext -> {
            org.apache.catalina.Context context = (org.apache.catalina.Context) servletContext.getAttribute("org.apache.catalina.core.ApplicationContextFacade.CONTEXT");
            if (context != null) {
                AccessLogValve valve = new AccessLogValve();
                valve.setEnabled(true);
                valve.setDirectory("log");
                valve.setPattern("%h %l %u [%t] \"%r\" %s %b \"%{Referer}i\" \"%{User-Agent}i\" %D [%I] \"%{Host}i\"");
                valve.setPrefix("localhost_access_log");
                valve.setSuffix(".txt");
                context.getParent().getParent().addValve(valve);
            }
        };
    }
}

• 该方案通过代码统一日志配置逻辑，无需修改外部Tomcat的配置文件，适合多环境一致部署的场景。
• 注意：需确保外部Tomcat对指定的log目录有写入权限，若路径不合适可调整为绝对路径或Tomcat默认的logs目录。

方案2：同步外部Tomcat配置（保留Spring Boot原有配置）

• 嵌入式Tomcat：继续使用原有的server.tomcat.accesslog.*配置；
• 外部Tomcat：修改其conf/server.xml文件，找到Host节点下的AccessLogValve，将pattern替换为与Spring Boot一致的格式：

<Valve className="org.apache.catalina.valves.AccessLogValve"
       directory="log"
       prefix="localhost_access_log"
       suffix=".txt"
       pattern="%h %l %u [%t] &quot;%r&quot; %s %b &quot;%{Referer}i&quot; &quot;%{User-Agent}i&quot; %D [%I] &quot;%{Host}i&quot;" />

• 该方案配置更直接，适合外部Tomcat由运维统一管理的场景，但需注意同步Spring Boot与外部Tomcat的pattern配置，避免格式不一致。

内容的提问来源于stack exchange，提问作者thomas.schuerger