Panoramica del file manifest dell'app

Ogni progetto di app deve avere un file AndroidManifest.xml, con lo stesso scopo nome, alla radice del set di origini del progetto. Il file manifest descrive informazioni essenziali informazioni sulla tua app agli strumenti di sviluppo Android, al sistema operativo Android e su Google Play.

Tra le tante altre cose, il file manifest deve dichiarare quanto segue:

• I componenti dell'app, tra cui tutte le attività, i servizi, i ricevitori di trasmissione e i fornitori di contenuti. Ogni componente deve definire come il nome della relativa classe Kotlin o Java. Può anche dichiarare quali le configurazioni dei dispositivi che è in grado di gestire filtri per intent che descrivono come è possibile avviare il componente. Scopri di più sui componenti delle app nelle sezioni seguenti.
• Le autorizzazioni necessarie all'app per accedere a parti protette del sistema o ad altre app. Dichiara inoltre tutte le autorizzazioni che le altre app devono avere per accedere ai contenuti di questa app. Scopri di più sulle autorizzazioni nella sezione successiva.
• Le funzionalità hardware e software richieste dall'app, che incidono sulle I dispositivi possono installare l'app da Google Play. Scopri di più sulla compatibilità dei dispositivi in una sezione successiva.

Se utilizzi Android Studio per creare la tua app, il file manifest viene creato automaticamente e la maggior parte degli elementi manifest essenziali vengono aggiunti durante la creazione dell'app, soprattutto quando usi i modelli di codice.

Funzionalità dei file

Le seguenti sezioni descrivono in che modo alcune delle caratteristiche più importanti della tua app sono indicate nel file manifest.

Componenti dell'app

Per ogni componente dell'app che crei nella tua app, dichiara un elemento XML corrispondente nel file manifest:

• <activity> per ogni sottoclasse di Activity
• <service> per ogni sottoclasse di Service
• <receiver> per ogni sottoclasse di BroadcastReceiver
• <provider> per ogni sottoclasse di ContentProvider

Se crei sottoclassi di questi componenti senza dichiararlo nel file manifest , il sistema non riesce ad avviarlo.

Specifica il nome della sottoclasse con l'attributo name, utilizzando la designazione completa del pacchetto. Ad esempio, un Activity sottoclasse è dichiarata come segue:

<manifest ... >
    <application ... >
        <activity android:name="com.example.myapp.MainActivity" ... >
        </activity>
    </application>
</manifest>

Tuttavia, se il primo carattere nel valore name è un punto, allo spazio dei nomi dell'app, dal file build.gradle a livello di modulo namespace è preceduta dal prefisso del nome. Ad esempio, se lo spazio dei nomi è "com.example.myapp", il seguente nome dell'attività viene risolto in com.example.myapp.MainActivity:

<manifest ... >
    <application ... >
        <activity android:name=".MainActivity" ... >
            ...
        </activity>
    </application>
</manifest>

Per ulteriori informazioni sull'impostazione del nome del pacchetto o dello spazio dei nomi, consulta Impostare lo spazio dei nomi.

Se i componenti dell'app si trovano in sottopacchetti, ad esempio in com.example.myapp.purchases, il valore name deve aggiungere i nomi dei sottopacchetti mancanti, ad esempio ".purchases.PayActivity", o utilizzare il nome del pacchetto completo.

Filtri per intent

Le attività, i servizi e i ricevitori di trasmissione delle app vengono attivati dagli intent. Un'intenzione è un messaggio definito da un oggetto Intent che descrive un'azione da eseguire, inclusi i dati su cui intervenire, la categoria del componente che deve eseguire l'azione e altre istruzioni.

Quando un'app emette un intent al sistema, quest'ultimo individua un componente dell'app in grado di gestire l'intent in base alle dichiarazioni del filtro per intent nel file manifest di ogni app. Il sistema avvia un'istanza del componente corrispondente e passa l'oggetto Intent a questo componente. Se più app possono gestire l'intento, l'utente può selezionare l'app da utilizzare.

Un componente dell'app può avere un numero illimitato di filtri intent (definiti con l'elemento <intent-filter>), ognuno dei quali descrive una funzionalità diversa del componente.

Per saperne di più, consulta il documento Intent e filtri intent.

Icone ed etichette

Diversi elementi manifest hanno gli attributi icon e label per mostrare agli utenti rispettivamente una piccola icona e un'etichetta di testo per il componente dell'app corrispondente.

In ogni caso, l'icona e l'etichetta impostate in un elemento principale diventano i valori predefiniti di icon e label per tutti gli elementi secondari. Ad esempio, l'icona e l'etichetta impostate nel <application> sono l'icona e l'etichetta predefinite per ogni componente dell'app, ad esempio tutte le attività.

