Migliora l'ispezione del codice con le annotazioni

L'utilizzo di strumenti di ispezione del codice, come lint, può aiutarti a trovare problemi e migliorare il codice, ma gli strumenti di ispezione possono dedurre solo un numero limitato di informazioni. Ad esempio, gli ID risorsa Android utilizzano un int per identificare stringhe, elementi grafici, colori e altri tipi di risorse, pertanto gli strumenti di ispezione non possono stabilire quando hai specificato una risorsa stringa dove avresti dovuto specificare un colore. In questo caso, l'app potrebbe non essere visualizzata correttamente o non essere eseguita, anche se utilizzi l'ispezione del codice.

Le annotazioni ti consentono di fornire suggerimenti agli strumenti di ispezione del codice, come lint, per aiutarti a rilevare questi problemi più complessi del codice. Le annotazioni vengono aggiunte come tag di metadati che colleghi a variabili, parametri e valori restituiti per ispezionare i valori restituiti dai metodi, i parametri passati, le variabili locali e i campi. Se utilizzate con strumenti di ispezione del codice, le annotazioni possono aiutarti a rilevare problemi come eccezioni di puntatore nullo e conflitti di tipi di risorse.

Android supporta una serie di annotazioni tramite la libreria di annotazioni Jetpack. Puoi accedere alla libreria tramite il pacchetto androidx.annotation.

Nota:se un modulo ha una dipendenza da un processore di annotazioni, devi utilizzare la configurazione della dipendenza kapt o ksp per Kotlin o la configurazione della dipendenza annotationProcessor per Java per aggiungere la dipendenza.

Aggiungi annotazioni al progetto

Per attivare le annotazioni nel tuo progetto, aggiungi la dipendenza androidx.annotation:annotation alla tua libreria o app. Tutte le annotazioni che aggiungi vengono controllate quando esegui un'ispezione del codice o un'attività lint.

Aggiungi la dipendenza della libreria Jetpack Annotations

La libreria Jetpack Annotations è pubblicata nel Repository Maven di Google. Per aggiungere la libreria Jetpack Annotations al tuo progetto, includi la seguente riga nel blocco dependencies del file build.gradle o build.gradle.kts:

Kotlin

dependencies {
    implementation("androidx.annotation:annotation:1.11.0")
}

Alla moda

dependencies {
    implementation 'androidx.annotation:annotation:1.11.0'
}

Quindi, nella barra degli strumenti o nella notifica di sincronizzazione visualizzata, fai clic su Sincronizza ora.

Se utilizzi le annotazioni nel modulo della tua libreria, queste vengono incluse come parte dell'artefatto Android ARchive (AAR) in formato XML nel file annotations.zip. L'aggiunta della dipendenza androidx.annotation non introduce una dipendenza per gli utenti downstream della tua libreria.

Nota:se utilizzi altre librerie Jetpack, potresti non dover aggiungere la dipendenza androidx.annotation. Poiché molte altre librerie Jetpack dipendono dalla libreria Annotations, potresti già avere accesso alle annotazioni.

Per un elenco completo delle annotazioni incluse nel repository Jetpack, consulta la documentazione di riferimento della libreria Jetpack Annotations o utilizza la funzionalità di completamento automatico per visualizzare le opzioni disponibili per l'istruzione import androidx.annotation..

Esegui le ispezioni del codice

Per avviare un'ispezione del codice da Android Studio, che include la convalida delle annotazioni e il controllo automatico di lint, seleziona Analyze (Analizza) > Inspect Code (Ispeziona codice) dal menu. Android Studio mostra messaggi di conflitto per segnalare potenziali problemi in cui il codice è in conflitto con le annotazioni e per suggerire possibili soluzioni.

Puoi anche applicare le annotazioni eseguendo l'attività lint utilizzando la riga di comando. Sebbene ciò possa essere utile per segnalare problemi con un server di integrazione continua, l'attività lint non applica le annotazioni di nullità (descritte nella sezione seguente); solo Android Studio lo fa. Per ulteriori informazioni sull'attivazione e sull'esecuzione delle ispezioni lint, consulta Migliorare il codice con i controlli lint.

