Scrittura dei plug-in Gradle

Il plug-in Android per Gradle (AGP) è il sistema di compilazione ufficiale per le applicazioni Android. Include il supporto per la compilazione di molti tipi diversi di origini e il loro collegamento in un'applicazione che puoi eseguire su un dispositivo Android fisico o su un emulatore.

AGP contiene punti di estensione per i plug-in per controllare gli input di compilazione ed estenderne la funzionalità tramite nuovi passaggi che possono essere integrati con le attività di compilazione standard. Le versioni precedenti di AGP non avevano API ufficiali chiaramente separate dalle implementazioni interne. A partire dalla versione 7.0, AGP ha un insieme di API ufficiali e stabili su cui puoi fare affidamento.

Ciclo di vita dell'API AGP

AGP segue il ciclo di vita delle funzionalità di Gradle per designare lo stato delle sue API:

Internal: non destinato all'uso pubblico
Incubating: disponibile per l'uso pubblico, ma non è la versione finale, il che significa che potrebbero non essere compatibili con le versioni precedenti nella versione finale
Pubblico: disponibile per l'uso pubblico e stabile
Deprecated: non più supportato e sostituito da nuove API

Norme sul ritiro

AGP è in continua evoluzione con il ritiro delle vecchie API e la loro sostituzione con nuove API stabili e un nuovo linguaggio DSL (Domain Specific Language). Questa evoluzione riguarderà più release di AGP e puoi scoprire di più a riguardo nella sequenza temporale della migrazione dell'API/DSL AGP.

Quando le API AGP vengono ritirate, per questa migrazione o in altro modo, continueranno a essere disponibili nella release principale attuale, ma genereranno avvisi. Le API ritirate verranno rimosse completamente da AGP nella release principale successiva. Ad esempio, se un'API viene ritirata in AGP 7.0, sarà disponibile in quella versione e genererà avvisi. Questa API non sarà più disponibile in AGP 8.0.

Per vedere esempi di nuove API utilizzate nelle personalizzazioni di build comuni, dai un'occhiata alle ricette del plug-in Android per Gradle. Forniscono esempi di personalizzazioni di build comuni. Puoi anche trovare maggiori dettagli sulle nuove API nella nostra documentazione di riferimento.

Nozioni di base sulla build Gradle

Questa guida non tratta l'intero sistema di compilazione Gradle. Tuttavia, copre l'insieme minimo necessario di concetti per aiutarti a eseguire l'integrazione con le nostre API e rimanda alla documentazione principale di Gradle per ulteriori informazioni.

Presupponiamo una conoscenza di base del funzionamento di Gradle, inclusa la configurazione dei progetti, la modifica dei file di build, l'applicazione dei plug-in e l'esecuzione delle attività. Per scoprire le nozioni di base di Gradle rispetto ad AGP, ti consigliamo di consultare Configurare la build. Per scoprire il framework generale per la personalizzazione dei plug-in Gradle, consulta Sviluppare plug-in Gradle personalizzati.

Glossario dei tipi lazy di Gradle

Gradle offre una serie di tipi che si comportano in modo "lazy" o aiutano a rimandare i calcoli complessi o la creazione alle fasi successive della build.Task Questi tipi sono al centro di molte API Gradle e AGP. L'elenco seguente include i tipi principali di Gradle coinvolti nell'esecuzione lazy e i relativi metodi chiave.

Provider<T>

Fornisce un valore di tipo T (dove "T" indica qualsiasi tipo), che può essere letto durante la fase di esecuzione utilizzando get() o trasformato in un nuovo Provider<S> (dove "S" indica un altro tipo) utilizzando i metodi map(), flatMap(), e zip(). Tieni presente che get() non deve mai essere chiamato durante la fase di configurazione.

