在单元测试中是否有任何slf4j用法的简单模式？

Question

我在我的项目中使用JUnit4和Hibernate3。 Hibernate依赖于Slf4j，因此我的项目也包含这个库。现在我想在单元测试中使用Slf4j以记录补充测试信息。您能否提供一个简单的示例，说明我的单元测试应该如何才能记录一行文本？在多次测试中，最好是没有代码重复。

Answer 1

我也喜欢用SLF4J在我的JUnit测试我DAO类。它在您创建新测试或修改旧测试时确实有帮助。我通常会将我的旧日志记录输出保留在调试级别，并在信息级别创建新的日志记录语句，同时我仍在积极研究该方法中的代码。我的一个JUnit类的会是这个样子：

package com.example.mydao; 

import org.slf4j.Logger; 
import org.slf4j.LoggerFactory; 
// other imports not shown... 

public class TestMyDAO extends TestCase { 

    private static final Logger logger = 
     LoggerFactory.getLogger(TestMyDAO.class); 


    public void testA() { 
     logger.debug("Logging from testA() method"); 
    } 

    public void testB() { 
     logger.debug("Logging from testB() method"); 
    } 

    public void testThatIAmWorkingOn() { 
     logger.info("Logging from my new test method at INFO level"); 
    } 

} 

我使用log4j的是实际的记录供应商，所以我log4j.xml配置文件看起来像这样：

<?xml version="1.0" encoding="UTF-8"?> 
    <!DOCTYPE log4j:configuration SYSTEM "log4j.dtd"> 
    <log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/" debug="false"> 
    <appender name="consoleAppender" class="org.apache.log4j.ConsoleAppender"> 
     <layout class="org.apache.log4j.PatternLayout"> 
      <param name="ConversionPattern" value="%d %-5p [%c{1}] %m %n" /> 
     </layout> 
    </appender> 

    <logger name="com.example.mydao" additivity="false"> 
     <level value="INFO" /> 
     <appender-ref ref="consoleAppender"/> 
    </logger> 

    <logger name="org.hibernate" additivity="false"> 
     <level value="WARN" /> 
     <appender-ref ref="consoleAppender"/> 
    </logger> 

    <logger name="org.hibernate.connection.DriverManagerConnectionProvider" additivity="false"> 
     <level value="INFO" /> 
     <appender-ref ref="consoleAppender"/> 
    </logger> 

    <logger name="org.hibernate.connection.C3P0ConnectionProvider" additivity="false"> 
     <level value="INFO" /> 
     <appender-ref ref="consoleAppender"/> 
    </logger> 

    <logger name="com.mchange" additivity="false"> 
     <level value="WARN" /> 
     <appender-ref ref="consoleAppender"/> 
    </logger> 

    <logger name="com.mchange.v2.resourcepool.BasicResourcePool" additivity="false"> 
     <level value="INFO" /> 
     <appender-ref ref="consoleAppender"/> 
    </logger> 

    <logger name="com.mchange.v2.c3p0.impl.AbstractPoolBackedDataSource" additivity="false"> 
     <level value="INFO" /> 
     <appender-ref ref="consoleAppender"/> 
    </logger> 

    <logger name="com.mchange.v2.c3p0.C3P0Registry" additivity="false"> 
     <level value="INFO" /> 
     <appender-ref ref="consoleAppender"/> 
    </logger> 

    <root> 
     <priority value ="WARN" /> 
     <appender-ref ref="consoleAppender"/> 
    </root> 

</log4j:configuration> 

这给了我的信息从我的JUnit类输出，以及Hibernate运行时和Hibernate使用的其他库中的一些有用的东西。根据自己的口味调整。

最后，我需要确保所有的下列库都在我的类路径中，当我执行JUnit测试：

• slf4j-api-1.6.0.jar
• slf4j-log4j12-1.6.0.jar
• log4j-1.2.16.jar
• log4j.xml（我的配置文件，如上所示）
• 某些版本的JUnit运行时JAR
• 在生产中运行应用程序时，通常存在的所有JAR

这就是我在使用log4j时所做的。如果您使用不同的日志记录实施，则相应地进行调整。只要“API”和实现JAR是相同版本（我的版本都是1.6.0），使用不同版本的slf4j并不重要。

