Éviter de vérifier l'instruction Null en Java

1. Vue d'ensemble

En règle générale, les variables nulles , les références et les collections sont difficiles à gérer dans le code Java. Non seulement ils sont difficiles à identifier, mais ils sont également complexes à gérer.

En fait, tout échec dans le traitement de null ne peut pas être identifié au moment de la compilation et entraîne une exception NullPointerException au moment de l'exécution.

Dans ce didacticiel, nous examinerons la nécessité de vérifier la valeur null en Java et diverses alternatives qui nous aident à éviter les vérifications nulles dans notre code.

2. Qu'est-ce que NullPointerException?

Selon le Javadoc pour NullPointerException , il est levé lorsqu'une application tente d'utiliser null dans un cas où un objet est requis, tel que:

  • Appel d'une méthode d'instance d'un objet nul
  • Accéder ou modifier un champ d'un objet nul
  • Prendre la longueur de null comme s'il s'agissait d'un tableau
  • Accéder ou modifier les slots de null comme s'il s'agissait d'un tableau
  • Lancer null comme s'il s'agissait d'une valeur Throwable

Voyons rapidement quelques exemples du code Java à l'origine de cette exception:

public void doSomething() { String result = doSomethingElse(); if (result.equalsIgnoreCase("Success")) // success } } private String doSomethingElse() { return null; }

Ici, nous avons essayé d'appeler un appel de méthode pour une référence nulle . Cela entraînerait une NullPointerException.

Un autre exemple courant est si nous essayons d'accéder à un tableau nul :

public static void main(String[] args) { findMax(null); } private static void findMax(int[] arr) { int max = arr[0]; //check other elements in loop }

Cela provoque une NullPointerException à la ligne 6.

Ainsi, accéder à n'importe quel champ, méthode ou index d'un objet nul provoque une NullPointerException , comme on peut le voir dans les exemples ci-dessus.

Un moyen courant d'éviter l' exception NullPointerException consiste à vérifier la valeur null :

public void doSomething() { String result = doSomethingElse(); if (result != null && result.equalsIgnoreCase("Success")) { // success } else // failure } private String doSomethingElse() { return null; }

Dans le monde réel, les programmeurs ont du mal à identifier quels objets peuvent être nuls. Une stratégie de sécurité agressive pourrait consister à vérifier null pour chaque objet. Cependant, cela entraîne de nombreuses vérifications nulles redondantes et rend notre code moins lisible.

Dans les prochaines sections, nous passerons en revue certaines des alternatives en Java qui évitent une telle redondance.

3. Gestion de null via le contrat API

Comme indiqué dans la dernière section, l'accès aux méthodes ou aux variables d' objets nuls provoque une exception NullPointerException. Nous avons également discuté du fait que mettre une vérification null sur un objet avant d'y accéder élimine la possibilité de NullPointerException.

Cependant, il existe souvent des API qui peuvent gérer des valeurs nulles . Par exemple:

public void print(Object param) { System.out.println("Printing " + param); } public Object process() throws Exception { Object result = doSomething(); if (result == null) { throw new Exception("Processing fail. Got a null response"); } else { return result; } }

L' appel de la méthode print () afficherait simplement «null» mais ne lèverait pas d'exception. De même, process () ne retournerait jamais null dans sa réponse. Cela jette plutôt une exception.

Ainsi, pour un code client accédant aux API ci-dessus, il n'est pas nécessaire de vérifier la valeur nulle .

Cependant, ces API doivent le rendre explicite dans leur contrat. Le JavaDoc est un endroit courant où les API publient un tel contrat .

Ceci, cependant, ne donne aucune indication claire sur le contrat d'API et repose donc sur les développeurs de code client pour assurer sa conformité.

Dans la section suivante, nous verrons comment quelques IDE et autres outils de développement aident les développeurs dans ce domaine.

4. Automatisation des contrats API

4.1. Utilisation de l'analyse de code statique

Les outils d'analyse de code statique permettent d'améliorer considérablement la qualité du code. Et quelques-uns de ces outils permettent également aux développeurs de maintenir le contrat nul . Un exemple est FindBugs.

FindBugs aide à gérer le contrat nul via les annotations @Nullable et @NonNull . Nous pouvons utiliser ces annotations sur n'importe quelle méthode, champ, variable locale ou paramètre. Cela rend explicite au code client si le type annoté peut être nul ou non. Voyons un exemple:

public void accept(@Nonnull Object param) { System.out.println(param.toString()); }

Ici, @NonNull indique clairement que l'argument ne peut pas être nul. Si le code client appelle cette méthode sans vérifier l'argument pour null, FindBugs générerait un avertissement au moment de la compilation.

4.2. Utilisation du support IDE

Les développeurs s'appuient généralement sur les IDE pour écrire du code Java. Et des fonctionnalités telles que l'achèvement de code intelligent et des avertissements utiles, comme lorsqu'une variable n'a peut-être pas été affectée, aident certainement dans une grande mesure.

Certains IDE permettent également aux développeurs de gérer les contrats d'API et éliminent ainsi le besoin d'un outil d'analyse de code statique. IntelliJ IDEA fournit les annotations @NonNull et @Nullable . Pour ajouter la prise en charge de ces annotations dans IntelliJ, nous devons ajouter la dépendance Maven suivante:

 org.jetbrains annotations 16.0.2 

Désormais, IntelliJ générera un avertissement si la vérification nulle est manquante, comme dans notre dernier exemple.

IntelliJ fournit également une annotation de contrat pour la gestion de contrats API complexes.

5. Assertions

Jusqu'à présent, nous n'avons parlé que de la suppression du besoin de vérifications nulles du code client. Mais cela est rarement applicable dans les applications du monde réel.

Supposons maintenant que nous travaillions avec une API qui ne peut pas accepter de paramètres nuls ou qui peut renvoyer une réponse nulle qui doit être gérée par le client . Cela présente la nécessité pour nous de vérifier les paramètres ou la réponse pour une valeur nulle .

Here, we can use Java Assertions instead of the traditional null check conditional statement:

public void accept(Object param){ assert param != null; doSomething(param); }

In line 2, we check for a null parameter. If the assertions are enabled, this would result in an AssertionError.

Although it is a good way of asserting pre-conditions like non-null parameters, this approach has two major problems:

  1. Assertions are usually disabled in a JVM
  2. A false assertion results in an unchecked error that is irrecoverable

Hence, it is not recommended for programmers to use Assertions for checking conditions. In the following sections, we'll discuss other ways of handling null validations.

6. Avoiding Null Checks Through Coding Practices

6.1. Preconditions

It's usually a good practice to write code that fails early. Therefore, if an API accepts multiple parameters that aren't allowed to be null, it's better to check for every non-null parameter as a precondition of the API.

For example, let's look at two methods – one that fails early, and one that doesn't:

public void goodAccept(String one, String two, String three) { if (one == null || two == null || three == null) { throw new IllegalArgumentException(); } process(one); process(two); process(three); } public void badAccept(String one, String two, String three) { if (one == null) { throw new IllegalArgumentException(); } else { process(one); } if (two == null) { throw new IllegalArgumentException(); } else { process(two); } if (three == null) { throw new IllegalArgumentException(); } else { process(three); } }

Clearly, we should prefer goodAccept() over badAccept().

As an alternative, we can also use Guava's Preconditions for validating API parameters.

6.2. Using Primitives Instead of Wrapper Classes

Since null is not an acceptable value for primitives like int, we should prefer them over their wrapper counterparts like Integer wherever possible.

Consider two implementations of a method that sums two integers:

public static int primitiveSum(int a, int b) { return a + b; } public static Integer wrapperSum(Integer a, Integer b) { return a + b; }

Now, let's call these APIs in our client code:

int sum = primitiveSum(null, 2);

This would result in a compile-time error since null is not a valid value for an int.

And when using the API with wrapper classes, we get a NullPointerException:

assertThrows(NullPointerException.class, () -> wrapperSum(null, 2));

There are also other factors for using primitives over wrappers, as we covered in another tutorial, Java Primitives versus Objects.

6.3. Empty Collections

Occasionally, we need to return a collection as a response from a method. For such methods, we should always try to return an empty collection instead of null:

public List names() { if (userExists()) { return Stream.of(readName()).collect(Collectors.toList()); } else { return Collections.emptyList(); } }

Hence, we've avoided the need for our client to perform a null check when calling this method.

7. Using Objects

Java 7 introduced the new Objects API. This API has several static utility methods that take away a lot of redundant code. Let's look at one such method, requireNonNull():

public void accept(Object param) { Objects.requireNonNull(param); // doSomething() }

Now, let's test the accept() method:

assertThrows(NullPointerException.class, () -> accept(null));

So, if null is passed as an argument, accept() throws a NullPointerException.

This class also has isNull() and nonNull() methods that can be used as predicates to check an object for null.

8. Using Optional

8.1. Using orElseThrow

Java 8 introduced a new Optional API in the language. This offers a better contract for handling optional values compared to null. Let's see how Optional takes away the need for null checks:

public Optional process(boolean processed) { String response = doSomething(processed); if (response == null) { return Optional.empty(); } return Optional.of(response); } private String doSomething(boolean processed) { if (processed) { return "passed"; } else { return null; } }

By returning an Optional, as shown above, the process method makes it clear to the caller that the response can be empty and must be handled at compile time.

This notably takes away the need for any null checks in the client code. An empty response can be handled differently using the declarative style of the Optional API:

assertThrows(Exception.class, () -> process(false).orElseThrow(() -> new Exception()));

Furthermore, it also provides a better contract to API developers to signify to the clients that an API can return an empty response.

Although we eliminated the need for a null check on the caller of this API, we used it to return an empty response. To avoid this, Optional provides an ofNullable method that returns an Optional with the specified value, or empty, if the value is null:

public Optional process(boolean processed) { String response = doSomething(processed); return Optional.ofNullable(response); }

8.2. Using Optional with Collections

While dealing with empty collections, Optional comes in handy:

public String findFirst() { return getList().stream() .findFirst() .orElse(DEFAULT_VALUE); }

This function is supposed to return the first item of a list. The Stream API's findFirst function will return an empty Optional when there is no data. Here, we have used orElse to provide a default value instead.

This allows us to handle either empty lists, or lists, which after we have used the Stream library's filter method, have no items to supply.

Alternatively, we can also allow the client to decide how to handle empty by returning Optional from this method:

public Optional findOptionalFirst() { return getList().stream() .findFirst(); }

Therefore, if the result of getList is empty, this method will return an empty Optional to the client.

Using Optional with collections allows us to design APIs that are sure to return non-null values, thus avoiding explicit null checks on the client.

It's important to note here that this implementation relies on getList not returning null. However, as we discussed in the last section, it's often better to return an empty list rather than a null.

8.3. Combining Optionals

When we start making our functions return Optional we need a way to combine their results into a single value. Let's take our getList example from earlier. What if it were to return an Optional list, or were to be wrapped with a method that wrapped a null with Optional using ofNullable?

Our findFirst method wants to return an Optional first element of an Optional list:

public Optional optionalListFirst() { return getOptionalList() .flatMap(list -> list.stream().findFirst()); }

By using the flatMap function on the Optional returned from getOptional we can unpack the result of an inner expression that returns Optional. Without flatMap, the result would be Optional . The flatMap operation is only performed when the Optional is not empty.

9. Libraries

9.1. Using Lombok

Lombok is a great library that reduces the amount of boilerplate code in our projects. It comes with a set of annotations that take the place of common parts of code we often write ourselves in Java applications, such as getters, setters, and toString(), to name a few.

Another of its annotations is @NonNull. So, if a project already uses Lombok to eliminate boilerplate code, @NonNull can replace the need for null checks.

Before we move on to see some examples, let's add a Maven dependency for Lombok:

 org.projectlombok lombok 1.18.6 

Now, we can use @NonNull wherever a null check is needed:

public void accept(@NonNull Object param){ System.out.println(param); }

So, we simply annotated the object for which the null check would've been required, and Lombok generates the compiled class:

public void accept(@NonNull Object param) { if (param == null) { throw new NullPointerException("param"); } else { System.out.println(param); } }

If param is null, this method throws a NullPointerException. The method must make this explicit in its contract, and the client code must handle the exception.

9.2. Using StringUtils

Generally, String validation includes a check for an empty value in addition to null value. Therefore, a common validation statement would be:

public void accept(String param){ if (null != param && !param.isEmpty()) System.out.println(param); }

This quickly becomes redundant if we have to deal with a lot of String types. This is where StringUtils comes handy. Before we see this in action, let's add a Maven dependency for commons-lang3:

 org.apache.commons commons-lang3 3.8.1 

Let's now refactor the above code with StringUtils:

public void accept(String param) { if (StringUtils.isNotEmpty(param)) System.out.println(param); }

So, we replaced our null or empty check with a static utility method isNotEmpty(). This API offers other powerful utility methods for handling common String functions.

10. Conclusion

Dans cet article, nous avons examiné les différentes raisons de NullPointerException et pourquoi il est difficile de l'identifier. Ensuite, nous avons vu différentes manières d'éviter la redondance dans le code autour de la vérification de null avec des paramètres, des types de retour et d'autres variables.

Tous les exemples sont disponibles sur GitHub.