如何使用Maven Enforcer插件检测任意路径指定文件并终止构建？

方法一：利用Enforcer插件的通配符匹配（无需自定义规则） #

其实requireFilesDontExist规则支持Ant风格通配符，结合Maven内置的项目根目录属性${project.basedir}，就能实现匹配项目构建路径下任意位置的指定文件，不需要写死绝对路径。

具体配置示例如下：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-enforcer-plugin</artifactId>
            <version>3.4.1</version> <!-- 使用最新稳定版本 -->
            <executions>
                <execution>
                    <id>check-for-forbidden-files</id>
                    <goals>
                        <goal>enforce</goal>
                    </goals>
                    <configuration>
                        <rules>
                            <requireFilesDontExist>
                                <files>
                                    <!-- **/ 表示匹配任意层级的子目录 -->
                                    <file>${project.basedir}/**/forbidden-file.txt</file>
                                </files>
                                <message>检测到禁止存在的文件：forbidden-file.txt，构建终止</message>
                            </requireFilesDontExist>
                        </rules>
                        <fail>true</fail> <!-- 触发规则时直接终止构建 -->
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

• 这里的**/forbidden-file.txt会匹配项目根目录下所有层级子目录中名为forbidden-file.txt的文件
• 如果需要检测多个文件名，直接在<files>节点下添加多个<file>标签即可

方法二：自定义Enforcer规则（更灵活的场景） #

如果需要更复杂的逻辑（比如排除某些特定目录、自定义文件检测逻辑），可以自定义Enforcer规则：

1. 编写自定义规则类，实现org.apache.maven.enforcer.rule.api.EnforcerRule接口：

import org.apache.maven.enforcer.rule.api.EnforcerRule;
import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
import org.apache.maven.enforcer.rule.api.EnforcerRuleHelper;
import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException;

import java.io.File;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.List;

public class ForbiddenFileRule implements EnforcerRule {

    // 可配置的禁止文件名列表
    private List<String> forbiddenFilenames = new ArrayList<>();

    @Override
    public void execute(EnforcerRuleHelper helper) throws EnforcerRuleException {
        try {
            // 获取项目根目录
            File projectDir = (File) helper.evaluate("${project.basedir}");
            Path projectPath = Paths.get(projectDir.getAbsolutePath());

            // 遍历目录查找禁止文件
            List<Path> foundFiles = new ArrayList<>();
            Files.walk(projectPath)
                 .filter(Files::isRegularFile)
                 .forEach(path -> {
                     String fileName = path.getFileName().toString();
                     if (forbiddenFilenames.contains(fileName)) {
                         foundFiles.add(path);
                     }
                 });

            if (!foundFiles.isEmpty()) {
                StringBuilder message = new StringBuilder("检测到禁止存在的文件：\n");
                foundFiles.forEach(path -> message.append("- ").append(path).append("\n"));
                throw new EnforcerRuleException(message.toString());
            }

        } catch (ExpressionEvaluationException e) {
            throw new EnforcerRuleException("无法获取项目根目录", e);
        } catch (Exception e) {
            throw new EnforcerRuleException("文件检测失败", e);
        }
    }

    // 实现其他接口方法（默认即可）
    @Override
    public String getCacheId() {
        return String.join(",", forbiddenFilenames);
    }

    @Override
    public boolean isCacheable() {
        return false;
    }

    @Override
    public boolean isResultValid(EnforcerRule cachedRule) {
        return false;
    }

    // Getter和Setter
    public List<String> getForbiddenFilenames() {
        return forbiddenFilenames;
    }

    public void setForbiddenFilenames(List<String> forbiddenFilenames) {
        this.forbiddenFilenames = forbiddenFilenames;
    }
}

2. 将这个类打包成Jar，安装到本地Maven仓库（或部署到私有仓库），然后在项目中配置使用：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-enforcer-plugin</artifactId>
            <version>3.4.1</version>
            <executions>
                <execution>
                    <id>check-forbidden-files</id>
                    <goals>
                        <goal>enforce</goal>
                    </goals>
                    <configuration>
                        <rules>
                            <forbiddenFileRule implementation="com.yourpackage.ForbiddenFileRule">
                                <forbiddenFilenames>
                                    <filename>forbidden-file.txt</filename>
                                    <filename>another-bad-file.xml</filename>
                                </forbiddenFilenames>
                            </forbiddenFileRule>
                        </rules>
                    </configuration>
                </execution>
            </executions>
            <dependencies>
                <!-- 引入自定义规则的依赖 -->
                <dependency>
                    <groupId>com.yourgroup</groupId>
                    <artifactId>custom-enforcer-rules</artifactId>
                    <version>1.0.0</version>
                </dependency>
            </dependencies>
        </plugin>
    </plugins>
</build>

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