如何限制Java方法（含测试方法）使用Instant.now()或new Date()？

需求说明 #

需要限制所有Java方法（包括测试方法）中直接调用Instant.now()或实例化new Date()，这类硬编码的时间获取方式会导致代码难以测试，且灵活性不足。

问题代码示例 #

class Demo {

    void methodOne() {
        Date date = new Date();
        // ...
    }

    void methodTwo() {
        Instant instant = Instant.now();
        // ...
    }
}

解决方案 #

1. 抽象时间获取逻辑

定义一个通用的时间提供者接口，把时间获取的逻辑封装起来，替代直接调用系统时间的写法：

public interface TimeProvider {
    Instant getCurrentInstant();
    Date getCurrentDate();
}

2. 生产环境实现

针对生产场景，实现默认的时间获取逻辑，内部还是调用系统时间，但通过接口对外提供：

public class DefaultTimeProvider implements TimeProvider {
    @Override
    public Instant getCurrentInstant() {
        return Instant.now();
    }

    @Override
    public Date getCurrentDate() {
        return new Date();
    }
}

3. 改造业务代码

通过依赖注入的方式将时间服务注入到业务类中，替换原来的直接调用：

class Demo {
    private final TimeProvider timeProvider;

    // 推荐构造注入，确保依赖不可变
    public Demo(TimeProvider timeProvider) {
        this.timeProvider = timeProvider;
    }

    void methodOne() {
        Date date = timeProvider.getCurrentDate();
        // ...
    }

    void methodTwo() {
        Instant instant = timeProvider.getCurrentInstant();
        // ...
    }
}

4. 测试场景适配

在测试时使用模拟的时间提供者，能够自由控制时间值，让测试用例更稳定、可重复：

public class MockTimeProvider implements TimeProvider {
    private Instant fixedInstant;
    private Date fixedDate;

    public void setFixedTime(Instant fixedInstant) {
        this.fixedInstant = fixedInstant;
        this.fixedDate = Date.from(fixedInstant);
    }

    @Override
    public Instant getCurrentInstant() {
        return fixedInstant;
    }

    @Override
    public Date getCurrentDate() {
        return fixedDate;
    }
}

// 测试用例示例
class DemoTest {
    @Test
    void testMethodOne() {
        MockTimeProvider mockTimeProvider = new MockTimeProvider();
        // 设置固定测试时间
        Instant testInstant = Instant.parse("2024-01-01T00:00:00Z");
        mockTimeProvider.setFixedTime(testInstant);

        Demo demo = new Demo(mockTimeProvider);
        demo.methodOne();
        // 基于固定时间执行断言验证
    }
}

5. 编码层面强制约束

可以借助静态代码检查工具（如Checkstyle、SonarQube）添加自定义规则，禁止代码中直接出现Instant.now()和new Date()的写法，从编码阶段就规范开发行为。

内容的提问来源于stack exchange，提问作者Codinggeek