L'icona e l'etichetta impostate nella cartella <intent-filter> vengono mostrati all'utente ogni volta che il componente viene presentato come opzione per soddisfare un intento. Per impostazione predefinita, questa icona viene ereditata dall'icona dichiarata per il componente principale, ovvero dall'elemento <activity> o <application>.

Potresti voler cambiare l'icona per un filtro per intent se fornisce un'azione univoca che vorresti indicare meglio nel finestra di dialogo del selettore. Per ulteriori informazioni, vedi Consentire ad altre app di avviare la tua attività.

Autorizzazioni

Le app per Android devono richiedere l'autorizzazione per accedere a dati utente sensibili, come contatti e SMS, o a determinate funzionalità di sistema, come la fotocamera e l'accesso a internet. Ogni autorizzazione è identificata da un'etichetta univoca. Ad esempio, un'app che deve inviare messaggi SMS deve avere la seguente riga nel file manifest:

<manifest ... >
    <uses-permission android:name="android.permission.SEND_SMS"/>
    ...
</manifest>

Inizia con Android 6.0 (livello API 23), l'utente può approvare o rifiutare alcune autorizzazioni app in fase di runtime. Tuttavia, indipendentemente dalla versione di Android supportata dalla tua app, devi dichiarare tutte le richieste di autorizzazione con un elemento <uses-permission> nel manifest. Se l'autorizzazione viene concessa, l'app può usare le funzionalità di machine learning. In caso contrario, i tentativi di accesso a queste funzionalità non andranno a buon fine.

La tua app può anche proteggere i propri componenti con le autorizzazioni. Può utilizzare qualsiasi autorizzazione definita da Android, come elencato in android.Manifest.permission, o un'autorizzazione dichiarata in un'altra app. L'app può anche definire le proprie autorizzazioni. Viene dichiarata una nuova autorizzazione con <permission> .

Per ulteriori informazioni, vedi Autorizzazioni su Android.

Compatibilità dei dispositivi

Nel file manifest puoi anche dichiarare quali tipi di hardware o le funzionalità software richieste dalla tua app e, per estensione, i tipi di dispositivi richiesti dall'app con cui è compatibile. Google Play Store non consente agli utenti di installare la tua app su dispositivi che non forniscono le funzionalità o la versione di sistema richieste dalla tua app.

Esistono diversi tag manifest che definiscono i dispositivi con cui la tua app è compatibile. Di seguito sono riportate alcune delle più comuni.

<uses-feature>

L'elemento <uses-feature> ti consente di dichiarare le funzionalità hardware e software di cui ha bisogno la tua app. Ad esempio, se l'app non supporta le funzionalità di base funzionalità su un dispositivo senza sensore per la bussola, puoi dichiarare la bussola sensore come richiesto con il seguente tag manifest:

<manifest ... >
    <uses-feature android:name="android.hardware.sensor.compass"
                  android:required="true" />
    ...
</manifest>

Nota: Se vuoi rendere disponibile la tua app sui Chromebook, esistono alcune importanti limitazioni di funzionalità hardware e software le informazioni da considerare. Per ulteriori informazioni, vedi Compatibilità del file manifest dell'app per Chromebook.

<uses-sdk>

Ogni versione successiva della piattaforma aggiunge spesso nuove API non disponibili nella versione precedente. Indicare la versione minima con cui è installata la tua app. compatibili, il file manifest deve includere il tag <uses-sdk> e le relative minSdkVersion .

Tuttavia, tieni presente che gli attributi nell'elemento <uses-sdk> vengono sostituiti dalle proprietà corrispondenti nel file build.gradle. Pertanto, se utilizzi Android Studio, specifica minSdkVersion e targetSdkVersion valori disponibili:

android {
    defaultConfig {
        applicationId 'com.example.myapp'

        // Defines the minimum API level required to run the app.
        minSdkVersion 21

        // Specifies the API level used to test the app.
        targetSdkVersion 33
        ...
    }
}

android {
    defaultConfig {
        applicationId = "com.example.myapp"

        // Defines the minimum API level required to run the app.
        minSdkVersion(21)

        // Specifies the API level used to test the app.
        targetSdkVersion(33)
        ...
    }
}

Per saperne di più sul file build.gradle, leggi l'articolo su come configurare la build.

Per scoprire di più su come dichiarare il supporto della tua app per dispositivi diversi, consulta la sezione sulla compatibilità Panoramica.

Convenzioni relative ai file