Anche se i conflitti di annotazioni generano avvisi, questi non impediscono la compilazione dell'app.

Annotazioni di nullità

Le annotazioni di nullità possono essere utili nel codice Java per stabilire se i valori possono essere nulli. Sono meno utili nel codice Kotlin, poiché Kotlin ha regole di supporto di valori null integrate che vengono applicate in tempo di compilazione.

Aggiungi le annotazioni @Nullable e @NonNull per verificare la nullità di una determinata variabile, parametro o valore restituito. L'annotazione @Nullable indica una variabile, un parametro o un valore restituito che può essere null. @NonNull indica una variabile, un parametro o un valore restituito che non può essere null.

Ad esempio, se una variabile locale che contiene un valore null viene passata come parametro a un metodo con l'annotazione @NonNull associata a quel parametro, la creazione del codice genera un avviso che indica un conflitto non null. Inoltre, il tentativo di fare riferimento al risultato di un metodo contrassegnato da @Nullable senza prima verificare se il risultato è null genera un avviso di nullità. Utilizza @Nullable sul valore restituito di un metodo solo se ogni utilizzo del metodo deve essere sottoposto a un controllo esplicito dei valori null.

L'esempio seguente mostra il supporto di valori null in azione. Il codice di esempio Kotlin non utilizza l'annotazione @NonNull perché viene aggiunta automaticamente al bytecode generato quando viene specificato un tipo non null. L'esempio Java utilizza l'annotazione @NonNull sui parametri context e attrs per verificare che i valori parametro passati non siano nulli. Verifica inoltre che il metodo onCreateView() stesso non restituisca null:

Kotlin

...
    /** Annotation not used because of the safe-call operator(?)**/
    override fun onCreateView(
            name: String?,
            context: Context,
            attrs: AttributeSet
    ): View? {
        ...
    }
...

Java

import androidx.annotation.NonNull;
...
    /** Add support for inflating the <fragment> tag. **/
    @NonNull
    @Override
    public View onCreateView(String name, @NonNull Context context,
      @NonNull AttributeSet attrs) {
      ...
      }
...

Analisi del supporto di valori null

Android Studio supporta l'esecuzione di un'analisi di nullabilità per dedurre e inserire automaticamente le annotazioni di nullità nel codice. Un'analisi di nullabilità analizza i contratti in tutte le gerarchie dei metodi nel codice per rilevare:

• Chiamata di metodi che possono restituire null.
• Metodi che non devono restituire null.
• Variabili, come campi, variabili locali e parametri, che possono essere null.
• Variabili, come campi, variabili locali e parametri, che non possono contenere un valore null.

L'analisi inserisce quindi automaticamente le annotazioni null appropriate nelle posizioni rilevate.

Per eseguire un'analisi di nullabilità in Android Studio, seleziona Analyze > Infer Nullity. Android Studio inserisce le annotazioni Android @Nullable e @NonNull nelle posizioni rilevate nel codice. Dopo aver eseguito un'analisi dei valori null, è buona norma verificare le annotazioni inserite.

Nota: Quando si aggiungono annotazioni di nullità, il completamento automatico può suggerire IntelliJ @Nullable E@NotNull annotazioni al posto delle annotazioni nulle di Android e può importare automaticamente la libreria corrispondente. Tuttavia, il controllo lint di Android Studio cerca solo le annotazioni null di Android. Quando verifichi le annotazioni, assicurati che il progetto utilizzi le annotazioni null di Android in modo che il controllo lint possa inviarti una notifica corretta durante l'ispezione del codice.

Annotazioni delle risorse

La convalida dei tipi di risorse può essere utile perché i riferimenti Android alle risorse, come le risorse drawable e string, vengono passati come numeri interi.

