如何增强cucumber-jvm输出的日志内容并添加自定义字段

Cucumber底层默认依赖JUL输出日志，要修改其生成的日志消息，有3种落地性较强的方案：

方案1：自定义JUL Filter 拦截修改日志内容（改动最小，无需修改依赖） #

JUL原生支持Filter机制，我们可以在日志事件转发到jul-to-slf4j之前，先拦截所有Cucumber相关的日志事件，修改消息内容后再向下传递。

1. 自定义Filter实现：

import java.util.logging.Filter;
import java.util.logging.LogRecord;

public class CucumberLogEnhanceFilter implements Filter {
    @Override
    public boolean isLoggable(LogRecord record) {
        // 可按需过滤只处理Cucumber相关日志，也可全量处理
        if (record.getLoggerName().startsWith("io.cucumber")) {
            // 增强日志：追加线程ID，也可自定义修改原有消息内容
            String originMsg = record.getMessage();
            String enhancedMsg = String.format("[Thread-%d] %s", 
                Thread.currentThread().getId(), originMsg);
            record.setMessage(enhancedMsg);
        }
        return true;
    }
}

2. 项目启动时注册Filter：

import java.util.logging.Logger;

// 获取Cucumber根Logger，注册自定义Filter
Logger cucumberLogger = Logger.getLogger("io.cucumber");
cucumberLogger.setFilter(new CucumberLogEnhanceFilter());

• 优点：改动极小，不需要调整现有依赖结构
• 缺点：仅能修改消息内容，没法调整日志的其他元数据

方案2：自定义Cucumber LoggerFactory SPI实现（最彻底，完全替换日志实现） #

Cucumber的LoggerFactory是通过Java SPI机制加载的，我们可以自定义一个LoggerFactory的实现，直接返回SLF4J的Logger实例，彻底绕开JUL，直接对接现有SLF4J+Logback体系。

1. 实现Cucumber Logger接口，代理SLF4J日志能力：

import io.cucumber.core.logging.Logger;
import org.slf4j.LoggerFactory;
import java.util.function.Supplier;

public class Slf4jCucumberLogger implements Logger {
    private final org.slf4j.Logger delegate;

    public Slf4jCucumberLogger(Class<?> clazz) {
        this.delegate = LoggerFactory.getLogger(clazz);
    }

    @Override
    public void error(Supplier<String> supplier) {
        if (delegate.isErrorEnabled()) delegate.error(supplier.get());
    }

    @Override
    public void error(Throwable throwable, Supplier<String> supplier) {
        if (delegate.isErrorEnabled()) delegate.error(supplier.get(), throwable);
    }

    // 剩余warn、info、debug、trace方法按照上述逻辑代理实现即可
}

2. 实现Cucumber LoggerFactory接口：

import io.cucumber.core.logging.LoggerFactory;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

public class Slf4jCucumberLoggerFactory implements LoggerFactory {
    private final Map<Class<?>, Logger> loggerCache = new ConcurrentHashMap<>();

    @Override
    public Logger getLogger(Class<?> clazz) {
        return loggerCache.computeIfAbsent(clazz, Slf4jCucumberLogger::new);
    }
}

3. 注册SPI：在项目的META-INF/services目录下创建名为io.cucumber.core.logging.LoggerFactory的文件，文件内容填写自定义LoggerFactory的全限定类名即可，比如com.yourproject.config.Slf4jCucumberLoggerFactory

• 优点：完全对接现有SLF4J体系，后续日志格式、过滤、增强都可以直接通过Logback配置实现，不需要额外处理JUL相关逻辑
• 缺点：需要实现完整的Logger接口，适配Cucumber版本的变更

方案3：基于Logback配置增强（适配jul-to-slf4j桥接场景） #

如果已经引入了jul-to-slf4j桥接器，不想改动代码，也可以直接在Logback配置中通过转换规则增强日志：

• 仅需添加线程ID的场景，直接修改Logback的pattern配置即可，jul转发的日志事件会保留当前线程信息：

<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>

• 需要修改消息内容的场景，可以搭配Logback的replace规则实现：

<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %replace(%msg){'待替换原始内容', '替换后内容'}%n</pattern>

• 优点：完全不需要改代码，仅调整配置即可生效
• 缺点：增强能力有限，复杂的消息修改逻辑支持不好

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