map(): Accetta una lambda e produce un Provider di tipo S, Provider<S>. L'argomento lambda di map() accetta il valore T e produce il valore S. La lambda non viene eseguita immediatamente; al contrario, la sua esecuzione viene rimandata al momento in cui viene chiamato get() sul Provider<S> risultante, rendendo lazy l'intera catena.
flatMap(): accetta anche una lambda e produce Provider<S>, ma la lambda accetta un valore T e produce Provider<S> (anziché produrre direttamente il valore S). Utilizza flatMap() quando S non può essere determinato in fase di configurazione e puoi ottenere solo Provider<S>. In pratica parlando, se hai utilizzato map() e hai ottenuto un tipo di Provider<Provider<S>> risultato, probabilmente avresti dovuto utilizzare flatMap() invece.
zip(): consente di combinare due istanze Provider per produrre un nuovo Provider, con un valore calcolato utilizzando una funzione che combina i valori delle due istanze Providers di input.

Property<T>

Implementa Provider<T>, quindi fornisce anche un valore di tipo T. A differenza di Provider<T>, che è di sola lettura, puoi anche impostare un valore per il Property<T>. Esistono due modi per farlo:

Imposta direttamente un valore di tipo T quando è disponibile, senza la necessità di calcoli rimandati.
Imposta un altro Provider<T> come origine del valore di Property<T>. In questo caso, il valore T viene materializzato solo quando viene chiamato Property.get().

TaskProvider

Implementa Provider<Task>. Per generare un TaskProvider, utilizza tasks.register() e non tasks.create(), per assicurarti che le attività vengano istanziate solo in modo lazy quando sono necessarie. Puoi utilizzare flatMap() per accedere agli output di un Task prima della creazione di Task, il che può essere utile se vuoi utilizzare gli output come input per altre istanze Task.

I provider e i relativi metodi di trasformazione sono essenziali per configurare gli input e gli output delle attività in modo lazy, ovvero senza la necessità di creare tutte le attività in anticipo e risolvere i valori.

I provider contengono anche informazioni sulle dipendenze delle attività. Quando crei un Provider trasformando l'output di un Task, questo Task diventa una dipendenza implicita del Provider e verrà creato ed eseguito ogni volta che il valore del Provider viene risolto, ad esempio quando un altro Task lo richiede.

Ecco un esempio di registrazione di due attività, GitVersionTask e ManifestProducerTask, rimandando la creazione delle istanze Task fino a quando non sono effettivamente richieste. Il valore di input di ManifestProducerTask è impostato su un Provider ottenuto dall'output di GitVersionTask, quindi ManifestProducerTask dipende implicitamente da GitVersionTask.

// Register a task lazily to get its TaskProvider.
val gitVersionProvider: TaskProvider =
    project.tasks.register("gitVersionProvider", GitVersionTask::class.java) {
        it.gitVersionOutputFile.set(
            File(project.buildDir, "intermediates/gitVersionProvider/output")
        )
    }

...

/**
 * Register another task in the configuration block (also executed lazily,
 * only if the task is required).
 */
val manifestProducer =
    project.tasks.register(variant.name + "ManifestProducer", ManifestProducerTask::class.java) {
        /**
         * Connect this task's input (gitInfoFile) to the output of
         * gitVersionProvider.
         */
        it.gitInfoFile.set(gitVersionProvider.flatMap(GitVersionTask::gitVersionOutputFile))
    }

Queste due attività verranno eseguite solo se richieste esplicitamente. Questo può accadere nell'ambito di una chiamata Gradle, ad esempio se esegui ./gradlew debugManifestProducer o se l'output di ManifestProducerTask è collegato a un'altra attività e il suo valore diventa obbligatorio.

Anche se scriverai attività personalizzate che utilizzano input e/o producono output, AGP non offre l'accesso pubblico diretto alle proprie attività. Sono un dettaglio di implementazione soggetto a modifiche da una versione all'altra. AGP offre invece l'API Variant e l'accesso all'output delle sue attività, o artefatti di build, che puoi leggere e trasformare. Per ulteriori informazioni, consulta API Variant, artefatti e attività in questo documento.

Fasi di build di Gradle

