如何在Java中使用ArchUnit禁止文件中的特定内容

Question

我想要一个规则来检查一些特定的字符串。假设我们不想在代码库中看到“Objects.nonNull”，而希望导入“nonNull”静态。

我怎样才能在ArchUnit中做到这一点？我知道它是为了更多的架构目标，但是我们已经在项目中使用了它，所以也许我们也可以将它用于较低级别的检查。

或者如何在其他框架中轻松完成？

Answer 1

这在ArchUnit中是不可能的（至少我不知道，API似乎没有提供这种可能性）。这也有道理：导入只存在于源代码中，而不存在于生成的字节码中。因此，ArchUnit无权访问此信息。

您可以做的是在构建管道中定义一个任务，该任务在所有相关文件上调用grep。大致如下：

grep -q 'Objects\.nonNull` *.java && echo "Qualified nonNull call found! Aborting.";

或者，您可能已经在使用CheckStyle在代码中强制（样式）规则。CheckStyle提供自版本4.0以来的Regexp检查：

检查指定的模式是否存在、存在次数少于设定次数或文件中不存在。

例子：

<module name="Regexp">
  <property name="format" value="Objects\.nonNull"/>
  <property name="illegalPattern" value="true"/>
</module>