Quelle annotation `@NotNull` dois-je choisir pour mon code Java ?

Comment choisir la bonne annotation @NotNull pour votre code Java

Pour améliorer la lisibilité du code et éviter les exceptions NullPointerExceptions, de nombreux développeurs cherchent à tirer parti des outils tels que l'analyse statique de l'IDE et FindBugs. Cependant, la prolifération d’annotations @NotNull/@NonNull équivalentes peut être intimidante. Cet article examine les options disponibles pour vous aider à sélectionner celle qui convient le mieux.

Annotations équivalentes

La liste suivante fournit des annotations @NotNull équivalentes provenant de divers packages :

• javax.validation.constraints.NotNull (validation d'exécution uniquement)
• edu.umd.cs.findbugs.annotations.NonNull (FindBugs/SpotBugs)
• javax.annotation.Nonnull (JSR-305 inactif)
• org.jetbrains .annotations.NotNull (IntelliJ IDÉE)
• lombok.NonNull (Projet Lombok)
• androidx.annotation.NonNull (package d'annotations Android)
• org.eclipse.jdt.annotation.NonNull (Eclipse)

Critères de Sélection

Avec JSR 305 inactif, le choix de l'annotation @NotNull implique une approche pragmatique.

Syntaxe

Pour des raisons stylistiques, considérer éviter les annotations liées à des IDE, des frameworks ou des boîtes à outils spécifiques. Cela élimine les éléments suivants options :

• android.support.annotation
• edu.umd.cs.findbugs.annotations
• org.eclipse.jdt.annotation
• o rg.jetbrains.annotations
• org.checkerframework.checker.nullness.qual
• lombok.NonNull

javax.annotation ou javax.validation.constraints ?

La comparaison de javax.validation.constraints et javax.annotation, qui nécessitent des dépendances supplémentaires, révèle une légère préférence pour javax.annotation pour son brièveté.

Implémentation

Similarités :Toutes les annotations @NonNull ont une implémentation triviale, sauf :

• org .jetbrains.annotations (trivial implémentation)
• javax.annotation (implémentation plus longue)
• javax.validation.constraints (implémentation avec annotation d'exécution)

Différences : Runtime annotations (javax.annotation, javax.validation.constraints, org.checkerframework.checker.nullness.qual) fournissent des contrôles d'exécution supplémentaires mais ont moins d'impact que prévu.

Contextes utilisables

Les annotations diffèrent par leurs contextes utilisables :

• Certains suivent les contextes de style JLS 9.6.4.1 (android.support.annotation, edu.umd.cs.findbugs.annotations, org.jetbrains.annotation, lombok, javax.validation.constraints).
• D'autres activent l'annotation sur tous les contextes JLS (lombok, org.jetbrains.annotations).

Conclusion

Sur la base des critères discutés, le choix pragmatique pour une annotation @NotNull est javax.annotation.Nonnull. Sa brièveté, ses annotations d'exécution et sa compatibilité avec les contextes JLS offrent une solution équilibrée pour la lisibilité, l'analyse statique et les contrôles d'exécution.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!