构建与依赖 / 系统课时

Maven 标准目录结构

Maven 标准目录结构

Maven 通过固定目录约定区分生产代码、资源、测试代码和构建产物。按默认结构放置文件后,常见项目通常不需要再配置源码目录;本节会搭出一个最小 Java 工程,并用一次编译验证 Maven 是否正确识别这些目录。

学习目标

  • 说清 src/main、src/test 与 target 的职责
  • 按 Maven 默认约定放置 Java 源码和资源文件
  • 用 mvn compile 验证源码是否被编译到预期位置

默认目录分别放什么

最常用的五个位置可以直接按下表判断。生产源码放错到 src/test/java 会只在测试阶段参与编译;把手写文件放进 target 则会在执行 mvn clean 时被删除。

路径 默认用途 典型内容
src/main/java 生产 Java 源码 com/example/App.java
src/main/resources 生产资源 application.properties、模板、配置
src/test/java 测试 Java 源码 单元测试类
src/test/resources 测试资源 测试配置、样例数据
target Maven 构建输出 .class、JAR、测试报告

Maven 标准目录结构及构建输出关系

target 是生成目录,不应提交手工维护的源码。常见 .gitignore 至少包含 /target/;而 src/main/resources 中的文件在资源处理阶段会复制到 target/classes,最终通常一起进入 JAR。

搭一个最小项目验证约定

先创建 pom.xml。下面配置使用 Java 8 语法级别,适合只验证 Maven 目录约定,不依赖额外插件配置。

xml
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.example</groupId>
  <artifactId>layout-demo</artifactId>
  <version>1.0.0</version>
  <properties>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
  </properties>
</project>

再把下面的类保存为 src/main/java/com/example/App.java。

java
package com.example;

public class App {
    public static void main(String[] args) {
        System.out.println("layout-ok");
    }
}

在项目根目录执行编译,并检查 Maven 是否把源码放到默认输出路径。

bash
mvn -q compile && test -f target/classes/com/example/App.class && echo OK

预期输出:

text
OK

如果得到 OK,说明 Maven 已从 src/main/java 发现源码,并将编译结果写入 target/classes。若命令在 Windows PowerShell 中执行,可改为编译后检查 Test-Path target/classes/com/example/App.class。

约定失效时先查路径

最常见的问题不是 Maven “没识别项目”,而是文件放错层级。比如把 App.java 放在 src/main/com/example,默认编译不会扫描这个目录;正确位置必须包含 java 这一层。

还要区分源码目录和包目录:文件路径 src/main/java/com/example/App.java 对应声明 package com.example;。如果包声明与目录不一致,Java 编译器可能仍能处理部分情况,但后续类加载、IDE 导入和团队协作会变得混乱,应保持一致。

当项目确实有非标准源码目录时,可以通过插件或构建配置扩展,但基础项目优先遵守默认约定。这样 compile、test、package 等生命周期阶段能直接工作,也能减少 IDE 与 CI 之间的路径差异。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

Maven 标准目录结构

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通