如何防止Maven项目中的新代码中使用某些类？

Question

有一个类

abc.something.MyComponent

被一些遗留代码使用，但我们希望避免在新创建的代码中使用它。

我正在考虑类似

maven-enforcer-plugin

的附加选项来创建“允许的违规行为”列表，因为不可能立即删除所有用法。

在Java项目中添加某个类使用规则的合适方法是什么？

Answer 1

一种方法是使用 Checkstyle 的 IllegalType 检查。使用 Maven Checkstyle 插件 可以轻松地将 Checkstyle 集成到 Maven 构建中。它可以配置为简单地创建报告或在正常构建期间运行其检查，如果发现任何违规，甚至使构建失败。

这是一般配置的样子：

<module name="IllegalType">
  <property name="illegalClassNames" value="abc.something.MyComponent"/>
</module>

如果您想抑制遗留代码中特定用途的违规行为，您可以进一步配置“抑制”，如此处所示。您可以使用文件模式，也可以将抑制限制为特定检查。