如何在JUnit 5中使用LoggingListener捕获日志输出

核心操作步骤 #

1. 注册监听器（关键环节）
   创建LoggingListener实例后，无需手动调用reportingEntryPublished方法——这个方法是JUnit框架在测试事件触发时自动回调的。你需要做的是把监听器注册到JUnit测试执行流程中，分两种场景：

   • 编程式注册（自定义测试启动）：
     直接在测试启动代码中绑定监听器，示例：

     import org.junit.platform.launcher.Launcher;
     import org.junit.platform.launcher.LauncherDiscoveryRequest;
     import org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder;
     import org.junit.platform.launcher.core.LauncherFactory;
     import org.junit.platform.launcher.listeners.LoggingListener;
     import org.junit.platform.engine.discovery.ClassNameFilter;
     import org.junit.platform.engine.discovery.DiscoverySelectors;
     import java.util.logging.Level;
     
     public class CustomTestRunner {
         public static void main(String[] args) {
             // 创建INFO级别的监听器实例
             LoggingListener loggingListener = LoggingListener.forJavaUtilLogging(Level.INFO);
     
             // 构建测试发现请求，指定要执行的测试类
             LauncherDiscoveryRequest request = LauncherDiscoveryRequestBuilder.request()
                     .selectors(DiscoverySelectors.selectPackage("com.your.package.tests"))
                     .filters(ClassNameFilter.includeClassNamePatterns(".*Test"))
                     .build();
     
             // 获取Launcher并注册监听器
             Launcher launcher = LauncherFactory.create();
             launcher.registerTestExecutionListeners(loggingListener);
             // 执行测试
             launcher.execute(request);
         }
     }
     

   • 声明式注册（Maven/Gradle等构建场景）：
     在src/test/resources/META-INF/services目录下创建文件org.junit.platform.launcher.TestExecutionListener，文件内容写入监听器全类名：

     org.junit.platform.launcher.listeners.LoggingListener
     

     同时在junit-platform.properties中补充监听器级别配置：

     junit.platform.logging.listener.level=INFO
     junit.platform.output.capture.stdout=true
     junit.platform.output.capture.stderr=true
     

2. 理解reportingEntryPublished的作用
   这个方法是JUnit测试生命周期的回调接口实现，当测试中通过TestInfo.publishEntry发布自定义报告条目，或者框架内部产生报告事件时，JUnit会自动调用该方法，将内容输出到你指定的Java Util Logging系统中。你只需要确保监听器注册生效，无需手动调用。

3. 验证日志捕获效果
   在测试类中添加日志输出或自定义报告，示例：

   import org.junit.jupiter.api.Test;
   import org.junit.jupiter.api.TestInfo;
   import java.util.logging.Logger;
   
   public class SampleLoggingTest {
       private static final Logger logger = Logger.getLogger(SampleLoggingTest.class.getName());
   
       @Test
       public void testInfoLogging(TestInfo testInfo) {
           // 输出INFO级日志
           logger.info("测试执行中，这是一条INFO级日志");
           // 发布自定义报告条目
           testInfo.publishEntry("测试阶段", "初始化完成");
       }
   }
   

   运行测试后，Java Util Logging会输出对应的INFO级内容，包括你配置捕获的标准输出/错误和自定义报告条目。

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