¿Cómo deshabilitar la advertencia en Sonar: Hide Utility Class Constructor?

Recibo esta advertencia en Sonar:

Ocultar constructor de clase de utilidad:

Las clases de utilidad no deben tener un constructor público o predeterminado

Mi clase:

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;       
    }
}

Quiero una solución para eliminar esto. advertencia en Sonda Qube.

Si esta clase es solo una clase de utilidad, debe hacer que la clase sea final y definir un constructor privado:

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

Esto evita que el constructor predeterminado sin parámetros se use en otras partes de su código.

Además, puede hacer que la clase sea final, de modo que no se pueda ampliar en subclases, lo cual es una buena práctica para las clases de utilidad. Dado que declaró solo un constructor privado, otras clases no podrían extenderlo de todos modos, pero aún es una buena práctica marcar la clase como final.

No conozco a Sonar, pero sospecho que está buscando un constructor privado:

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

De lo contrario, el compilador de Java proporcionará un constructor público sin parámetros, que realmente no desea.

(También debe hacer que la clase sea final, aunque otras clases no podrían extenderla de todos modos debido a que solo tiene un constructor privado).

Uso una enumeración sin instancias.

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

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

puedes llamar a esto usando

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

La mejor práctica es arrojar un error si se construye la clase.

Ejemplo:

/**
 * 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.");
}

Puede usar la anotación de Lombok para evitar una inicialización innecesaria.

Usando @NoArgsConstructor con AccessLevel.PRIVATE como abajo:

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

Recomiendo simplemente deshabilitar esta regla en Sonar, no hay un beneficio real de introducir un constructor privado, solo caracteres redundantes en su base de código que otras personas necesitan leer y la computadora necesita almacenar y procesar.

uso alternativo Lombok es uso @UtilityClass anotación.

@UtilityClass se introdujo como una característica experimental en Lombok v1.16.2:

Si una clase se anota con @UtilityClassle suceden las siguientes cosas:

• Está marcado como definitivo.
• Si se declaran constructores en él, se genera un error.
  • De lo contrario, un constructor privado sin argumentos es generado; lanza un UnsupportedOperationException.
• Todos los métodosclases internas y campos en la clase están marcados static.

Visión general:

Una clase de utilidad es una clase que es solo un espacio de nombres para funciones. No pueden existir instancias de él, y todos sus miembros son estáticos. Por ejemplo, java.lang.Math y java.util.Collections son clases de utilidad bien conocidas.

Esta anotación convierte automáticamente la clase anotada en una.

No se puede instanciar una clase de utilidad.

Marcando tu clase con @UtilityClass, lombok generará automáticamente un constructor privado que arroja una excepción, marca como error cualquier constructor explícito que agregue y marca la clase como final.

Si la clase es una clase interna, la clase también se marca estático.

Todos los miembros de una clase de utilidad se marcan automáticamente como estáticos. Incluso campos y clases internas.

Ejemplo:

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;       
    }
}

Referencia de la documentación oficial:

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