Il codice che prevede un parametro per fare riferimento a un tipo specifico di risorsa, ad esempio String, può essere passato al tipo di riferimento previsto di int, ma in realtà fa riferimento a un tipo di risorsa diverso, ad esempio una risorsa R.string.

Ad esempio, aggiungi annotazioni @StringRes per verificare se un parametro della risorsa contiene un riferimento R.string, come mostrato di seguito:

Kotlin

abstract fun setTitle(@StringRes resId: Int)

Java

public abstract void setTitle(@StringRes int resId)

Durante l'ispezione del codice, l'annotazione genera un avviso se un riferimento R.string non viene passato nel parametro.

Le annotazioni per altri tipi di risorse, come @DrawableRes, @DimenRes, @ColorRes e @InterpolatorRes, possono essere aggiunte utilizzando lo stesso formato di annotazione ed eseguite durante l'ispezione del codice.

Se il parametro supporta più tipi di risorse, puoi inserire più annotazioni del tipo di risorsa in un determinato parametro. Utilizza @AnyRes per indicare che il parametro annotato può essere qualsiasi tipo di risorsa R.

Sebbene sia possibile utilizzare @ColorRes per specificare che un parametro deve essere una risorsa di colore, un numero intero di colore (nel formato RRGGBB o AARRGGBB) non viene riconosciuto come risorsa di colore. Utilizza invece l'annotazione @ColorInt per indicare che un parametro deve essere un numero intero di colore. Gli strumenti di build segnaleranno il codice errato che passa un ID risorsa colore, ad esempio android.R.color.black, anziché un numero intero di colore, ai metodi annotati.

Annotazioni thread

Le annotazioni dei thread controllano se un metodo viene chiamato da un tipo specifico di thread. Sono supportate le seguenti annotazioni dei thread:

• @MainThread
• @UiThread
• @WorkerThread
• @BinderThread
• @AnyThread

Gli strumenti di build trattano le annotazioni @MainThread e @UiThread come intercambiabili, quindi puoi chiamare i metodi @UiThread dai metodi @MainThread e viceversa. Tuttavia, è possibile che un thread dell'interfaccia utente sia diverso dal thread principale, nel caso di app di sistema con più visualizzazioni su thread diversi. Pertanto, devi annotare i metodi associati alla gerarchia di oggetti View di un'app con @UiThread e annotare solo i metodi associati al ciclo di vita di un'app con @MainThread.

Se tutti i metodi di una classe condividono lo stesso requisito di threading, puoi aggiungere una singola annotazione di thread alla classe per verificare che tutti i metodi della classe vengano chiamati dallo stesso tipo di thread.

Un uso comune delle annotazioni dei thread è verificare che i metodi o le classi annotati con @WorkerThread vengano chiamati solo da un thread in background appropriato.

Annotazioni dei vincoli di valore

Utilizza le annotazioni @IntRange, @FloatRange e @Size per convalidare i valori dei parametri passati. Sia @IntRange che @FloatRange sono più utili se applicati a parametri in cui è probabile che gli utenti sbaglino l'intervallo.

L'annotazione @IntRange convalida che un valore parametro intero o lungo rientri in un intervallo specificato. L'esempio seguente indica che il parametro alpha deve contenere un valore intero compreso tra 0 e 255:

Kotlin

fun setAlpha(@IntRange(from = 0, to = 255) alpha: Int) { ... }

Java

public void setAlpha(@IntRange(from=0,to=255) int alpha) { ... }

L'annotazione @FloatRange verifica se il valore di un parametro float o double rientra in un intervallo specificato di valori in virgola mobile. L'esempio seguente indica che il parametro alpha deve contenere un valore in virgola mobile compreso tra 0,0 e 1,0:

Kotlin

fun setAlpha(@FloatRange(from = 0.0, to = 1.0) alpha: Float) {...}

Java

public void setAlpha(@FloatRange(from=0.0, to=1.0) float alpha) {...}

