如何在 Spring 中抽象出 java.time.Clock 用于测试目的

Question

我有一个关于 Time dependent unit tests

的问题

假设我构建了 Spring 包含服务接口及其实现的应用程序

如果我想在测试中更改时钟，我将不得不 "pollute" 生产代码和接口，例如setClock方法如下：

public interface MyService {
    void heavyBusinessLogic();
    void setClock(Clock clock);
}

@Service
public class MyServiceImpl implements MyService {

    private Clock clock = Clock.systemDefaultZone();

    @Override
    public void heavyBusinessLogic() {
        if (LocalDate.now(clock)...) {
            ... 
        }
    }

    @Override
    public void setClock(Clock clock) {
        this.clock = clock;
    }
}

在测试中，我可以调用，例如：

service.setClock(Clock.fixed(Instant.parse("2017-02-14T01:22:00Z"), ZoneOffset.UTC));

如何在 Spring 中抽象出这种横切关注点？

我想坚持使用 java.time.Clock（我不想使用 Joda）

Answer 1

就个人而言，我会简单地在构造函数中添加时钟...

public MyServiceImpl(Clock clock) {
  this.clock = clock;
}

...也许添加一个不错的默认构造函数...

public MyServiceImpl() {
  this(Clock.systemDefaultZone());
}

这样您就可以通过 spring 获取默认值并手动创建自定义时钟版本，例如在您的测试中。

当然，您也可以放弃默认构造函数，只需在您的生产配置中添加一个 Clock bean，例如这样...

@Bean
public Clock clock() {
 return Clock.systemDefaultZone();
}

...这允许您在测试配置中使用模拟的 Clock 作为 bean，通过构造函数注入自动允许 Spring 到 @Autowire 它。

Answer 2

如何为时钟建模的好方法是使用 ThreadLocal，尤其是当您在 JPA 实体中需要它时，例如：

@Entity
public class MyEntity {
   public static final ThreadLocal<Clock> CLOCK =
            ThreadLocal.withInitial(Clock::systemDefaultZone);
}

如何在 Spring 中抽象出 java.time.Clock 用于测试目的

How to abstract away java.time.Clock for testing purposes in Spring

java

junit

spring

jsr310