java - 为什么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):

Utility classes should not have a public or default constructor.

Makes sure that utility classes (classes that contain only static methods or fields in their API) do not have a public constructor.

Rationale: Instantiating utility classes does not make sense. Hence the constructors should either be private or (if you want to allow subclassing) protected. A common mistake is forgetting to hide the default constructor.

If you make the constructor protected you may want to consider the following constructor implementation technique to disallow instantiating subclasses:

public class StringUtils // not final to allow subclassing { protected StringUtils() { // prevents calls from subclass throw new UnsupportedOperationException(); } public static int count(char c, String s) { // ... } }

这是为什么？我应该抑制这个 PMD 错误吗？

Answer 1

检查不言而喻。

默认情况下，任何代码检查器(IntelliJ IDEA、FindBugs、PMD、Sonar)都假设如果类只有 static 方法，那么它是 utility class .实用程序类的示例是 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
}

这样的类被设计为将它用作静态函数包:为它声明私有(private)构造函数是一种很好的做法，因此没有人会错误地实例化它并声明类 final，因为扩展它没有意义。

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