redhat-developer / redhat-developer/vscode-java

@Nonnull fields are assumed to be non-null in the constructor

Abierto
#2,713 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

bug code analysis upstream
Lenguaje dominante
TypeScript
Estrellas
2.3k
Forks
546
Merge medio
20 h 1 min
PR fusionados (30 d)
11

Descripción

Class fields annotated with @Nonnull are currently assumed to never be null in the class constructor.
@Nonnull only provides guarantees after construction has finished, and checking these fields in the constructor is often useful to avoid boilerplate variables.

A toy example illustrating the issue:

public class AnnotatedClass {
    private @Nonnull String specialValue;
    private @Nonnull Map<String, String> allValues = new HashMap<>();

    /* this constructor incorrectly warns that specialValue might not have been initialized */
    public AnnotatedClass(Iterable<String> values) {
        for (String entry : values)
        {
            String[] split = entry.split("=", 1);
            if (split.length != 2) throw new IllegalArgumentException("Value improperly formatted");

            final String key = split[0];
            final String value = split[1];
            if (value == null) /* needed to avoid warning on the assignment to specialValue later */
                continue;      /* side note: ideally we wouldn't need this, and the IDE           */
                               /*  would recognize that entry.split returns array of non-null     */
            this.allValues.put(key, value);
            if ("specialKey".equals(key))
                this.specialValue = value;
        }
        if (this.specialValue == null) /* the next line incorrectly produces a dead code warning */
            throw new IllegalArgumentException("The provided iterable does not have a special value!");
    }
}
Environment
  • Operating System: Windows 10 Enterprise
  • JDK version: openjdk 11.0.12 2021-07-20
  • Visual Studio Code version: 1.71.2
  • Java extension version: v1.11.0

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Empieza reproduciendo la advertencia con el ejemplo proporcionado de AnnotatedClass en VS Code usando la extensión de Java y el entorno de JDK indicado. Rastrea el comportamiento del análisis de valores nulos para los campos @Nonnull durante la construcción; se considera terminado cuando la comprobación de nulos y la asignación posterior ya no producen advertencias incorrectas, mientras que los problemas reales siguen notificándose.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
java
Área
devtools
Tipo de issue
Error
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.