使用Java 8 Clock对类进行单元测试

Question

引入了Java 8 java.time.Clock,它可以用作许多其他java.time对象的参数,允许您向它们注入真实或假的时钟.例如,我知道您可以创建一个Clock.fixed()然后调用Instant.now(clock)它将返回Instant您提供的固定.这听起来非常适合单元测试!

但是,我无法弄清楚如何最好地使用它.我有一个类,类似于以下内容:

public class MyClass {
    private Clock clock = Clock.systemUTC();

    public void method1() {
        Instant now = Instant.now(clock);
        // Do something with 'now'
    }
}

现在,我想对这段代码进行单元测试.我需要能够设置clock生成固定时间,以便我可以method()在不同时间进行测试.显然,我可以使用反射将clock成员设置为特定值,但如果我不必诉诸于反射,那将会很好.我可以创建一个公共setClock()方法,但这感觉不对.我不想Clock在方法中添加一个参数,因为真正的代码不应该关注传入时钟.

处理此问题的最佳方法是什么？这是新代码,所以我可以重新组织这个类.

编辑:为了澄清,我需要能够构造一个MyClass对象,但能够让一个对象看到两个不同的时钟值(就好像它是一个常规的系统时钟一样).因此,我无法将固定时钟传递给构造函数.

Answer 1

我不想在方法中添加Clock参数,因为真正的代码不应该考虑传入时钟.

不......但您可能希望将其视为构造函数参数.基本上你说你的班级需要一个时钟来工作...所以这是一个依赖.像处理任何其他依赖关系一样对待它,并将其注入构造函数或通过方法.(我个人赞成构造函数注入,但是YMMV.)

一旦你不再把它想象成你可以很容易地构建自己的东西,并开始把它想象成"只是另一个依赖",那么你可以使用熟悉的技术.(诚​​然,我假设你对依赖注射很满意.)

Answer 2

让我把Jon Skeet的答案和评论放到代码中:

被测试的班级:

public class Foo {
    private final Clock clock;
    public Foo(Clock clock) {
        this.clock = clock;
    }

    public void someMethod() {
        Instant now = clock.instant();   // this is changed to make test easier
        System.out.println(now);   // Do something with 'now'
    }
}

单元测试:

public class FooTest() {

    private Foo foo;
    private Clock mock;

    @Before
    public void setUp() {
        mock = mock(Clock.class);
        foo = new Foo(mock);
    }

    @Test
    public void ensureDifferentValuesWhenMockIsCalled() {
        Instant first = Instant.now();                  // e.g. 12:00:00
        Instant second = first.plusSeconds(1);          // 12:00:01
        Instant thirdAndAfter = second.plusSeconds(1);  // 12:00:02

        when(mock.instant()).thenReturn(first, second, thirdAndAfter);

        foo.someMethod();   // string of first
        foo.someMethod();   // string of second
        foo.someMethod();   // string of thirdAndAfter 
        foo.someMethod();   // string of thirdAndAfter 
    }
}

Answer 3

我在游戏中有点迟了,但是要添加其他答案建议使用时钟 - 这绝对有效,并且通过使用Mockito的doAnswer,您可以创建一个时钟,您可以随着测试进度动态调整.

假设这个类已被修改为在构造函数中使用Clock,并在Instant.now(clock)调用时引用时钟.

public class TimePrinter() {
    private final Clock clock; // init in constructor

    // ...

    public void printTheTime() {
        System.out.println(Instant.now(clock));
    }
}

然后,在您的测试设置中:

private Instant currentTime;
private TimePrinter timePrinter;

public void setup() {
   currentTime = Instant.EPOCH; // or Instant.now() or whatever

   // create a mock clock which returns currentTime
   final Clock clock = mock(Clock.class);
   when(clock.instant()).doAnswer((invocation) -> currentTime);

   timePrinter = new TimePrinter(clock);
}

在你的测试后期:

@Test
public void myTest() {
    myObjectUnderTest.printTheTime(); // 1970-01-01T00:00:00Z

    // go forward in time a year
    currentTime = currentTime.plus(1, ChronoUnit.YEARS);

    myObjectUnderTest.printTheTime(); // 1971-01-01T00:00:00Z
}

你告诉Mockito总是运行一个函数,只要调用instant(),就会返回currentTime的当前值. Instant.now(clock)会打电话clock.instant().现在,您可以比DeLorean更快地前进,快退和一般旅行.

Answer 4

创建一个可变时钟而不是模拟

首先，一定要Clock按照@Jon Skeet 的建议将 a 注入到您的测试类中。如果您的课程只需要一次，那么只需传入一个Clock.fixed(...)值。但是，如果您的类随着时间的推移表现不同，例如它在时间 A 做某事，然后在时间 B 做其他事情，那么请注意 Java 创建的时钟是不可变的，因此测试不能更改以返回时间 A 在一次，然后 B 次。

根据接受的答案，模拟是一种选择，但确实将测试与实现紧密结合。例如，正如一位评论者指出的那样，如果被测类调用LocalDateTime.now(clock)或clock.millis()而不是clock.instant()?

另一种方法就是有点更明确，更容易理解，而且可能比模拟更强大的，是创建一个真正的实现Clock是可变的，所以测试可以注入，并修改是必要的。这个不难实现，或者这里有几个现成的实现：

• https://github.com/Mercateo/test-clock（这个发布在 Maven Central HT 上：@Bartek Jablonski）
• https://github.com/ThreeTen/threeten-extra/blob/master/src/main/java/org/threeten/extra/MutableClock.java（也在Maven Central HT 上：@Wim Deblauwe）
• https://github.com/robfletcher/test-clock

下面是人们在测试中如何使用这样的东西：

MutableClock c = new MutableClock(Instant.EPOCH, ZoneId.systemDefault());
ClassUnderTest classUnderTest = new ClassUnderTest(c);

classUnderTest.doSomething()
assertTrue(...)

c.instant(Instant.EPOCH.plusSeconds(60))

classUnderTest.doSomething()
assertTrue(...)

Answer 5

正如其他人所指出的，您需要以某种方式模拟它 - 但是您自己的操作也很容易：

    class UnitTestClock extends Clock {
        Instant instant;
        public void setInstant(Instant instant) {
            this.instant = instant;
        }

        @Override
        public Instant instant() {
            return instant;
        }

        @Override
        public ZoneId getZone() {
            return ZoneOffset.UTC;
        }

        @Override
        public Clock withZone(ZoneId zoneId) {
            throw new UnsupportedOperationException();
        }
    }