需要一种更好的方法来使测试代码脱离生产代码-slf4jtesting

时间:2018-07-09 12:25:25

标签: java unit-testing dependency-injection slf4j

我正在使用com.portingle:slf4jtesting:1.1.3来帮助测试某些日志记录功能。

我的问题是com.portingle的开发人员是strong advocates of dependency injection,并且建议仅使用依赖注入来利用其slf4jtesting::ILoggerFactory实用程序(slf4j的实现,它存储了日志条目以便于测试和验证)。

通过依赖项注入,我可以在这样的类中创建我的slf4j记录器,然后注入生产或测试LoggerFactory

import org.slf4j.ILoggerFactory;
import org.slf4j.Logger;

public class Example1 {

    private final Logger logger;

    public Example1(ILoggerFactory lf) {
        this.logger = lf.getLogger(Example1.class.getName());
    }

    public void aMethodThatLogs() {
        logger.info("Hello World!");
    }
}

足够合理,但是我有一个旧版应用程序,并且我的所有记录器都已经编码过,并且有时在静态代码块/方法中使用,因此标准的DI构造函数注入将无法工作。

目前我正在这样做:

private static final Logger log = LoggingUtils.getLogger(
        RequestLoggingFilter.class);

LoggingUtils看起来像这样:

public class LoggingUtils {

    private LoggingUtils() {
    }

    private static ILoggerFactory iLoggerFactory =
            LoggerFactory.getILoggerFactory();

    /**
     * We don't want to call this in production.
     */
    public static void switchToTestLogging() {
        iLoggerFactory = Settings.instance().enableAll().buildLogging();
    }

    /**
     * Return logger for a class, of whatever implementation is running,
     * e.g. test or prod logger.
     *
     * @param loggingClass the class doing the logging
     * @return logger
     */
    public static Logger getLogger(Class loggingClass) {
        return iLoggerFactory.getLogger(loggingClass.getName());
    }

因此在测试中,我可以通过调用slf4jtesting::ILoggerFactory切换到switchToTestLogging(),但是最终结果是我的生产代码中有slf4jtesting代码。

或者,我可以将iLoggerFactory设为公开,以便测试可以在必要时替换它,但是允许任何生产代码执行此操作是错误的做法。

最后,我可以在自己的LoggingUtils类中use reflection to hack the private ILoggerFactory instance并在测试过程中分配一个测试LoggerFactory

@BeforeAll
public static void setupLogging()
        throws NoSuchFieldException, IllegalAccessException {
    Field loggerFactoryField =
            LoggingUtils.class.getDeclaredField("iLoggerFactory");
    loggerFactoryField.setAccessible(true);
    loggerFactoryField.set(null,
        Settings.instance().enableAll().buildLogging());
}

但这也不是“最佳实践”。

有什么方法可以使ILoggerFactory实例保持私有状态,避免反射并使测试库停止生产?

1 个答案:

答案 0 :(得分:0)

我不是静态耦合的忠实拥护者,但是从技术上讲,您过于关注实现问题。

您可以完全删除switchToTestLogging

public class LoggingUtils {

    private LoggingUtils() {
    }

    private static ILoggerFactory iLoggerFactory;

    /**
     * Return logger for a class
     *
     * @param loggingClass the class doing the logging
     * @return logger
     */
    public static Logger getLogger(Class loggingClass) {
        //Lazy loading.
        if(iLoggerFactory == null) {
            iLoggerFactory = LoggerFactory.getILoggerFactory();
        }
        return iLoggerFactory.getLogger(loggingClass.getName());
    }
}

,并在测试中模拟工厂方法以在调用时返回所需的记录器。

PowerMockito应该能够让您模拟静态成员。

@RunWith(PowerMockRunner.class)
@PrepareForTest(LoggingUtils.class) //<-- important
public class SomeTest {
    @Test
    public void someTestMethod() {
        //Arrange
        //get the logger used in testing
        ILoggerFactory testLoggerFactory = Settings.instance().enableAll().buildLogging();
        //set up util for mocking
        PowerMockito.mockStatic(LoggingUtils.class);
        //setup mocked member
        Mockito.when(LoggingUtils.getLogger(any(Class.class)))
            .thenAnswer(i -> testLoggerFactory.getLogger(i.getArguments()[0].getName()));

        //Act
        //call subject under test that is coupled to LoggingUtils

        //Assert
        //...
    }
}

LoggingUtils现在仅关注生产问题,并且PowerMockito允许您在执行测试时调用LoggingUtils.getLogger时对测试记录器进行存根。

免责声明:这未经测试。根据我对框架的回忆提供。

完成此操作后,我强烈建议重构您的代码,以遵循我的SOLID做法,这将使您的代码更干净,更可维护。像这样的hacks就是代码的味道,并且清楚表明设计不良。仅仅因为有一些可以解决的工具就不能摆脱错误的设计选择。