Spring Boot JPA原生查询如何替换NOW()实现可测试固定时间？

针对你在JPA仓库原生查询中使用NOW()导致测试难以固定时间的问题，下面提供一套兼容@DataJpaTest的解决方案，核心思路是将数据库的NOW()替换为可注入的参数，结合Clock Bean实现生产环境用系统时间、测试环境用固定时间的需求。

步骤1：修改JPA仓库查询，将当前日期作为参数传入 #

把原生SQL中的CAST(NOW() AS DATE)替换为参数绑定，这样就能在调用时灵活传入指定时间：

interface TaskRepository : JpaRepository<Task, Long> {

    // 核心查询：接收当前日期参数
    @Query(
        """SELECT *
            FROM task as t
            WHERE 
            t.end_date IS NULL 
                 OR t.end_date >= :currentDate
        """, nativeQuery = true
    )
    fun findAllCurrentAndFuture(@Param("currentDate") currentDate: LocalDate): List<Task>

    // 封装默认方法，利用Clock获取生产环境的当前日期
    default fun findAllCurrentAndFuture(clock: Clock): List<Task> {
        val currentDate = LocalDate.now(clock)
        return findAllCurrentAndFuture(currentDate)
    }
}

步骤2：配置全局Clock Bean #

在生产环境下，我们使用系统默认的Clock，以此保证时间获取的一致性：

@Configuration
class ClockConfig {
    @Bean
    fun clock(): Clock {
        return Clock.systemDefaultZone()
    }
}

步骤3：编写@DataJpaTest测试用例 #

在测试中，我们可以通过两种方式固定时间：

方式一：直接传入固定LocalDate #

这种方式最直接，不需要依赖Clock的注入，适合快速编写单测：

@DataJpaTest
class TaskRepositoryTest {

    @Autowired
    private lateinit var taskRepository: TaskRepository

    @Test
    fun `查询当前及未来任务时，应筛选出符合时间条件的数据`() {
        // 固定测试基准时间为2024-05-20
        val fixedTestDate = LocalDate.of(2024, 5, 20)

        // 准备测试数据：过期任务、当前任务、无截止日期任务
        val expiredTask = Task(endDate = LocalDate.of(2024, 5, 19))
        val currentTask = Task(endDate = fixedTestDate)
        val noEndDateTask = Task(endDate = null)

        taskRepository.saveAll(listOf(expiredTask, currentTask, noEndDateTask))

        // 调用查询方法传入固定时间
        val resultTasks = taskRepository.findAllCurrentAndFuture(fixedTestDate)

        // 断言结果：只包含当前任务和无截止日期任务
        assert(resultTasks.size == 2)
        assert(resultTasks.contains(currentTask, noEndDateTask))
        assert(!resultTasks.contains(expiredTask))
    }
}

方式二：替换Clock Bean为固定实例 #

如果想模拟生产环境中通过Clock注入的调用方式，可以用@MockBean覆盖全局的Clock Bean：

@DataJpaTest
class TaskRepositoryClockTest {

    @Autowired
    private lateinit var taskRepository: TaskRepository

    @MockBean
    private lateinit var clock: Clock

    @Test
    fun `通过注入固定Clock查询任务，结果符合预期`() {
        val fixedTestDate = LocalDate.of(2024, 5, 20)
        val fixedInstant = fixedTestDate.atStartOfDay(ZoneId.systemDefault()).toInstant()

        // 模拟Clock返回固定时间
        `when`(clock.instant()).thenReturn(fixedInstant)
        `when`(clock.zone).thenReturn(ZoneId.systemDefault())

        // 插入测试数据（同方式一）
        val expiredTask = Task(endDate = LocalDate.of(2024, 5, 19))
        val currentTask = Task(endDate = fixedTestDate)
        val noEndDateTask = Task(endDate = null)
        taskRepository.saveAll(listOf(expiredTask, currentTask, noEndDateTask))

        // 调用基于Clock的查询方法
        val resultTasks = taskRepository.findAllCurrentAndFuture(clock)

        // 断言结果一致
        assert(resultTasks.size == 2)
        assert(resultTasks.contains(currentTask, noEndDateTask))
        assert(!resultTasks.contains(expiredTask))
    }
}

方案优势 #

• 完全兼容@DataJpaTest：不需要额外配置测试切片，直接使用Spring Boot提供的JPA测试支持
• 生产环境无感知：默认方法封装后，业务代码调用方式和之前一致
• 测试灵活性高：可以轻松切换固定时间，覆盖各种边界场景（比如跨零点、月末等）

内容的提问来源于stack exchange，提问作者Hermann.Gruber