La creazione di un progetto è intrinsecamente un processo complicato e che richiede molte risorse. Esistono varie funzionalità, come l'evitare la configurazione delle attività, i controlli di aggiornamento e la funzionalità di memorizzazione nella cache della configurazione, che contribuiscono a ridurre al minimo il tempo dedicato a calcoli riproducibili o non necessari.

Per applicare alcune di queste ottimizzazioni, gli script e i plug-in Gradle devono rispettare regole rigorose durante ciascuna delle fasi di build Gradle distinte: inizializzazione, configurazione ed esecuzione. In questa guida ci concentreremo sulle fasi di configurazione ed esecuzione. Puoi trovare maggiori informazioni su tutte le fasi nella guida al ciclo di vita della build Gradle.

Fase di configurazione

Durante la fase di configurazione, vengono valutati gli script di build per tutti i progetti che fanno parte della build, vengono applicati i plug-in e vengono risolte le dipendenze di build. Questa fase deve essere utilizzata per configurare la build utilizzando gli oggetti DSL e per registrare le attività e i relativi input in modo lazy.

Poiché la fase di configurazione viene sempre eseguita, indipendentemente dall'attività richiesta, è particolarmente importante mantenerla snella e limitare qualsiasi calcolo in modo che dipenda solo dagli script di build stessi. Ciò significa che non devi eseguire programmi esterni, leggere dalla rete o eseguire calcoli lunghi che possono essere rimandati alla fase di esecuzione come istanze Task appropriate.

Fase di esecuzione

Nella fase di esecuzione, vengono eseguite le attività richieste e le relative attività dipendenti. In particolare, vengono eseguiti i metodi della classe Task contrassegnati con @TaskAction sono eseguiti. Durante l'esecuzione delle attività, puoi leggere gli input (ad esempio i file) e risolvere i provider lazy chiamando Provider<T>.get(). La risoluzione dei provider lazy in questo modo avvia una sequenza di chiamate map() o flatMap() che seguono le informazioni sulle dipendenze delle attività contenute nel provider. Le attività vengono eseguite in modo lazy per materializzare i valori richiesti.

API Variant, artefatti e attività

L'API Variant è un meccanismo di estensione del plug-in Android per Gradle che consente di manipolare le varie opzioni, normalmente impostate utilizzando il DSL nei file di configurazione della build, che influenzano la build Android. L'API Variant ti consente anche di accedere agli artefatti intermedi e finali creati dalla build, come i file di classe, il manifest unito o i file APK/AAB.

Flusso di build Android e punti di estensione

Quando interagisci con AGP, utilizza punti di estensione appositamente creati anziché registrare i callback del ciclo di vita di Gradle tipici (come afterEvaluate()) o configurare dipendenze Task esplicite. Le attività create da AGP sono considerate dettagli di implementazione e non vengono esposte come API pubblica. Devi evitare di provare a ottenere istanze degli oggetti Task o di indovinare i nomi Task e di aggiungere callback o dipendenze direttamente a questi oggetti Task.

AGP completa i seguenti passaggi per creare ed eseguire le istanze Task, che a loro volta producono gli artefatti di build. I passaggi principali coinvolti nella creazione dell'oggetto Variant sono seguiti da callback che consentono di apportare modifiche a determinati oggetti creati nell'ambito di una build. È importante notare che tutti i callback vengono eseguiti durante la fase di configurazione (descritta in questa pagina) e devono essere eseguiti rapidamente, rimandando qualsiasi lavoro complicato alle istanze Task appropriate durante la fase di esecuzione.

