如何在Maven项目中禁止新代码使用指定类？

针对你要限制新代码使用abc.something.MyComponent但保留旧引用的需求，用maven-enforcer-plugin的bannedClasses规则配合允许违规列表是最直接的方案，具体配置和步骤如下：

1. 配置maven-enforcer-plugin #

在项目的pom.xml中添加插件配置，核心是通过bannedClasses规则禁止目标类，同时用excludes字段列出所有已使用该类的旧类（即允许违规的类）：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-enforcer-plugin</artifactId>
            <version>3.4.1</version> <!-- 使用最新稳定版 -->
            <executions>
                <execution>
                    <id>enforce-banned-classes</id>
                    <goals>
                        <goal>enforce</goal>
                    </goals>
                    <configuration>
                        <rules>
                            <bannedClasses>
                                <includes>
                                    <include>abc.something.MyComponent</include>
                                </includes>
                                <!-- 允许违规的旧类列表：所有已经引用MyComponent的类 -->
                                <excludes>
                                    <exclude>com.legacy.OldServiceA</exclude>
                                    <exclude>com.legacy.OldControllerB</exclude>
                                    <!-- 继续添加其他旧类 -->
                                </excludes>
                                <message>新代码禁止使用abc.something.MyComponent，请使用替代类！</message>
                            </bannedClasses>
                        </rules>
                        <!-- 开启严格模式，确保规则在编译阶段触发 -->
                        <fail>true</fail>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

2. 规则生效逻辑 #

• 新编写的类一旦引用abc.something.MyComponent，maven构建会直接失败并抛出配置的提示信息；
• 已在excludes列表中的旧类，即使保留对目标类的引用，构建也会正常通过；
• 每次清理完旧代码中对MyComponent的引用后，记得从excludes列表中移除对应类，逐步缩小违规范围。

3. 额外优化建议 #

• 版本锁定：把maven-enforcer-plugin的版本固定在项目的dependencyManagement中，避免多模块版本不一致；
• 多模块适配：多模块项目建议把插件配置放在父pom中，子模块自动继承，减少重复配置；
• IDE前置提示：配合IDE的代码检查规则（比如IntelliJ的Inspections），在编码阶段就提示开发者不要使用该类，提前规避问题；
• 灵活方案备选：如果需要更复杂的规则（比如基于包路径排除、自定义违规条件），可以考虑用ArchUnit编写自定义检查规则，但maven-enforcer-plugin对简单的类禁止需求已经足够轻量。

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