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

Question

我在 Sonar 上收到此警告。我想要解决方案来删除 Sonar Qube 上的此警告。

我的课是这样的：

public class FilePathHelper {
    private static String resourcesPath;
    public static String getFilePath(HttpServletRequest request) {
        if(resourcesPath == null) {
            String serverpath = request.getSession().getServletContext().getRealPath("");               
            resourcesPath = serverpath + "/WEB-INF/classes/";   
        }
        return resourcesPath;       
    }
}

我需要适当的解决方案来消除声纳上的此警告。

Answer 1

我不知道 Sonar，但我怀疑它正在寻找私有构造函数：

private FilePathHelper() {
    // No-op; won't be called
}

否则，Java 编译器将提供一个公共的无参数构造函数，这是您不想要的。

（您还应该将类设为 final，尽管其他类由于它只有一个私有构造函数而无法扩展它。）

Answer 2

如果这个类只是一个实用类，你应该把这个类定为final并定义一个私有构造函数：

public final class FilePathHelper {
   private FilePathHelper() {
      //not called
   }
}

这可以防止默认的无参数构造函数在代码的其他地方使用。

此外，您可以将类设为 final，这样它就不能在子类中扩展，这是实用程序类的最佳实践。由于您仅声明了一个私有构造函数，因此其他类无论如何都无法扩展它，但将类标记为 final 仍然是最佳实践。

Answer 3

我使用没有实例的枚举

public enum MyUtils { 
    ; // no instances
    // class is final and the constructor is private

    public static int myUtilityMethod(int x) {
        return x * x;
    }
}

你可以调用它

int y = MyUtils.myUtilityMethod(5); // returns 25.

Answer 4

最佳实践是在构造类时抛出错误。

示例：

/**
 * The Class FooUtilityService.
 */
final class FooUtilityService{

/**
* Instantiates a new FooUtilityService. Private to prevent instantiation
*/
private FooUtilityService() {

    // Throw an exception if this ever *is* called
    throw new AssertionError("Instantiating utility class.");
}

Answer 5

添加私有构造函数：

private FilePathHelper(){
    super();
}

Answer 6

将实用程序类设为 final 并添加私有构造函数

Answer 7

public class LmsEmpWfhUtils {    
    private LmsEmpWfhUtils() 
    { 
    // prevents access default paramater-less constructor
    }
}

这可以防止在代码的其他地方使用默认的无参数构造函数。

Answer 8

SonarQube documentation 建议在类声明中添加 static 关键字。

即把public class FilePathHelper改成public static class FilePathHelper。

您也可以添加私有或受保护的构造函数。

public class FilePathHelper
{
    // private or protected constructor
    // because all public fields and methods are static
    private FilePathHelper() {
    }
}

Answer 9

我建议在 Sonar 中禁用此规则，引入私有构造函数并没有真正的好处，只是代码库中的冗余字符需要其他人阅读并且计算机需要存储和处理。

Answer 10

您可以只使用 Lombok 注释来避免不必要的初始化。

使用@NoArgsConstructor 和AccessLevel.PRIVATE 如下：

@NoArgsConstructor(access = AccessLevel.PRIVATE)
public class FilePathHelper {
   // your code 
}

Answer 11

使用 Lombok 的替代方法是使用 @UtilityClass 注释。

@UtilityClass 在 Lombok v1.16.2 中作为实验性功能引入：

如果一个类用@UtilityClass注解， 它发生了以下事情：

• 它被标记为final。
• 如果在其中声明了任何构造函数，则会生成错误。
  • 否则，私有无参数构造函数会生成；它会抛出一个UnsupportedOperationException。
• 类中的所有方法、内部类和字段都被标记 static。

概述：

实用程序类是一个只是函数命名空间的类。它的任何实例都不能存在，并且它的所有成员都是静态的。例如，java.lang.Math 和 java.util.Collections 是众所周知的实用程序类。

这个注解自动把被注解的类合二为一。

无法实例化实用程序类。

通过使用@UtilityClass 标记您的类，lombok 将自动生成一个私有构造函数，该构造函数会引发异常，将您添加的任何显式构造函数标记为错误，并将类标记为 final。

如果类是内部类，则该类也标记为static。

实用程序类的所有成员都会自动标记为静态。甚至是字段和内部类。

示例：

import lombok.experimental.UtilityClass;

@UtilityClass
public class FilePathHelper {

    private static String resourcesPath;

    public static String getFilePath(HttpServletRequest request) {
        if(resourcesPath == null) {
            ServletContext context = request.getSession().getServletContext();
            String serverpath = context.getRealPath("");               
            resourcesPath = serverpath + "/WEB-INF/classes/";   
        }
        return resourcesPath;       
    }
}

来自官方文档的参考：

• https://projectlombok.org/features/experimental/UtilityClass