Analisi DSL: in questa fase vengono valutati gli script di build e vengono creati e impostati i vari oggetti DSL Android del blocco android. Durante questa fase vengono registrati anche i callback dell'API Variant descritti nelle sezioni seguenti.
finalizeDsl(): callback che consente di modificare gli oggetti DSL prima che vengano bloccati per la creazione dei componenti (varianti). Gli oggetti VariantBuilder vengono creati in base ai dati contenuti negli oggetti DSL.
Blocco DSL: il DSL è ora bloccato e non è più possibile apportare modifiche.
beforeVariants(): questo callback può influenzare i componenti creati, e alcune delle loro proprietà tramite VariantBuilder. Consente comunque di modificare il flusso di build e gli artefatti prodotti.
Creazione di varianti: l'elenco dei componenti e degli artefatti che verranno creati è ora finalizzato e non può essere modificato.
onVariants(): In questo callback, puoi accedere agli oggetti Variant creati e impostare valori o provider per i valori Property che contengono, da calcolare in modo lazy.
Blocco delle varianti: gli oggetti Variant sono ora bloccati e non è più possibile apportare modifiche.
Attività create: gli oggetti Variant e i relativi valori Property vengono utilizzati per creare le istanze Task necessarie per eseguire la build.

AGP introduce un AndroidComponentsExtension che consente di registrare i callback per finalizeDsl(), beforeVariants() e onVariants(). L'estensione è disponibile negli script di build tramite il blocco androidComponents:

// This is used only for configuring the Android build through DSL.
android { ... }

// The androidComponents block is separate from the DSL.
androidComponents {
   finalizeDsl { extension ->
      ...
   }
}

Tuttavia, ti consigliamo di utilizzare gli script di build solo per la configurativa dichiarativa utilizzando il DSL del blocco Android e di spostare qualsiasi logica imperativa personalizzata in buildSrc o in plug-in esterni. Puoi anche consultare gli buildSrc esempi nel nostro repository GitHub delle ricette Gradle per scoprire come creare un plug-in nel tuo progetto. Ecco un esempio di registrazione dei callback dal codice del plug-in:

abstract class ExamplePlugin: Plugin<Project> {

    override fun apply(project: Project) {
        val androidComponents = project.extensions.getByType(AndroidComponentsExtension::class.java)
        androidComponents.finalizeDsl { extension ->
            ...
        }
    }
}

Analizziamo più da vicino i callback disponibili e il tipo di casi d'uso che il tuo plug-in può supportare in ciascuno di essi:

`finalizeDsl(callback: (DslExtensionT) -> Unit)`

In questo callback, puoi accedere e modificare gli oggetti DSL creati analizzando le informazioni del blocco android nei file di build. Questi oggetti DSL verranno utilizzati per inizializzare e configurare le varianti nelle fasi successive della build. Ad esempio, puoi creare nuove configurazioni o sostituire le proprietà a livello di programmazione, ma tieni presente che tutti i valori devono essere risolti in fase di configurazione, quindi non devono dipendere da input esterni. Al termine dell'esecuzione di questo callback, gli oggetti DSL non sono più utili e non devi più conservare riferimenti a essi o modificarne i valori.

abstract class ExamplePlugin: Plugin<Project> {

    override fun apply(project: Project) {
        val androidComponents = project.extensions.getByType(AndroidComponentsExtension::class.java)
        androidComponents.finalizeDsl { extension ->
            extension.buildTypes.create("extra").let {
                it.isJniDebuggable = true
            }
        }
    }
}

`beforeVariants()`

In questa fase della build, puoi accedere agli oggetti VariantBuilder, che determinano le varianti che verranno create e le relative proprietà. Ad esempio, puoi disattivare a livello di programmazione determinate varianti, i relativi test o modificare il valore di una proprietà (ad esempio, minSdk) solo per una variante scelta. Analogamente a finalizeDsl(), tutti i valori che fornisci devono essere risolti in fase di configurazione e non devono dipendere da input esterni. Gli oggetti VariantBuilder non devono essere modificati al termine dell'esecuzione del callback beforeVariants().

androidComponents {
    beforeVariants { variantBuilder ->
        variantBuilder.minSdk = 23
    }
}

Il callback beforeVariants() accetta facoltativamente un VariantSelector, che puoi ottenere tramite il metodo selector() di androidComponentsExtension. Puoi utilizzarlo per filtrare i componenti che partecipano alla chiamata di callback in base al nome, al tipo di compilazione o alla versione prodotto.

androidComponents {
    beforeVariants(selector().withName("adfree")) { variantBuilder ->
        variantBuilder.minSdk = 23
    }
}

