如何在 Java 中正确测试日期工具类(DateUtils)方法

落明同学_9041

落明同学_9041

2026-05-02

784人浏览

原创

如何在 Java 中正确测试日期工具类(DateUtils)方法

本文讲解如何通过依赖抽象、时间可控制和 mockito 模拟等手段,对静态日期工具方法(如返回 xmlgregoriancalendar 或格式化字符串)进行可靠、可重复的单元测试。

本文讲解如何通过依赖抽象、时间可控制和 mockito 模拟等手段,对静态日期工具方法(如返回 xmlgregoriancalendar 或格式化字符串)进行可靠、可重复的单元测试。

在 Java 单元测试中,直接测试依赖系统当前时间(如 new Date()、LocalDateTime.now() 或 DateUtils.currentDate())的工具方法是极具挑战性的——因为每次运行结果都不同,违反了测试的可重复性和确定性原则。你提供的 getCalendar() 和 getDateNowYyMm() 方法正是典型场景:它们静态调用 DateUtils.currentDate(),内部又经 SimpleDateFormat 和 DatatypeFactory 构造 XMLGregorianCalendar,导致难以断言、难以覆盖边界用例(如闰年、时区、格式异常等)。

✅ 正确解法:面向测试重构 + 时间抽象

核心原则:将“获取当前时间”这一副作用行为抽象为可注入、可模拟的依赖。 静态工具类本身不利于测试,因此推荐以下渐进式改进:

1. 引入时间供应接口(推荐)

public interface Clock {
    Instant now();
}

改造 DateUtils 为非静态、可注入依赖的类:

java-enterprise
java-enterprise

Java企业开发专家,专注于Spring Boot、微服务架构和JVM优化。适用于:Java语言掌握、

下载
public class DateUtils {
    private final Clock clock;

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

    public XMLGregorianCalendar getCalendar() throws DatatypeConfigurationException {
        LocalDateTime now = LocalDateTime.ofInstant(clock.now(), ZoneId.systemDefault());
        String formatted = now.format(DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss"));
        return DatatypeFactory.newInstance()
                .newXMLGregorianCalendar(formatted);
    }

    public String getDateNowYyMm() throws DatatypeConfigurationException {
        LocalDateTime now = LocalDateTime.ofInstant(clock.now(), ZoneId.systemDefault());
        String formatted = now.format(DateTimeFormatter.ofPattern("yyMM"));
        return DatatypeFactory.newInstance()
                .newXMLGregorianCalendar(formatted)
                .toString();
    }
}

2. 测试代码(使用 JUnit 5 + Mockito)

import static org.mockito.Mockito.*;
import static org.junit.jupiter.api.Assertions.*;

class DateUtilsTest {

    @Test
    void getCalendar_returnsValidXMLGregorianCalendar() throws Exception {
        // 给定:固定时间为 2024-03-15T14:30:45
        Clock mockClock = () -> Instant.parse("2024-03-15T14:30:45Z");
        DateUtils utils = new DateUtils(mockClock);

        // 当:调用方法
        XMLGregorianCalendar result = utils.getCalendar();

        // 那么:校验结果(注意:XMLGregorianCalendar.toString() 格式为 yyyy-MM-dd'T'HH:mm:ss)
        assertNotNull(result);
        assertEquals(2024, result.getYear());
        assertEquals(3, result.getMonth());
        assertEquals(15, result.getDay());
        assertEquals(14, result.getHour());
        assertEquals(30, result.getMinute());
        assertEquals(45, result.getSecond());
    }

    @Test
    void getDateNowYyMm_returnsFormattedString() throws Exception {
        Clock mockClock = () -> Instant.parse("2023-12-01T09:15:22Z");
        DateUtils utils = new DateUtils(mockClock);

        String result = utils.getDateNowYyMm();

        assertEquals("2312", result); // yyMM → "2312"
    }
}

3. 若必须保留静态 API(兼容旧代码)

可提供一个默认实例 + 可替换的测试钩子:

public class DateUtils {
    private static Clock defaultClock = Clock.systemDefaultZone();

    // 仅用于测试:允许注入模拟时钟
    public static void setTestClock(Clock testClock) {
        defaultClock = testClock;
    }

    public static XMLGregorianCalendar getCalendar() throws DatatypeConfigurationException {
        LocalDateTime now = LocalDateTime.ofInstant(defaultClock.now(), ZoneId.systemDefault());
        String formatted = now.format(DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss"));
        return DatatypeFactory.newInstance().newXMLGregorianCalendar(formatted);
    }
}

对应测试:

@Test
void getCalendar_withTestClock() throws Exception {
    DateUtils.setTestClock(() -> Instant.parse("2025-01-01T00:00:00Z"));
    try {
        XMLGregorianCalendar cal = DateUtils.getCalendar();
        assertEquals(2025, cal.getYear());
        assertEquals(1, cal.getMonth());
        assertEquals(1, cal.getDay());
    } finally {
        // 恢复默认,避免污染其他测试
        DateUtils.setTestClock(Clock.systemDefaultZone());
    }
}

⚠️ 注意事项与最佳实践

  • 避免 new Date() / System.currentTimeMillis() 直接调用:它们是测试毒药,务必封装。
  • 慎用 SimpleDateFormat:它是线程不安全的,建议改用 DateTimeFormatter(不可变、线程安全)。
  • XMLGregorianCalendar 的断言要具体:不要只断言 toString(),应验证 getYear()、getMonth() 等字段,因其格式可能受时区影响。
  • 异常测试不可少:例如传入非法格式或 null 时,确保 DatatypeConfigurationException 被正确抛出(可用 assertThrows)。
  • 时区显式指定:ZoneId.systemDefault() 在 CI 环境中可能不稳定,建议统一使用 ZoneOffset.UTC 并在测试中明确声明。

通过将“时间”建模为一等公民(Clock 接口),你的日期工具类就从“不可测的静态黑盒”转变为“高内聚、低耦合、易验证”的可维护组件——这才是面向测试设计(Test-Driven Design)的真正价值所在。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

10417

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

7542

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

6612

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1124

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

928

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1376

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2749

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

20051

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1215

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习