Esiste un'annotazione predefinita a livello di classe che NON è deprecata che specifica i valori di ritorno non nulli per impostazione predefinita

Question

Google mi sta fallendo. C'era questa annotazione: ReturnValuesAreNonnullByDefault.

Ma questo è ora deprecato e javadoc non indica quale nuova annotazione utilizzare. @Nonnull sull'intera classe non si applica ai valori restituiti perché l'ho appena testato e non ricevo alcun avviso per un metodo che restituisce null. Non voglio dover annotare specificamente ogni singolo valore di ritorno, quindi c'è una buona opzione là fuori?

Answer 1

È possibile utilizzare this answer per costruire il proprio semplice @EverythingIsNonnullByDefault annotazione da applicare a livello di pacchetto/classe per coprire tutti i casi, o this one che mostra come creare annotazioni distinte per governare campi e valori di ritorno metodo. Abbiamo scelto di usarli tutti, ma tendiamo ad applicare la versione "tutto" a livello di pacchetto.

Se hai fretta, copia e incolla l'annotazione obsoleta e rimuovi la deprecazione.

package com.sample; 

import java.lang.annotation.Documented; 
import java.lang.annotation.ElementType; 
import java.lang.annotation.Retention; 
import java.lang.annotation.RetentionPolicy; 

import javax.annotation.meta.TypeQualifierDefault; 

/** 
* This annotation can be applied to a package or class to indicate that the 
* classes' methods in that element all return nonnull values by default 
* unless there is 
* <ul> 
* <li>an explicit nullness annotation 
* <li>a default method annotation applied to a more tightly nested element. 
* </ul> 
*/ 
@Documented 
@Nonnull 
@TypeQualifierDefault(ElementType.METHOD) 
@Retention(RetentionPolicy.RUNTIME) 
public @interface ReturnValuesAreNonnullByDefault { 
    // feel free to name it MethodsAreNonnullByDefault; I find that confusing 
} 

Answer 2

Se si utilizza il Checker Framework, quindi è possibile utilizzare @DefaultQualifier. Ad esempio, si potrebbe scrivere

@DefaultQualifier(value=NonNull.class, locations=DefaultLocation.RETURNS) 

Tuttavia, non è necessario fare questo perché di Nullness Checker il Checker Framework utilizza già quello di default. (Come hai scoperto, l'impostazione predefinita migliore è quella di assumere che ogni metodo restituisca null.)

Un vantaggio di Nullness Checker è che rileva più errori relativi al puntatore nullo rispetto a FindBugs.

Il Nullness Checker è compatible con le annotazioni di FindBugs, quindi puoi provare il Nullness Checker senza dover modificare le annotazioni di FindBug esistenti nel codice.