如何为 static 变量编写单元测试？

Question

我有一个 class 有一个 static 变量和一个 function 使用该变量。 我需要为 shouldCreateNewToken() 方法编写一个单元测试。

public class Auth {
    private static Instant tokenExpiration = Instant.now();

    public boolean shouldCreateNewToken() {
        Instant currentTimestamp = Instant.now(); 
        Duration differenceInTime = Duration.between(currentTimestamp, tokenExpiration);

        if (currentTimestamp.compareTo(tokenExpiration) > 0 || differenceInTime.getSeconds() < 120) {
            return true;
        }   
        return false;
    }
}

Answer 1

首先，当涉及 static 变量时，几乎不可能正确地进行单元测试。 更改变量值或内部 state 有机会在后续测试中泄漏，并且在并行运行多个测试时情况会更糟（例如，Surfire 确实并行运行测试）。

因此，首先要做的是重构您的代码以不使用 static 变量。 例如，如果您正在使用具有该功能的框架，例如 Spring，您应该使用依赖注入。

其次，要测试对时间敏感的东西，就像这里的情况一样，您可以使用时钟。 由于时间在应用程序中无处不在，但设置起来并不像看起来那么容易。

Answer 2

您可以将 JUnit 4 和Mockito与PowerMock一起使用。

可以通过这种方式访问私有 static 字段：

Auth auth = new Auth();
Field field = PowerMockito.field(Auth.class, "tokenExpiration");
field.set(Auth.class, the_value_you_need_for_test);

Answer 3

• 关于您计划如何使用 Auth class，我可能没有足够的上下文，但是，根据我所看到的，您的shouldCreateNewToken方法将始终返回 true。

  Static 变量在main执行之前创建。 当你的程序/服务初始化时，你已经有了一个tokenExpiration的值（比如 10），当你执行方法时，它总是会选择一个大于 tokenExpiration 的值（比如 11,12,. ..)

  在这里，我分享了一个快速指南以了解该行为： https://www.baeldung.com/java-static-variables-initialization

• 关于您的模拟问题，可以使用两种方法：

  1. 您可以使用Mockito中的 mockStatic，甚至 PowerMockito 也有类似的方法（取决于您使用/喜欢什么），并模拟 Instant object

      Instant instant = Instant.now(); try (MockedStatic<Instant> mockedInstant = Mockito.mockStatic(Instant.class)) { mockedInstant.when(now()).thenReturn(instant); ... }

  2. 第二种方法是将tokenExpiration瞬间作为 Auth 类的构造函数的参数传递，这样您 1) 避免 mocking，允许您传递您想要的瞬间，以及 2) 允许您根据不同的需求创建不同的 Auth 配置.

      class Auth { private final Instant tokenExpiration; public Auth(Instant tokenExpiration) { this.tokenExpiration = tokenExpiration; }... }