L'annotazione @Size controlla le dimensioni di una raccolta o di un array o la lunghezza di una stringa. L'annotazione @Size può essere utilizzata per verificare le seguenti qualità:

• Dimensioni minime, ad esempio @Size(min=2)
• Dimensioni massime, ad esempio @Size(max=2)
• Dimensioni esatte, ad esempio @Size(2)
• Un numero di cui la dimensione deve essere un multiplo, ad esempio @Size(multiple=2)

Ad esempio, @Size(min=1) controlla se una raccolta non è vuota e @Size(3) convalida che un array contenga esattamente tre valori.

L'esempio seguente indica che l'array location deve contenere almeno un elemento:

Kotlin

fun getLocation(button: View, @Size(min=1) location: IntArray) {
    button.getLocationOnScreen(location)
}

Java

void getLocation(View button, @Size(min=1) int[] location) {
    button.getLocationOnScreen(location);
}

Annotazioni delle autorizzazioni

Utilizza l'annotazione @RequiresPermission per convalidare le autorizzazioni del chiamante di un metodo. Per verificare una singola autorizzazione da un elenco di autorizzazioni valide, utilizza l'attributo anyOf. Per verificare un insieme di autorizzazioni, utilizza l'attributo allOf. L'esempio seguente annota il metodo setWallpaper() per indicare che il chiamante del metodo deve disporre dell'autorizzazione permission.SET_WALLPAPERS:

Kotlin

@RequiresPermission(Manifest.permission.SET_WALLPAPER)
@Throws(IOException::class)
abstract fun setWallpaper(bitmap: Bitmap)

Java

@RequiresPermission(Manifest.permission.SET_WALLPAPER)
public abstract void setWallpaper(Bitmap bitmap) throws IOException;

L'esempio seguente richiede che il chiamante del metodo copyImageFile() disponga sia dell'accesso in lettura allo spazio di archiviazione esterno sia dell'accesso in lettura ai metadati sulla posizione nell'immagine copiata:

Kotlin

@RequiresPermission(allOf = [
    Manifest.permission.READ_EXTERNAL_STORAGE,
    Manifest.permission.ACCESS_MEDIA_LOCATION
])
fun copyImageFile(dest: String, source: String) {
    ...
}

Java

@RequiresPermission(allOf = {
    Manifest.permission.READ_EXTERNAL_STORAGE,
    Manifest.permission.ACCESS_MEDIA_LOCATION})
public static final void copyImageFile(String dest, String source) {
    //...
}

Per le autorizzazioni sugli intent, inserisci il requisito di autorizzazione nel campo della stringa che definisce il nome dell'azione dell'intent:

Kotlin

@RequiresPermission(android.Manifest.permission.BLUETOOTH)
const val ACTION_REQUEST_DISCOVERABLE = "android.bluetooth.adapter.action.REQUEST_DISCOVERABLE"

Java

@RequiresPermission(android.Manifest.permission.BLUETOOTH)
public static final String ACTION_REQUEST_DISCOVERABLE =
            "android.bluetooth.adapter.action.REQUEST_DISCOVERABLE";

Per le autorizzazioni sui provider di contenuti che richiedono autorizzazioni separate per l'accesso in lettura e scrittura, inserisci ogni requisito di autorizzazione in un'annotazione @RequiresPermission.Read o @RequiresPermission.Write:

Kotlin

@RequiresPermission.Read(RequiresPermission(READ_HISTORY_BOOKMARKS))
@RequiresPermission.Write(RequiresPermission(WRITE_HISTORY_BOOKMARKS))
val BOOKMARKS_URI = Uri.parse("content://browser/bookmarks")

Java

@RequiresPermission.Read(@RequiresPermission(READ_HISTORY_BOOKMARKS))
@RequiresPermission.Write(@RequiresPermission(WRITE_HISTORY_BOOKMARKS))
public static final Uri BOOKMARKS_URI = Uri.parse("content://browser/bookmarks");

Autorizzazioni indirette

