java - 如何在 Junit 中测试 java 单例的不同实例

Question

我目前有 Java 单例，它在实例化时读取一些系统属性。在生产环境中，这些系统属性将是静态的，因此一旦 JVM 重新启动，系统属性就不需要更改。

public final class SoaJSONLogger {

    private static final String SCHEMA_PROPERTY = "com.reddipped.soa.jsonlogger.schema";
    private static final String SCHEMA_STRICT = "com.reddipped.soa.jsonlogger.strict";
    private static final String DATE_TIME_FORMAT = "yyyy-MM-dd HH:mm:ss.SSS";
    private final com.reddipped.soa.jsonlogger.JSONLogger LOGGER;
    private final Pattern fieldValuePattern = Pattern.compile("(\\w+)=(.+)");
    private final String schemaName;
    private final Boolean strictSchema;

    /**
     * Logging level
     *
     * TRACE (least serious) DEBUG INFO WARNING ERROR (most serious)
     *
     */
    public static enum LEVEL {
        ERROR, WARN, INFO, DEBUG, TRACE
    };

    private static class JSONLoggerLoader {
        private static final SoaJSONLogger INSTANCE = new SoaJSONLogger();
    }

    private SoaJSONLogger() {

        if (JSONLoggerLoader.INSTANCE != null) {
            throw new IllegalStateException("Already instantiated");
        }

        // Get schema name and strict settings 
        this.schemaName = System.getProperty(SoaJSONLogger.SCHEMA_PROPERTY);
        this.strictSchema = (System.getProperty("com.reddipped.soa.jsonlogger.strict") != null
            && System.getProperty(SoaJSONLogger.SCHEMA_STRICT).equalsIgnoreCase("true"));

        if (this.schemaName != null) {
            this.LOGGER = JSONLogger.getLogger("JSONLogger", DATE_TIME_FORMAT, this.schemaName, this.strictSchema);
        } else {
            throw new IllegalArgumentException("Schema property " + SoaJSONLogger.SCHEMA_PROPERTY + " not set");
        }

    }

    public static SoaJSONLogger getInstance() {
        return JSONLoggerLoader.INSTANCE;
    }

    public void trace(String xmlLog) {
        this.LOGGER.xml(xmlLog).trace();
    }

    public void debug(String xmlLog) {
        this.LOGGER.xml(xmlLog).debug();
    }

    public void info(String xmlLog) {
        this.LOGGER.xml(xmlLog).info();
    }

    public void warn(String xmlLog) {
        this.LOGGER.xml(xmlLog).warn();
    }

    public void error(String xmlLog) {
        this.LOGGER.xml(xmlLog).error();
    }
}

我需要测试系统属性的不同值。在 JUnit 中执行此操作而无需修改 Java 类的最佳方法是什么？我需要以某种方式为每个 JUnit 测试创建该类的新实例。

Answer 1

所有不错的答案，但不知何故都没有捕获重点并提出过于复杂的解决方案。而你真正的问题源于你的类(class)混合了两个职责:

1. 它的实际技术目的
2. 提供单例

换句话说；只需像这样重新设计您的设计:

创建一个表示您正在寻找的功能的界面

public interface SoaJSONLogger { ...

然后创建一个简单的实现

class SoaJSONLoggerImpl implements SoaJSONLogger {

例如，这个 impl 类可以被包保护；这样它就不能从其包外部实例化(但可用于同一包中的单元测试)。

然后使用枚举模式显式提供单例:

public enum SoaJSONLoggerProvider implements SoaJSONLogger {
  INSTANCE;
  private final SoaJSONLogger delegatee = new SoaJSONLoggerImp();

  @Override
  public void trace(String xmlLog) {
    delegatee.trace(xmlLog);
  }

现在你得到了:

1. 该接口(interface)的实现可以很容易地进行单元测试
2. 几乎免费的整个单例(通过其枚举性质保证正常工作)
3. 最重要的是:通过引入这个接口(interface)，你真正解耦了事物；例如，您可以更轻松地将 SoaJSONLogger 的实例注入(inject) 到客户端类中(也让它们易于测试)。

除此之外:代码的另一个真正问题是您在构造函数中执行了所有这些操作。我会考虑重构它；并将其拉入不同的类。

长话短说:您的代码难以测试，因为您编写了难以测试的代码! (你在那里实际做的事情可以以不同的方式完成，而且更容易测试)。

编辑；关于“包保护”和单元测试:典型的方法是 X 和 XTest 类都位于相同包中；但在不同的源文件夹中。因此，典型的结构是您要么拥有:

ProjectA
src/y/X.java

连同

ProjectB based on ProjectA
src/y/XTest.java

或者类似的东西

ProjectA
src/y/X.java
test/y/X.java

这样可以毫不费力地测试受包保护的功能。