Czy istnieje domyślna adnotacja na poziomie klasy, która NIE jest przestarzała, która domyślnie określa wartości zwracane niepuste?

Question

Google mnie zawodzi. Wcześniej ta adnotacja: ReturnValuesAreNonnullByDefault.

Ale teraz jest to przestarzałe, a javadoc nie wskazuje, którą nową adnotację należy użyć. @Nonnull na całej klasie nie ma zastosowania do zwracanych wartości, ponieważ właśnie to przetestowałem i nie otrzymuję ostrzeżenia dla metody zwracającej wartość null. Nie chcę specjalnie opisywać każdej wartości zwracanej, więc czy jest tam dobra opcja?

Answer 1

Można użyć this answer zbudować własny prosty @EverythingIsNonnullByDefault adnotacji do zastosowania na poziomie pakietu/klasy, aby objąć wszystkie przypadki, albo this one który pokazuje jak tworzyć oddzielne adnotacje rządzić pola i wartości Sposób powrotu. Zdecydowaliśmy się użyć ich wszystkich, ale zazwyczaj stosujemy wersję "wszystko" na poziomie pakietu.

Jeśli naprawdę się spieszysz, skopiuj i wklej wycofaną adnotację i usuń ją.

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

Jeśli używasz Checker Framework, a następnie można użyć @DefaultQualifier. Na przykład, można napisać

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

Jednak nie trzeba tego robić, ponieważ ramowego Nullness Checker Checker wykorzystuje już, że domyślnie. (Jak można się przekonać, najlepszą domyślną wartością jest założenie, że każda metoda zwraca wartość null).

Zaletą modułu sprawdzającego nieważność jest to, że wykrywa on więcej błędów związanych z zerowymi wskaźnikami niż FindBugs.

Narzędzie do sprawdzania punktów zerowych ma wartość compatible z adnotacjami FindBugs, dzięki czemu można wypróbować narzędzie do sprawdzania punktów zerowych bez konieczności zmiany istniejących adnotacji FindBugs w kodzie.