Quando un'autorizzazione dipende dal valore specifico fornito al parametro di un metodo, utilizza @RequiresPermission sul parametro stesso senza elencare le autorizzazioni specifiche. Ad esempio, il metodo startActivity(Intent) utilizza un'autorizzazione indiretta sull'intent passato al metodo:

Kotlin

abstract fun startActivity(@RequiresPermission intent: Intent, bundle: Bundle?)

Java

public abstract void startActivity(@RequiresPermission Intent intent, @Nullable Bundle)

Quando utilizzi le autorizzazioni indirette, gli strumenti di build eseguono l'analisi del flusso di dati per verificare se l'argomento passato al metodo contiene annotazioni @RequiresPermission. Quindi, applicano le annotazioni esistenti dal parametro al metodo stesso. Nell'esempio startActivity(Intent), le annotazioni nella classe Intent causano gli avvisi risultanti sugli utilizzi non validi di startActivity(Intent) quando un intent senza le autorizzazioni appropriate viene passato al metodo, come mostrato nella figura 1.

Figura 1. L'avviso generato da un'annotazione di autorizzazioni indirette sul metodo startActivity(Intent).

Gli strumenti di build generano l'avviso su startActivity(Intent) dall'annotazione sul nome dell'azione dell'intent corrispondente nella classe Intent:

Kotlin

@RequiresPermission(Manifest.permission.CALL_PHONE)
const val ACTION_CALL = "android.intent.action.CALL"

Java

@RequiresPermission(Manifest.permission.CALL_PHONE)
public static final String ACTION_CALL = "android.intent.action.CALL";

Se necessario, puoi sostituire @RequiresPermission con @RequiresPermission.Read o @RequiresPermission.Write quando annoti il parametro di un metodo. Tuttavia, per le autorizzazioni indirette, @RequiresPermission non deve essere utilizzato insieme alle annotazioni delle autorizzazioni di lettura o scrittura.

Annotazioni dei valori restituiti

Utilizza l'annotazione @CheckResult per verificare che il risultato o il valore restituito di un metodo venga effettivamente utilizzato. Anziché annotare ogni metodo non void con @CheckResult, aggiungi l'annotazione per chiarire i risultati di metodi potenzialmente poco chiari.

Ad esempio, i nuovi sviluppatori Java spesso pensano erroneamente che <String>.trim() rimuova gli spazi vuoti dalla stringa originale. L'annotazione del metodo con @CheckResult segnala gli utilizzi di <String>.trim() in cui il chiamante non esegue alcuna operazione con il valore restituito del metodo.

L'esempio seguente annota il metodo checkPermissions() per verificare se il valore restituito dal metodo viene effettivamente utilizzato. Inoltre, indica il metodo enforcePermission() come metodo da suggerire allo sviluppatore come sostituto:

Kotlin

@CheckResult(suggest = "#enforcePermission(String,int,int,String)")
abstract fun checkPermission(permission: String, pid: Int, uid: Int): Int

Java

@CheckResult(suggest="#enforcePermission(String,int,int,String)")
public abstract int checkPermission(@NonNull String permission, int pid, int uid);

Annotazioni CallSuper

Utilizza l'annotazione @CallSuper per convalidare che un metodo di override chiami l'implementazione super del metodo.

L'esempio seguente annota il metodo onCreate() per garantire che tutte le implementazioni del metodo di override chiamino super.onCreate():

Kotlin

@CallSuper
override fun onCreate(savedInstanceState: Bundle?) {
}

Java

@CallSuper
protected void onCreate(Bundle savedInstanceState) {
}

Annotazioni Typedef

Le annotazioni Typedef controllano se un determinato parametro, valore restituito o campo fa riferimento a un insieme specifico di costanti. Inoltre, consentono al completamento del codice di offrire automaticamente le costanti consentite.

Utilizza le annotazioni @IntDef e @StringDef per creare annotazioni enumerate di insiemi di numeri interi e stringhe per convalidare altri tipi di riferimenti di codice.