Answer 2

为什么你想在单元测试中记录东西？单元测试应该是合格/不合格，并且应该使用测试框架来表明这一点。您不想通过输出来阅读测试是否通过或失败。如果它失败了，那么在IDE /调试器中运行它是修复它的最好方法。

Answer 3

这对我来说似乎是一种难闻的气味。

您应该始终避免手动检查或单元测试验证。

单元测试应该是自动化的，如果你的构建工具告诉你，某些测试失败应该只需要人工干预，并应使用所有这些验证方法（如的assertEquals）

Answer 4

我们使用log4j的提供失败的原因作为我们的输出记录器;

private static Logger log = LoggerFactory.getLogger(MyClassHere.class); 

如果您正确配置它，slf4j应找到并使用log4j而不会出现问题。 为了让生活方便，我会用这个Eclipse的模式，因为您将编写这些代码公平一点：

private static Logger log = LoggerFactory.getLogger(${enclosing_type}.class); 
${:import(org.slf4j.Logger,org.slf4j.LoggerFactory)} 

的测试中，我建议你不要超越INFO水平，并保持最事情DEBUG 。如果你真的想要智能地捕捉很多错误，那么我建议你查看一下PositronLogger，它是一个日志文件appender，它会静静地将所有东西都提取到TRACE中，但只有在捕获错误时才将其转储到文件;有点像时间旅行:)

http://github.com/andreaja/PositronLogger

Answer 5

Slf4j是一个日志门面，您可以在运行时决定实现。 Slf4j只是一个API。例如，你可以使用log4j作为底层实现。你需要在你的pom.xml中包含两个依赖。

<!-- Depend on slf4j API --> 
    <dependency> 
     <groupId>org.slf4j</groupId> 
     <artifactId>slf4j-api</artifactId> 
     <version>1.7.12</version> 
    </dependency> 
    <!-- Use log4j as the slf4j implementation --> 
    <dependency> 
     <groupId>org.slf4j</groupId> 
     <artifactId>slf4j-log4j12</artifactId> 
     <version>1.7.12</version> 
    </dependency> 

的事情是，运行在IDE或通过mvn test单元测试时，它可以是恼人设置log4j的配置。尤其是以一种不需要做任何事情的方式工作。除非在类路径上有一个log4j.properties文件或者设置了-Dlog4j.configuration=file:///path/to/log4j.properties，否则Log4j默认拒绝记录任何内容。

一种解决方案是把在单元测试，代码设置log4j的配置编程：

@BeforeClass 
    public static void beforeClass() { 
     BasicConfigurator.resetConfiguration(); 
     BasicConfigurator.configure(); 
    } 

这只是工作，但它需要在每单元测试这是一种痛苦被投入。 。

Answer 6

另一种解决方案是将日志记录实现切换为仅用于测试的简单实现。

所以在你的pom.xml

<!-- Depend on slf4j API --> 
    <dependency> 
     <groupId>org.slf4j</groupId> 
     <artifactId>slf4j-api</artifactId> 
     <version>1.7.12</version> 
    </dependency> 

    <!-- Use SimpleLogger as the slf4j implementation in test --> 
    <dependency> 
     <groupId>org.slf4j</groupId> 
     <artifactId>slf4j-simple</artifactId> 
     <version>1.7.12</version> 
     <scope>test</scope> 
    </dependency> 

    <!-- Use log4j as the slf4j implementation during runtime (not test) --> 
    <dependency> 
     <groupId>org.slf4j</groupId> 
     <artifactId>slf4j-log4j12</artifactId> 
     <version>1.7.12</version> 
     <scope>runtime</scope> 
    </dependency> 

的SimpleLogger只是默认记录一切标准错误，并且不需要任何配置文件

Answer 7

添加日志记录在写新的测试是非常有用的。与此同时，当测试在CI或CD管道中运行时，您希望禁用日志记录（或者至少不要冗长）。有时候故障是暂时的，特别是在端到端的运行中，所以在CI作业的控制台日志上输出相关的输出是有帮助的。这篇文章很好地描述了它 - https://gualtierotesta.wordpress.com/2015/11/01/tutorial-logging-during-tests/