如何在项目存在错误命名目录时触发构建失败？

1. 提前触发javadoc检查 #

把maven-javadoc-plugin的检查环节提前到日常构建流程（比如开发分支的CI构建、本地构建），而非仅在主分支做站点构建时执行。配置插件在编译阶段后运行javadoc:check目标，一旦发现目录与包名不匹配就直接终止构建。

示例配置：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>3.6.3</version>
            <executions>
                <execution>
                    <id>early-javadoc-check</id>
                    <phase>compile</phase>
                    <goals>
                        <goal>check</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <failOnError>true</failOnError>
            </configuration>
        </plugin>
    </plugins>
</build>

2. 用maven-enforcer-plugin做目录校验 #

借助maven-enforcer-plugin结合额外规则包，在构建早期（validate阶段）就校验Java文件的目录结构是否与包名一致，不匹配直接失败。

示例配置：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-enforcer-plugin</artifactId>
            <version>3.4.1</version>
            <dependencies>
                <dependency>
                    <groupId>org.codehaus.mojo</groupId>
                    <artifactId>extra-enforcer-rules</artifactId>
                    <version>1.6.1</version>
                </dependency>
            </dependencies>
            <executions>
                <execution>
                    <id>check-package-directory-match</id>
                    <phase>validate</phase>
                    <goals>
                        <goal>enforce</goal>
                    </goals>
                    <configuration>
                        <rules>
                            <requireJavaPackageMatchesDirectory>
                                <message>目录结构与包名不匹配，请检查源文件存放路径！</message>
                            </requireJavaPackageMatchesDirectory>
                        </rules>
                        <fail>true</fail>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

3. IDE层面强制规范 #

统一团队IDE的配置，让新建类时自动生成符合包名的层级目录，同时添加代码检查规则拦截违规目录：

• 比如在IntelliJ IDEA中，新建类时直接输入完整包名a.b.c，IDE会自动创建a/b/c层级目录，而非单个a.b.c目录；
• 开启IDE的自定义代码检查，当检测到目录名包含.且与对应Java文件的包名不匹配时，标记为错误并阻止代码提交。

4. Git钩子拦截提交 #

在项目的Git钩子（pre-commit或pre-push）中添加脚本，遍历所有Java源文件，校验文件所在目录是否与包名一致，发现违规就终止提交/推送。

示例pre-commit脚本：

#!/bin/bash

SRC_PATH="src/main/java"

find "$SRC_PATH" -name "*.java" | while read FILE; do
    # 提取文件中的包名
    PACKAGE=$(grep "^package " "$FILE" | awk '{print $2}' | sed 's/;//')
    [ -z "$PACKAGE" ] && continue
    
    # 把包名转换成预期的目录路径
    EXPECTED_DIR="$SRC_PATH/${PACKAGE//./\/}"
    # 获取当前文件所在目录
    ACTUAL_DIR=$(dirname "$FILE")
    
    if [ "$ACTUAL_DIR" != "$EXPECTED_DIR" ]; then
        echo "错误：文件 $FILE 的目录 $ACTUAL_DIR 与包名 $PACKAGE 不匹配，正确路径应为 $EXPECTED_DIR"
        exit 1
    fi
done

exit 0

将脚本放到.git/hooks/pre-commit并赋予执行权限，每次提交前会自动执行检查。

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