`onVariants()`

Quando viene chiamato onVariants(), tutti gli artefatti che verranno creati da AGP sono già stati decisi, quindi non puoi più disattivarli. Tuttavia, puoi modificare alcuni dei valori utilizzati per le attività impostandoli per gli attributi Property negli oggetti Variant. Poiché i valori Property verranno risolti solo quando vengono eseguite le attività di AGP, puoi collegarli in modo sicuro ai provider delle tue attività personalizzate che eseguiranno tutti i calcoli necessari, inclusa la lettura da input esterni come file o la rete.

// onVariants also supports VariantSelectors:
onVariants(selector().withBuildType("release")) { variant ->
    // Gather the output when we are in single mode (no multi-apk).
    val mainOutput = variant.outputs.single { it.outputType == OutputType.SINGLE }

    // Create version code generating task
    val versionCodeTask = project.tasks.register("computeVersionCodeFor${variant.name}", VersionCodeTask::class.java) {
        it.outputFile.set(project.layout.buildDirectory.file("${variant.name}/versionCode.txt"))
    }
    /**
     * Wire version code from the task output.
     * map() will create a lazy provider that:
     * 1. Runs just before the consumer(s), ensuring that the producer
     * (VersionCodeTask) has run and therefore the file is created.
     * 2. Contains task dependency information so that the consumer(s) run after
     * the producer.
     */
    mainOutput.versionCode.set(versionCodeTask.map { it.outputFile.get().asFile.readText().toInt() })
}

Contribuire le origini generate alla build

Il tuo plug-in può contribuire con alcuni tipi di origini generate, ad esempio:

Codice dell'applicazione nella directory java
Risorse Android nella res directory
Risorse Java nella directory resources
Asset Android nella directory assets

Per l'elenco completo delle origini che puoi aggiungere, consulta le API Sources.

Questo snippet di codice mostra come aggiungere una cartella di origine personalizzata denominata ${variant.name} al set di risorse Java utilizzando la funzione addStaticSourceDirectory(). La toolchain Android elabora quindi questa cartella.

onVariants { variant ->
    variant.sources.java?.let { java ->
        java.addStaticSourceDirectory("custom/src/kotlin/${variant.name}")
    }
}

Per maggiori dettagli, consulta la ricetta addJavaSource.

Questo snippet di codice mostra come aggiungere una directory con le risorse Android generate da un'attività personalizzata al set di risorse res. La procedura è simile per altri tipi di origine.

onVariants(selector().withBuildType("release")) { variant ->
    // Step 1. Register the task.
    val resCreationTask =
       project.tasks.register<ResCreatorTask>("create${variant.name}Res")

    // Step 2. Register the task output to the variant-generated source directory.
    variant.sources.res?.addGeneratedSourceDirectory(
       resCreationTask,
       ResCreatorTask::outputDirectory)
    }

...

// Step 3. Define the task.
abstract class ResCreatorTask: DefaultTask() {
   @get:OutputFiles
   abstract val outputDirectory: DirectoryProperty

   @TaskAction
   fun taskAction() {
      // Step 4. Generate your resources.
      ...
   }
}

Per maggiori dettagli, consulta la ricetta addCustomAsset.

Accedere e modificare gli artefatti

Oltre a consentirti di modificare le proprietà semplici degli oggetti Variant, AGP contiene anche un meccanismo di estensione che ti consente di leggere o trasformare gli artefatti intermedi e finali prodotti durante la build. Ad esempio, puoi leggere i contenuti del file AndroidManifest.xml unito finale in un Task personalizzato per analizzarlo oppure puoi sostituirne completamente i contenuti con quelli di un file manifest generato dal tuo Task personalizzato.

Puoi trovare l'elenco degli artefatti attualmente supportati nella documentazione di riferimento per la Artifact classe. Ogni tipo di artefatto ha determinate proprietà utili da conoscere:

Cardinality

