如何配置Tomcat Catalina以使用自定义Log日志实现？

你的理解是正确的 #

Catalina 确实通过org.apache.juli.LogFactory管理日志实现，它会借助ServiceLoader查找org.apache.juli.Log接口的实现类；如果找不到自定义实现，就会默认使用基于java.util.logging的JdkLogger。你要做的就是让ServiceLoader成功加载自定义实现，覆盖默认逻辑。

具体实现步骤 #

1. 确保自定义类正确实现接口 #

自定义Logger必须实现org.apache.juli.Log接口，而非其他日志框架的Log接口（比如SLF4J的Logger）。同时要提供带String name参数的构造方法（Catalina会优先调用这个传递Logger名称），可选无参构造方法作为降级方案。

示例代码：

import org.apache.juli.Log;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;

public class CustomJsonCatalinaLogger implements Log {
    private final String loggerName;
    private final ObjectMapper objectMapper;

    // Catalina优先调用的构造方法
    public CustomJsonCatalinaLogger(String name) {
        this.loggerName = name;
        this.objectMapper = new ObjectMapper();
    }

    // 无参构造方法，作为备选
    public CustomJsonCatalinaLogger() {
        this("default");
    }

    @Override
    public boolean isDebugEnabled() {
        // 自定义DEBUG级别判断逻辑
        return true;
    }

    @Override
    public void debug(String msg) {
        outputLog("DEBUG", msg);
    }

    @Override
    public boolean isInfoEnabled() {
        return true;
    }

    @Override
    public void info(String msg) {
        outputLog("INFO", msg);
    }

    @Override
    public boolean isWarnEnabled() {
        return true;
    }

    @Override
    public void warn(String msg) {
        outputLog("WARN", msg);
    }

    @Override
    public boolean isErrorEnabled() {
        return true;
    }

    @Override
    public void error(String msg) {
        outputLog("ERROR", msg);
    }

    // 统一JSON日志输出逻辑
    private void outputLog(String level, String message) {
        try {
            String logJson = objectMapper.writeValueAsString(
                Map.of(
                    "timestamp", System.currentTimeMillis(),
                    "level", level,
                    "logger", loggerName,
                    "message", message
                )
            );
            System.out.println(logJson);
        } catch (JsonProcessingException e) {
            // 序列化失败降级输出
            System.err.printf("Log serialization failed: %s, original message: [%s]%n", e.getMessage(), message);
        }
    }

    // 实现带Throwable的日志方法
    @Override
    public void debug(String msg, Throwable throwable) {
        outputLogWithException("DEBUG", msg, throwable);
    }

    private void outputLogWithException(String level, String message, Throwable throwable) {
        try {
            Map<String, Object> logMap = Map.of(
                "timestamp", System.currentTimeMillis(),
                "level", level,
                "logger", loggerName,
                "message", message,
                "exception", throwable.getMessage()
            );
            String logJson = objectMapper.writeValueAsString(logMap);
            System.out.println(logJson);
        } catch (JsonProcessingException e) {
            System.err.printf("Log with exception serialization failed: %s, original message: [%s]%n", e.getMessage(), message);
        }
    }

    // 实现Log接口的其他重载方法（如info(String, Throwable)等），逻辑类似
}

2. 配置ServiceLoader服务文件 #

在项目src/main/resources目录下，创建META-INF/services子目录（不存在则新建），然后在该目录下新建名为org.apache.juli.Log的文件。

文件内容仅需写入自定义Logger的全限定类名，比如：

com.yourpackage.CustomJsonCatalinaLogger

注意：文件中不要有多余空格、换行或注释，确保类名拼写完全正确。

3. 确保类路径可访问 #

如果用Maven/Gradle构建，src/main/resources下的文件会自动打包到JAR根目录，嵌入式Tomcat可正常加载。如果手动构建，需确保包含自定义Logger类和META-INF/services目录的文件/JAR被添加到Tomcat的类加载路径中。

4. 验证生效 #

启动嵌入式Tomcat后，观察控制台日志是否为自定义JSON格式。如果还是默认日志，检查以下几点：

• 服务文件路径和名称是否完全正确（必须是META-INF/services/org.apache.juli.Log）
• 自定义类的全限定类名是否拼写正确
• 自定义类是否实现了org.apache.juli.Log接口的所有方法
• 类路径配置是否正确，Tomcat能否加载到该类和服务配置文件

额外优化建议 #

如果不想自己实现JSON序列化逻辑，可以把自定义Logger做成适配器，将Catalina日志委托给Logback、Log4j2等成熟框架，利用它们现成的JSON输出功能。比如在自定义Logger的方法中调用Logback的Logger输出，复用框架的日志级别、格式、滚动策略等配置。

内容的提问来源于stack exchange，提问作者Fernando Pinedo