Questa sezione descrive le convenzioni e le regole generalmente applicabili a tutti elementi e attributi nel file manifest.

Elementi

Sono obbligatori solo gli elementi <manifest> e <application>. Ognuno deve verificarsi una sola volta. La maggior parte degli altri elementi può verificarsi zero o più volte. Tuttavia, alcuni di questi elementi devono essere presenti per rendere utile il file manifest.

Tutti i valori vengono impostati tramite attributi, non come dati di carattere all'interno di un elemento.

Gli elementi allo stesso livello generalmente non sono ordinati. Ad esempio, <activity>, <provider> e <service> possono essere posizionati in qualsiasi ordine. Esistono due eccezioni principali: regola:

• Un elemento <activity-alias> deve seguire l'elemento <activity> di cui è un alias.
• L'elemento <application> deve essere l'ultimo elemento all'interno di Elemento <manifest>.

Attributi

Tecnicamente, tutti gli attributi sono facoltativi. Tuttavia, molti attributi deve essere specificato in modo che un elemento possa svolgere il proprio scopo. Per gli attributi effettivamente facoltativi, la documentazione di riferimento indica i valori predefiniti.

Ad eccezione di alcuni attributi dell'elemento <manifest> principale, tutti i nomi degli attributi iniziano con un prefisso android:, ad esempio android:alwaysRetainTaskState. Poiché il prefisso è universale, la documentazione in genere lo omette quando fa riferimento agli attributi per nome.

Più valori

Se è possibile specificare più di un valore, l'elemento è quasi sempre ripetuti, anziché più valori elencati all'interno di un singolo elemento. Ad esempio, un filtro per intent può elencare diverse azioni:

<intent-filter ... >
    <action android:name="android.intent.action.EDIT" />
    <action android:name="android.intent.action.INSERT" />
    <action android:name="android.intent.action.DELETE" />
    ...
</intent-filter>

Valori delle risorse

Alcuni attributi hanno valori che vengono mostrati agli utenti, ad esempio: il titolo di un'attività o l'icona dell'app. Il valore di questi attributi potrebbe essere diverso in base alla lingua dell'utente o ad altre configurazioni del dispositivo (ad esempio per fornire una dimensione dell'icona diversa in base alla densità di pixel del dispositivo), pertanto i valori devono essere impostati da una risorsa o un tema anziché essere hardcoded nel file manifest. Il valore effettivo può quindi variare in base a una alternativa risorse fornite per le diverse configurazioni dei dispositivi.

Le risorse sono espresse come valori con il seguente formato:

"@[package:]type/name"

Puoi omettere il nome package se la risorsa è fornita dal tuo (anche se è fornita da una dipendenza dalla libreria, perché le risorse della libreria sono unito alle tue). L'unico altro nome di pacchetto valido è android, quando vuoi utilizzare una risorsa dell'app Android il modello di machine learning.

type è un tipo di risorsa, ad esempio string o drawable, e name è il nome che identifica la risorsa specifica. Ecco un esempio:

<activity android:icon="@drawable/smallPic" ... >

Per saperne di più su come aggiungere risorse al progetto, consulta la Panoramica delle risorse dell'app.

Per applicare un valore definito in un tema, il primo carattere deve essere ? anziché @:

"?[package:]type/name"

Valori stringa

Quando un valore dell'attributo è una stringa, usa le doppie barre rovesciate. (\\) per caratteri di escape, ad esempio \\n per una nuova riga o \\uxxxx per un carattere Unicode.

Riferimento agli elementi manifest

La tabella seguente fornisce i link ai documenti di riferimento per tutti gli elementi validi nel file AndroidManifest.xml.

Limiti

I seguenti tag presentano un limite al numero di occorrenze in un file manifest:

La lunghezza massima è limitata per i seguenti attributi:

File manifest di esempio

Il codice XML riportato di seguito è un semplice esempio AndroidManifest.xml che dichiara due attività per l'app.

<?xml version="1.0" encoding="utf-8"?>
<manifest
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:versionCode="1"
    android:versionName="1.0">

    <!-- Beware that these values are overridden by the build.gradle file -->
    <uses-sdk android:minSdkVersion="15" android:targetSdkVersion="26" />

    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:label="@string/app_name"
        android:supportsRtl="true"
        android:theme="@style/AppTheme">

        <!-- This name is resolved to com.example.myapp.MainActivity
             based on the namespace property in the build.gradle file -->
        <activity android:name=".MainActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>

        <activity
            android:name=".DisplayMessageActivity"
            android:parentActivityName=".MainActivity" />
    </application>
</manifest>