La cardinalità di un Artifact rappresenta il numero di istanze FileSystemLocation o il numero di file o directory del tipo di artefatto. Puoi ottenere informazioni sulla cardinalità di un artefatto controllando la relativa classe padre: gli artefatti con un singolo FileSystemLocation saranno una sottoclasse di Artifact.Single; gli artefatti con più istanze FileSystemLocation saranno una sottoclasse di Artifact.Multiple.

Tipo `FileSystemLocation`

Puoi verificare se un Artifact rappresenta file o directory esaminando il relativo tipo con parametri FileSystemLocation, che può essere RegularFile o Directory.

Operazioni supportate

Ogni classe Artifact può implementare una delle seguenti interfacce per indicare le operazioni che supporta:

Transformable: consente di utilizzare un Artifact come input per un Task che esegue trasformazioni arbitrarie e restituisce una nuova versione di Artifact.
Appendable: si applica solo agli artefatti che sono sottoclassi di Artifact.Multiple. Significa che l'Artifact può essere aggiunto, ovvero un Task personalizzato può creare nuove istanze di questo tipo Artifact che verranno aggiunte all'elenco esistente.
Replaceable: si applica solo agli artefatti che sono sottoclassi di Artifact.Single. Un Artifact sostituibile può essere sostituito da un'istanza completamente nuova, prodotta come output di un Task.

Oltre alle tre operazioni di modifica degli artefatti, ogni artefatto supporta un'operazione get() (o getAll()) che restituisce un Provider con la versione finale dell'artefatto (al termine di tutte le operazioni).

Più plug-in possono aggiungere un numero qualsiasi di operazioni sugli artefatti nella pipeline dal callback onVariants() e AGP garantirà che siano concatenati correttamente in modo che tutte le attività vengano eseguite al momento giusto e che gli artefatti vengano prodotti e aggiornati correttamente. Ciò significa che quando un'operazione modifica gli output aggiungendoli, sostituendoli o trasformandoli, l'operazione successiva vedrà la versione aggiornata di questi artefatti come input e così via.

L'entry point per la registrazione delle operazioni è la classe Artifacts. Lo snippet di codice seguente mostra come accedere a un'istanza di Artifacts da una proprietà dell'oggetto Variant nel onVariants() callback.

Puoi quindi passare il tuo TaskProvider personalizzato per ottenere un TaskBasedOperation oggetto (1) e utilizzarlo per collegare i relativi input e output utilizzando uno dei wiredWith* metodi (2).

Il metodo esatto da scegliere dipende dalla cardinalità e dal tipo FileSystemLocation implementato da Artifact che vuoi trasformare.

Infine, passi il tipo Artifact a un metodo che rappresenta l'operazione scelta sull'oggetto *OperationRequest che ricevi in cambio, ad esempio, toAppendTo(), toTransform() o toCreate() (3).

androidComponents.onVariants { variant ->
    val manifestUpdater = // Custom task that will be used for the transform.
            project.tasks.register(variant.name + "ManifestUpdater", ManifestTransformerTask::class.java) {
                it.gitInfoFile.set(gitVersionProvider.flatMap(GitVersionTask::gitVersionOutputFile))
            }
    // (1) Register the TaskProvider w.
    val variant.artifacts.use(manifestUpdater)
         // (2) Connect the input and output files.
        .wiredWithFiles(
            ManifestTransformerTask::mergedManifest,
            ManifestTransformerTask::updatedManifest)
        // (3) Indicate the artifact and operation type.
        .toTransform(SingleArtifact.MERGED_MANIFEST)
}

In questo esempio, MERGED_MANIFEST è un SingleArtifact ed è un RegularFile. Per questo motivo, dobbiamo utilizzare il metodo wiredWithFiles, che accetta un singolo riferimento RegularFileProperty per l'input e un singolo RegularFileProperty per l'output. Esistono altri metodi wiredWith* nella classe TaskBasedOperation che funzionano per altre combinazioni di cardinalità Artifact e tipi FileSystemLocation.

Per scoprire di più sull'estensione di AGP, ti consigliamo di leggere le seguenti sezioni del manuale del sistema di compilazione Gradle: