构建与依赖 / 系统课时
单元测试目录与命名规则
单元测试目录与命名规则
Maven 不会扫描项目里的所有 Java 文件来找测试,而是按照约定区分生产源码、测试源码和测试资源。把文件放对目录、使用 Surefire 默认可识别的类名,就能让 mvn test 自动编译并执行单元测试,同时避免测试数据被误打进正式产物。
学习目标
- 能正确使用
src/test/java和src/test/resources组织测试代码与测试数据。 - 能判断一个测试类名是否符合 Maven Surefire 的默认发现规则。
- 能通过
mvn test验证测试源码、资源和命名是否被正确识别。
Maven 测试目录放在哪里
标准 Maven 项目把生产代码与测试代码分开管理。Java 测试源码放在 src/test/java,测试专用的 JSON、SQL、配置样例等文件放在 src/test/resources;生产代码和资源则分别位于 src/main/java 与 src/main/resources。
例如生产类是 src/main/java/com/example/PriceCalculator.java,对应测试通常放在 src/test/java/com/example/PriceCalculatorTest.java。测试包名与生产代码保持一致不是强制要求,但这样最容易定位对应关系,也方便测试包级可见成员。
在已有 Maven 项目根目录,可以直接创建标准测试目录:
mkdir -p src/test/java/com/example src/test/resources预期结果:命令成功时通常没有终端输出,项目中会出现 src/test/java/com/example 与 src/test/resources 两个目录。
默认命名决定测试是否被发现
执行 mvn test 时,maven-surefire-plugin 默认会从已编译的测试类中选择符合命名模式的类。Surefire 3.x 的常用默认包含模式如下,因此 PriceCalculatorTest 会执行,而仅叫 PriceCalculatorSpec 的类默认不会因为名字本身被选中。
| 类名模式 | 示例 | 默认执行 |
|---|---|---|
Test*.java |
TestPriceCalculator.java |
是 |
*Test.java |
PriceCalculatorTest.java |
是 |
*Tests.java |
PriceCalculatorTests.java |
是 |
*TestCase.java |
PriceCalculatorTestCase.java |
是 |
*Spec.java |
PriceCalculatorSpec.java |
否 |
实际项目建议统一采用 被测类名 + Test,例如 OrderServiceTest、TaxCalculatorTest。这样不仅符合默认规则,也能让开发者从文件名直接找到被测对象。不要仅为了分类而写成 OrderServiceUnit.java,否则类中即使存在合法的 JUnit 测试方法,也可能不会被默认 Surefire 选择。
测试资源如何组织
src/test/resources 适合保存只在测试阶段使用的数据,例如 src/test/resources/orders/valid-order.json、src/test/resources/schema.sql 或测试专用日志配置。这些资源在测试执行时会进入测试 classpath,不需要写成本机绝对路径。
例如测试中读取 src/test/resources/orders/valid-order.json 时,应按 classpath 资源访问,而不是硬编码开发者电脑上的目录。下面是依赖 JUnit Jupiter 的片段示例,假设文件已经存在于该资源路径:
import static org.junit.jupiter.api.Assertions.assertNotNull;
import org.junit.jupiter.api.Test;
class OrderResourceTest {
@Test
void loadsOrderFixture() {
// 从测试 classpath 读取资源,避免依赖工作目录和开发者本机路径。
var resource = getClass().getResource("/orders/valid-order.json");
assertNotNull(resource);
}
}这段代码依赖项目已经配置 JUnit Jupiter。生效行为是:测试运行时从测试 classpath 根目录查找 /orders/valid-order.json;资源缺失时断言失败,而不是因为某台机器目录不同而随机失败。
用一次构建检查布局是否正确
完成目录和命名后,在包含 pom.xml 的项目根目录执行测试阶段。test 会先处理资源、编译生产代码与测试代码,再由测试插件执行被选中的测试,因此一次命令就能同时检查目录、编译和测试发现是否正常。
mvn test预期结果:测试全部通过时 Maven 进程退出码为 0,构建末尾包含以下关键结果;插件版本、测试数量和耗时会随项目不同。
BUILD SUCCESS如果测试类可以编译但 mvn test 显示没有执行预期测试,先检查文件是否位于 src/test/java,再检查类名是否匹配 Surefire 默认模式。测试代码完全没有进入编译阶段时,则优先检查目录层级,而不是先修改 JUnit 注解。