为什么主Spring Boot应用程序总是触发PMD的HideUtilityClassConstructorcheck？

Question

标准的Spring Boot应用程序有一些主方法类文件，比如SampleApplication.java，看起来像这样：

@SpringBootApplication
@RestController
public class SampleApplication {

    public static void main(final String[] args) {
        SpringApplication.run(SampleApplication.class, args);
    }

}

但PMD静态分析将其标记为错误（HideUtilityClassConstructorCheck）：

实用程序类不应具有公共或默认构造函数。

确保实用程序类（在API中仅包含静态方法或字段的类）没有公共构造函数。

理由：实例化实用程序类没有意义。因此，构造函数应该是私有的，或者（如果您希望允许子类化）受保护的。一个常见的错误是忘记隐藏默认构造函数。

如果使构造函数受到保护，您可能需要考虑以下构造函数实现技术来禁止实例化子类：

公共类StringUtils//不是最终允许子类{受保护的StringUtils() { // 防止从子类调用抛出新的Un支持的操作异常（）；}公共静态int计数（char c， String s）{//...###

为什么会这样？我应该抑制此PMD错误吗？

Answer 1

现在您可以像这样忽略注释@SpringBootApplication：

<rule ref="category/java/design.xml/UseUtilityClass">
    <properties>
        <property name="ignoredAnnotations" value="org.springframework.boot.autoconfigure.SpringBootApplication"/>
    </properties>
</rule>

参见自PMD 6.16.0（2019年6月30日）起的UseUtilityClass

Answer 2

使用PMD规则集XML文件中的以下代码段，可以仅对带有@SpringBootApplication注释的类抑制PMD UseUtilityClass规则：

<rule ref="category/java/design.xml/UseUtilityClass">
    <properties>
        <property name="violationSuppressXPath" value="//ClassOrInterfaceDeclaration/preceding-sibling::Annotation/MarkerAnnotation/Name[@Image='SpringBootApplication']" />
    </properties>
</rule>

Answer 3

检查本身就说明了问题。

默认情况下，任何代码检查器（IntelliJ IDEA、FindBugs、PMD、Sonar）都假设如果类只有静态方法，那么它就是实用程序类。实用程序类的示例是java.lang.Math，它看起来像这样：

public final class Math {

    /**
     * Don't let anyone instantiate this class.
     */
    private Math() {}

    public static double exp(double a) {
        ...
    }

    // More helper methods
}

此类类被设计为将其作为一包静态函数使用：为其声明私有构造函数是一种很好的做法，因此没有人会错误地实例化它并声明classfinal，因为扩展它毫无意义。

在您的情况下（以及Spring Boot应用程序的几乎每个入口点）SampleApplication类有一个public static void main方法，因此PMD决定其实用程序类，检查私有构造和最终修饰符，并标记错误。这不是问题所在，PMD只是不知道Spring Boot或任何其他框架及其入口点，所以最好不要显示此警告并将您的类从PMD中排除：对我来说，这比向应用程序入口点添加私有构造函数在语义上更正确。