Le annotazioni Typedef utilizzano @interface per dichiarare il nuovo tipo di annotazione enumerata. Le annotazioni @IntDef e @StringDef, insieme a @Retention, annotano la nuova annotazione e sono necessarie per definire il tipo enumerato. L'annotazione @Retention(RetentionPolicy.SOURCE) indica al compilatore di non archiviare i dati delle annotazioni enumerate nel file .class.

L'esempio seguente mostra i passaggi per creare un'annotazione che verifica se un valore passato come parametro del metodo fa riferimento a una delle costanti definite:

Kotlin

import androidx.annotation.IntDef
//...
// Define the list of accepted constants and declare the NavigationMode annotation.
@Retention(AnnotationRetention.SOURCE)
@IntDef(NAVIGATION_MODE_STANDARD, NAVIGATION_MODE_LIST, NAVIGATION_MODE_TABS)
annotation class NavigationMode

// Declare the constants.
const val NAVIGATION_MODE_STANDARD = 0
const val NAVIGATION_MODE_LIST = 1
const val NAVIGATION_MODE_TABS = 2

abstract class ActionBar {

    // Decorate the target methods with the annotation.
    // Attach the annotation.
    @get:NavigationMode
    @setparam:NavigationMode
    abstract var navigationMode: Int

}

Java

import androidx.annotation.IntDef;
//...
public abstract class ActionBar {
    //...
    // Define the list of accepted constants and declare the NavigationMode annotation.
    @Retention(RetentionPolicy.SOURCE)
    @IntDef({NAVIGATION_MODE_STANDARD, NAVIGATION_MODE_LIST, NAVIGATION_MODE_TABS})
    public @interface NavigationMode {}

    // Declare the constants.
    public static final int NAVIGATION_MODE_STANDARD = 0;
    public static final int NAVIGATION_MODE_LIST = 1;
    public static final int NAVIGATION_MODE_TABS = 2;

    // Decorate the target methods with the annotation.
    @NavigationMode
    public abstract int getNavigationMode();

    // Attach the annotation.
    public abstract void setNavigationMode(@NavigationMode int mode);
}

Quando crei questo codice, viene generato un avviso se il parametro mode non fa riferimento a una delle costanti definite (NAVIGATION_MODE_STANDARD, NAVIGATION_MODE_LIST o NAVIGATION_MODE_TABS).

Combina @IntDef e @IntRange per indicare che un numero intero può essere un insieme di costanti o un valore compreso in un intervallo.

Abilita la combinazione di costanti con flag

Se gli utenti possono combinare le costanti consentite con un flag (ad esempio |, &, ^ e così via), puoi definire un'annotazione con un attributo flag per verificare se un parametro o un valore restituito fa riferimento a un pattern valido.

L'esempio seguente crea l'annotazione DisplayOptions con un elenco di costanti DISPLAY_ valide:

Kotlin

import androidx.annotation.IntDef
...

@IntDef(flag = true, value = [
    DISPLAY_USE_LOGO,
    DISPLAY_SHOW_HOME,
    DISPLAY_HOME_AS_UP,
    DISPLAY_SHOW_TITLE,
    DISPLAY_SHOW_CUSTOM
])
@Retention(AnnotationRetention.SOURCE)
annotation class DisplayOptions
...

Java

import androidx.annotation.IntDef;
...

@IntDef(flag=true, value={
        DISPLAY_USE_LOGO,
        DISPLAY_SHOW_HOME,
        DISPLAY_HOME_AS_UP,
        DISPLAY_SHOW_TITLE,
        DISPLAY_SHOW_CUSTOM
})
@Retention(RetentionPolicy.SOURCE)
public @interface DisplayOptions {}

...

Quando crei il codice con un flag di annotazione, viene generato un avviso se il parametro decorato o il valore restituito non fa riferimento a un pattern valido.

Mantieni annotazione

L'annotazione @Keep garantisce che una classe o un metodo annotato non venga rimosso quando il codice viene minimizzato in fase di build. Questa annotazione viene in genere aggiunta a metodi e classi a cui si accede tramite reflection per impedire al compilatore di trattare il codice come inutilizzato.

Attenzione : le classi e i metodi che annoti utilizzando @Keep vengono sempre visualizzati nell'APK della tua app, anche se non fai mai riferimento a queste classi e metodi all'interno della logica della tua app.

Per mantenere ridotte le dimensioni della tua app, valuta se è necessario conservare ogni annotazione @Keep nella tua app. Se utilizzi la riflessione per accedere a una classe o un metodo annotati, utilizza un'istruzione condizionale -if nelle regole di ProGuard, specificando la classe che effettua le chiamate di riflessione.

Per ulteriori informazioni su come minimizzare il codice e specificare quale codice non deve essere rimosso, consulta Riduci, offusca e ottimizza l'app.

Annotazioni sulla visibilità del codice

Utilizza le seguenti annotazioni per indicare la visibilità di parti specifiche del codice, come metodi, classi, campi o pacchetti.

Rendi visibile il codice per i test

L'annotazione @VisibleForTesting indica che un metodo annotato è più visibile di quanto normalmente necessario per renderlo testabile. Questa annotazione ha un argomento otherwise facoltativo che ti consente di designare la visibilità del metodo se non fosse necessario renderlo visibile per i test. Lint utilizza l'argomento otherwise per applicare la visibilità prevista.

Nell'esempio seguente, myMethod() è normalmente private, ma è package-private per i test. Con la designazione VisibleForTesting.PRIVATE, lint visualizza un messaggio se questo metodo viene chiamato dall'esterno del contesto consentito dall'accesso private, ad esempio da un'unità di compilazione diversa.

Kotlin

@VisibleForTesting(otherwise = VisibleForTesting.PRIVATE)
fun myMethod() {
    ...
}

Java

@VisibleForTesting(otherwise = VisibleForTesting.PRIVATE)
void myMethod() { ... }

Puoi anche specificare @VisibleForTesting(otherwise = VisibleForTesting.NONE) per indicare che un metodo esiste solo per i test. Questo modulo è uguale all'utilizzo di @RestrictTo(TESTS). Entrambi eseguono lo stesso controllo lint.

Limita un'API

L'annotazione @RestrictTo indica che l'accesso all'API annotata (pacchetto, classe o metodo) è limitato, come segue:

Sottoclassi

Utilizza il modulo di annotazione @RestrictTo(RestrictTo.Scope.SUBCLASSES) per limitare l'accesso all'API solo alle sottoclassi.

Solo le classi che estendono la classe annotata possono accedere a questa API. Il modificatore Java protected non è abbastanza restrittivo, perché consente l'accesso da classi non correlate all'interno dello stesso pacchetto. Inoltre, in alcuni casi è preferibile lasciare un metodo public per una maggiore flessibilità futura, perché non è mai possibile creare un metodo public precedentemente protected e sottoposto a override, ma vuoi fornire un suggerimento che la classe è destinata a essere utilizzata solo all'interno della classe o dalle sottoclassi.

Librerie

Utilizza il modulo di annotazione @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP_PREFIX) per limitare l'accesso all'API solo alle tue librerie.

Solo il codice della libreria può accedere all'API annotata. In questo modo, non solo puoi organizzare il codice nella gerarchia di pacchetti che preferisci, ma anche condividerlo tra un gruppo di librerie correlate. Questa opzione è già disponibile per le librerie Jetpack che hanno molto codice di implementazione non destinato all'uso esterno, ma che deve essere public per condividerlo tra le varie librerie Jetpack complementari.

Test

Utilizza il modulo di annotazione @RestrictTo(RestrictTo.Scope.TESTS) per impedire ad altri sviluppatori di accedere alle tue API di test.

Solo il codice di test può accedere all'API annotata. In questo modo, altri sviluppatori non possono utilizzare per lo sviluppo API che intendi utilizzare solo a scopo di test.