Configura la pubblicazione on demand

I moduli delle funzionalità ti consentono di separare determinate funzionalità e risorse dal modulo di base della tua app e di includerle nell'app bundle. Tramite la funzionalità Play Feature Delivery, gli utenti possono, ad esempio, scaricare e installare in un secondo momento questi componenti on demand dopo aver già installato l'APK di base della tua app.

Ad esempio, prendiamo in considerazione un'app di messaggistica che include funzionalità per acquisire e inviare messaggi con immagini, ma solo una piccola percentuale di utenti invia messaggi con immagini. Potrebbe essere opportuno includere la messaggistica con immagini come modulo di funzionalità scaricabile. In questo modo, il download iniziale dell'app è più piccolo per tutti gli utenti e solo gli utenti che inviano messaggi con immagini devono scaricare questo componente aggiuntivo.

Tieni presente che questo tipo di modularizzazione richiede un maggiore impegno e, eventualmente, il refactoring del codice esistente dell'app, quindi valuta attentamente quali funzionalità dell'app trarrebbero il massimo vantaggio dall'essere disponibili per gli utenti su richiesta. Per comprendere meglio i casi d'uso e le linee guida ottimali per le funzionalità on demand, consulta le best practice per l'esperienza utente per la pubblicazione on demand.

Se vuoi modulare gradualmente le funzionalità dell'app nel tempo, senza attivare opzioni di pubblicazione avanzate, come la pubblicazione on demand, configura la pubblicazione al momento dell'installazione.

Questa pagina ti aiuta ad aggiungere un modulo delle funzionalità al progetto dell'app e a configurarlo per il caricamento on demand. Prima di iniziare, assicurati di utilizzare Android Studio 3.5 o versioni successive e il plug-in Android per Gradle 3.5.0 o versioni successive.

Configurare un nuovo modulo per la pubblicazione on demand

Il modo più semplice per creare un nuovo modulo delle funzionalità è utilizzare Android Studio 3.5 o versioni successive. Poiché i moduli delle funzionalità hanno una dipendenza intrinseca dal modulo dell'app di base, puoi aggiungerli solo ai progetti di app esistenti.

Per aggiungere un modulo di funzionalità al progetto dell'app utilizzando Android Studio, procedo come segue:

1. Se non l'hai già fatto, apri il progetto dell'app nell'IDE.
2. Seleziona File > Nuovo > Nuovo modulo dalla barra dei menu.
3. Nella finestra di dialogo Crea nuovo modulo, seleziona Modulo di funzionalità dinamiche e fai clic su Avanti.
4. Nella sezione Configura il nuovo modulo, completa quanto segue:
   1. Seleziona il modulo dell'applicazione di base per il progetto dell'app dal menu a discesa.
   2. Specifica un nome del modulo. L'IDE utilizza questo nome per identificare il modulo come sottoprogetto Gradle nel file delle impostazioni di Gradle. Quando compilatione il bundle dell'app, Gradle utilizza l'ultimo elemento del nome del progetto secondario per iniettare l'attributo <manifest split> nel manifest del modulo della funzionalità.
   3. Specifica il nome del pacchetto del modulo. Per impostazione predefinita, Android Studio suggerisce un nome del pacchetto che combina il nome del pacchetto principale del modulo di base e il nome del modulo specificato nel passaggio precedente.
   4. Seleziona il livello API minimo che vuoi che il modulo supporti. Questo valore deve corrispondere a quello del modulo di base.
5. Fai clic su Avanti.

6. Nella sezione Opzioni di download dei moduli, svolgi i seguenti passaggi:

   1. Specifica il Titolo del modulo utilizzando fino a 50 caratteri. La piattaforma utilizza questo titolo per identificare il modulo agli utenti quando, ad esempio, viene chiesto all'utente se vuole scaricarlo. Per questo motivo, il modulo di base dell'app deve includere il titolo del modulo come risorsa stringa, che puoi tradurre. Quando crei il modulo utilizzando Android Studio, l'IDE aggiunge la risorsa stringa al modulo di base e inserisce la seguente voce nel file manifest del modulo di funzionalità:

      <dist:module
          ...
          dist:title="@string/feature_title">
      </dist:module>
      

   2. Nel menu a discesa Inclusione al momento dell'installazione, seleziona Non includere il modulo al momento dell'installazione. Android Studio inserisce quanto segue nel file manifest del modulo per riflettere la tua scelta:

      <dist:module ... >
        <dist:delivery>
            <dist:on-demand/>
        </dist:delivery>
      </dist:module>
      

   3. Seleziona la casella accanto a Fusing se vuoi che questo modulo sia disponibile per i dispositivi con Android 4.4 (livello API 20) e versioni precedenti e incluso negli APK multipli. Ciò significa che puoi attivare il comportamento on demand per questo modulo e disattivare l'unione per ometterlo dai dispositivi che non supportano il download e l'installazione di APK suddivisi. Android Studio inserisce quanto segue nel file manifest del modulo per riflettere la tua scelta:

      <dist:module ...>
          <dist:fusing dist:include="true | false" />
      </dist:module>
      

7. Fai clic su Fine.

Una volta che Android Studio ha completato la creazione del modulo, controllane i contenuti personalmente dal riquadro Project (seleziona View > Tool Windows > Project dalla barra dei menu). Il codice, le risorse e l'organizzazione predefiniti devono essere simili a quelli del modulo dell'app standard.

Successivamente, dovrai implementare la funzionalità di installazione on demand utilizzando la libreria Play Feature Delivery.

Includi la libreria Play Feature Delivery nel tuo progetto

Prima di iniziare, devi aggiungere la libreria Play Feature Delivery al tuo progetto.

Richiedere un modulo on demand

Quando la tua app deve utilizzare un modulo di funzionalità, può richiederne uno mentre è in primo piano tramite la classe SplitInstallManager. Quando effettua una richiesta, l'app deve specificare il nome del modulo come definito dall'elemento split nel file manifest del modulo di destinazione. Quando crei un modulo di funzionalità utilizzando Android Studio, il sistema di compilazione utilizza il nome del modulo fornito per iniettare questa proprietà nel manifest del modulo in fase di compilazione. Per ulteriori informazioni, consulta la documentazione relativa ai manifest dei moduli di funzionalità.

Ad esempio, prendi in considerazione un'app con un modulo on demand per acquisire e inviare messaggi con foto utilizzando la fotocamera del dispositivo e questo modulo on demand specifica split="pictureMessages" nel file manifest. Il seguente esempio utilizza SplitInstallManager per richiedere il modulo pictureMessages (insieme a un modulo aggiuntivo per alcuni filtri promozionali):

// Creates an instance of SplitInstallManager.
val splitInstallManager = SplitInstallManagerFactory.create(context)

// Creates a request to install a module.
val request =
    SplitInstallRequest
        .newBuilder()
        // You can download multiple on demand modules per
        // request by invoking the following method for each
        // module you want to install.
        .addModule("pictureMessages")
        .addModule("promotionalFilters")
        .build()

splitInstallManager
    // Submits the request to install the module through the
    // asynchronous startInstall() task. Your app needs to be
    // in the foreground to submit the request.
    .startInstall(request)
    // You should also be able to gracefully handle
    // request state changes and errors. To learn more, go to
    // the section about how to Monitor the request state.
    .addOnSuccessListener { sessionId -> ... }
    .addOnFailureListener { exception ->  ... }

// Creates an instance of SplitInstallManager.
SplitInstallManager splitInstallManager =
    SplitInstallManagerFactory.create(context);

// Creates a request to install a module.
SplitInstallRequest request =
    SplitInstallRequest
        .newBuilder()
        // You can download multiple on demand modules per
        // request by invoking the following method for each
        // module you want to install.
        .addModule("pictureMessages")
        .addModule("promotionalFilters")
        .build();

splitInstallManager
    // Submits the request to install the module through the
    // asynchronous startInstall() task. Your app needs to be
    // in the foreground to submit the request.
    .startInstall(request)
    // You should also be able to gracefully handle
    // request state changes and errors. To learn more, go to
    // the section about how to Monitor the request state.
    .addOnSuccessListener(sessionId -> { ... })
    .addOnFailureListener(exception -> { ... });

Quando la tua app richiede un modulo on demand, la libreria Play Feature Delivery utilizza una strategia "spara e dimentica". In altre parole, invia la richiesta di download del modulo alla piattaforma, ma non controlla se l'installazione è andata a buon fine. Per far avanzare il percorso dell'utente dopo l'installazione o gestire gli errori in modo corretto, assicurati di monitorare lo stato della richiesta.

Nota:è possibile richiedere un modulo di funzionalità già installato sul dispositivo. L'API considera immediatamente la richiesta completata se rileva che il modulo è già installato. Inoltre, dopo l'installazione, Google Play mantiene aggiornato il modulo automaticamente. In altre parole, quando carichi una nuova versione dell'app bundle, la piattaforma aggiorna tutti gli APK installati che appartengono alla tua app. Per saperne di più, leggi Gestire gli aggiornamenti delle app.

Per avere accesso al codice e alle risorse del modulo, la tua app deve attivare SplitCompat. Tieni presente che SplitCompat non è obbligatorio per le app istantanee Android.

Posticipare l'installazione dei moduli on demand

Se non è necessario che l'app scarichi e installi immediatamente un modulo on demand, puoi posticipare l'installazione quando l'app è in background. Ad esempio, se vuoi precaricare del materiale promozionale per un lancio successivo della tua app.

Puoi specificare un modulo da scaricare in un secondo momento utilizzando il metodo deferredInstall(), come mostrato di seguito. Inoltre, diversamente da SplitInstallManager.startInstall(), la tua app non deve essere in primo piano per avviare una richiesta di installazione differita.

// Requests an on demand module to be downloaded when the app enters
// the background. You can specify more than one module at a time.
splitInstallManager.deferredInstall(listOf("promotionalFilters"))

// Requests an on demand module to be downloaded when the app enters
// the background. You can specify more than one module at a time.
splitInstallManager.deferredInstall(Arrays.asList("promotionalFilters"));

Le richieste di installazioni differite sono secondo il criterio del "best effort" e non puoi monitorarne lo stato. Pertanto, prima di provare ad accedere a un modulo specificato per l'installazione differita, devi verificare che il modulo sia stato installato. Se invece hai bisogno che il modulo sia disponibile immediatamente, utilizza SplitInstallManager.startInstall() per richiederlo, come mostrato nella sezione precedente.

Monitora lo stato della richiesta

Per poter aggiornare una barra di avanzamento, attivare un'intent dopo l'installazione o gestire in modo corretto un errore di richiesta, devi ascoltare gli aggiornamenti dello stato dall'attività SplitInstallManager.startInstall() asincrona. Prima di poter iniziare a ricevere aggiornamenti per la richiesta di installazione, registra un ascoltatore e ottieni l'ID sessione per la richiesta, come mostrato di seguito.

// Initializes a variable to later track the session ID for a given request.
var mySessionId = 0

// Creates a listener for request status updates.
val listener = SplitInstallStateUpdatedListener { state ->
    if (state.sessionId() == mySessionId) {
      // Read the status of the request to handle the state update.
    }
}

// Registers the listener.
splitInstallManager.registerListener(listener)

...

splitInstallManager
    .startInstall(request)
    // When the platform accepts your request to download
    // an on demand module, it binds it to the following session ID.
    // You use this ID to track further status updates for the request.
    .addOnSuccessListener { sessionId -> mySessionId = sessionId }
    // You should also add the following listener to handle any errors
    // processing the request.
    .addOnFailureListener { exception ->
        // Handle request errors.
    }

// When your app no longer requires further updates, unregister the listener.
splitInstallManager.unregisterListener(listener)

// Initializes a variable to later track the session ID for a given request.
int mySessionId = 0;

// Creates a listener for request status updates.
SplitInstallStateUpdatedListener listener = state -> {
    if (state.sessionId() == mySessionId) {
      // Read the status of the request to handle the state update.
    }
};

// Registers the listener.
splitInstallManager.registerListener(listener);

...

splitInstallManager
    .startInstall(request)
    // When the platform accepts your request to download
    // an on demand module, it binds it to the following session ID.
    // You use this ID to track further status updates for the request.
    .addOnSuccessListener(sessionId -> { mySessionId = sessionId; })
    // You should also add the following listener to handle any errors
    // processing the request.
    .addOnFailureListener(exception -> {
        // Handle request errors.
    });

// When your app no longer requires further updates, unregister the listener.
splitInstallManager.unregisterListener(listener);

Gestire gli errori di richiesta

Tieni presente che l'installazione on demand dei moduli di funzionalità a volte può non riuscire, proprio come l'installazione dell'app non sempre va a buon fine. L'errore di installazione può essere dovuto a problemi come spazio di archiviazione del dispositivo insufficiente, assenza di connettività di rete o mancata autenticazione dell'utente al Google Play Store. Per suggerimenti su come gestire queste situazioni in modo elegante dal punto di vista dell'utente, consulta le nostre linee guida sull'esperienza utente per la pubblicazione on demand.

A livello di codice, devi gestire gli errori di download o installazione di un modulo utilizzando addOnFailureListener(), come mostrato di seguito:

splitInstallManager
    .startInstall(request)
    .addOnFailureListener { exception ->
        when ((exception as SplitInstallException).errorCode) {
            SplitInstallErrorCode.NETWORK_ERROR -> {
                // Display a message that requests the user to establish a
                // network connection.
            }
            SplitInstallErrorCode.ACTIVE_SESSIONS_LIMIT_EXCEEDED -> checkForActiveDownloads()
            ...
        }
    }

fun checkForActiveDownloads() {
    splitInstallManager
        // Returns a SplitInstallSessionState object for each active session as a List.
        .sessionStates
        .addOnCompleteListener { task ->
            if (task.isSuccessful) {
                // Check for active sessions.
                for (state in task.result) {
                    if (state.status() == SplitInstallSessionStatus.DOWNLOADING) {
                        // Cancel the request, or request a deferred installation.
                    }
                }
            }
        }
}

splitInstallManager
    .startInstall(request)
    .addOnFailureListener(exception -> {
        switch (((SplitInstallException) exception).getErrorCode()) {
            case SplitInstallErrorCode.NETWORK_ERROR:
                // Display a message that requests the user to establish a
                // network connection.
                break;
            case SplitInstallErrorCode.ACTIVE_SESSIONS_LIMIT_EXCEEDED:
                checkForActiveDownloads();
            ...
    });

void checkForActiveDownloads() {
    splitInstallManager
        // Returns a SplitInstallSessionState object for each active session as a List.
        .getSessionStates()
        .addOnCompleteListener( task -> {
            if (task.isSuccessful()) {
                // Check for active sessions.
                for (SplitInstallSessionState state : task.getResult()) {
                    if (state.status() == SplitInstallSessionStatus.DOWNLOADING) {
                        // Cancel the request, or request a deferred installation.
                    }
                }
            }
        });
}

La tabella seguente descrive gli stati di errore che la tua app potrebbe dover gestire:

Se un utente richiede il download di un modulo on demand e si verifica un errore, valuta la possibilità di mostrare una finestra di dialogo che offra due opzioni: Riprova (che tenta di nuovo la richiesta) e Annulla (che abbandona la richiesta). Per ulteriore assistenza, devi anche fornire un link Guida che indirizzi gli utenti al Centro assistenza Google Play.

Gestire gli aggiornamenti dello stato

Dopo aver registrato un ascoltatore e registrato l'ID sessione per la richiesta, utilizza StateUpdatedListener.onStateUpdate() per gestire le modifiche dello stato, come mostrato di seguito.

override fun onStateUpdate(state : SplitInstallSessionState) {
    if (state.status() == SplitInstallSessionStatus.FAILED
        && state.errorCode() == SplitInstallErrorCode.SERVICE_DIED) {
       // Retry the request.
       return
    }
    if (state.sessionId() == mySessionId) {
        when (state.status()) {
            SplitInstallSessionStatus.DOWNLOADING -> {
              val totalBytes = state.totalBytesToDownload()
              val progress = state.bytesDownloaded()
              // Update progress bar.
            }
            SplitInstallSessionStatus.INSTALLED -> {

              // After a module is installed, you can start accessing its content or
              // fire an intent to start an activity in the installed module.
              // For other use cases, see access code and resources from installed modules.

              // If the request is an on demand module for an Android Instant App
              // running on Android 8.0 (API level 26) or higher, you need to
              // update the app context using the SplitInstallHelper API.
            }
        }
    }
}

@Override
public void onStateUpdate(SplitInstallSessionState state) {
    if (state.status() == SplitInstallSessionStatus.FAILED
        && state.errorCode() == SplitInstallErrorCode.SERVICE_DIES) {
       // Retry the request.
       return;
    }
    if (state.sessionId() == mySessionId) {
        switch (state.status()) {
            case SplitInstallSessionStatus.DOWNLOADING:
              int totalBytes = state.totalBytesToDownload();
              int progress = state.bytesDownloaded();
              // Update progress bar.
              break;

            case SplitInstallSessionStatus.INSTALLED:

              // After a module is installed, you can start accessing its content or
              // fire an intent to start an activity in the installed module.
              // For other use cases, see access code and resources from installed modules.

              // If the request is an on demand module for an Android Instant App
              // running on Android 8.0 (API level 26) or higher, you need to
              // update the app context using the SplitInstallHelper API.
        }
    }
}

I possibili stati della richiesta di installazione sono descritti nella tabella seguente.

Ottenere la conferma dell'utente

In alcuni casi, Google Play potrebbe richiedere la conferma dell'utente prima di soddisfare una richiesta di download. Ad esempio, se la tua app non è stata installata da Google Play o se stai tentando di scaricare un file di grandi dimensioni tramite dati mobili. In questi casi, lo stato della richiesta indica REQUIRES_USER_CONFIRMATION e la tua app deve ottenere la conferma dell'utente prima che il dispositivo possa scaricare e installare i moduli nella richiesta. Per ottenere la conferma, la tua app deve chiedere all'utente quanto segue:

override fun onSessionStateUpdate(state: SplitInstallSessionState) {
    if (state.status() == SplitInstallSessionStatus.REQUIRES_USER_CONFIRMATION) {
        // Displays a confirmation for the user to confirm the request.
        splitInstallManager.startConfirmationDialogForResult(
          state,
          // an activity result launcher registered via registerForActivityResult
          activityResultLauncher)
    }
    ...
 }

@Override void onSessionStateUpdate(SplitInstallSessionState state) {
    if (state.status() == SplitInstallSessionStatus.REQUIRES_USER_CONFIRMATION) {
        // Displays a confirmation for the user to confirm the request.
        splitInstallManager.startConfirmationDialogForResult(
          state,
          // an activity result launcher registered via registerForActivityResult
          activityResultLauncher);
    }
    ...
 }

Puoi registrare un comando di avvio dei risultati dell'attività utilizzando il contratto predefinito ActivityResultContracts.StartIntentSenderForResult. Consulta le API Result Activity.

Lo stato della richiesta viene aggiornato in base alla risposta dell'utente:

• Se l'utente accetta la conferma, lo stato della richiesta diventaPENDING e il download procede.
• Se l'utente nega la conferma, lo stato della richiesta diventaCANCELED.
• Se l'utente non effettua una selezione prima dell'eliminazione della finestra di dialogo, lo stato della richiesta rimane REQUIRES_USER_CONFIRMATION. L'app può chiedere di nuovo all'utente di completare la richiesta.

Per ricevere un callback con la risposta dell'utente, puoi eseguire l'override di ActivityResultCallback come mostrato di seguito.

registerForActivityResult(StartIntentSenderForResult()) { result: ActivityResult -> {
        // Handle the user's decision. For example, if the user selects "Cancel",
        // you may want to disable certain functionality that depends on the module.
    }
}

registerForActivityResult(
    new ActivityResultContracts.StartIntentSenderForResult(),
    new ActivityResultCallback<ActivityResult>() {
        @Override
        public void onActivityResult(ActivityResult result) {
            // Handle the user's decision. For example, if the user selects "Cancel",
            // you may want to disable certain functionality that depends on the module.
        }
    });

Annullare una richiesta di installazione

Se la tua app deve annullare una richiesta prima che venga installata, può invocare il metodo cancelInstall() utilizzando l'ID sessione della richiesta, come mostrato di seguito.

splitInstallManager
    // Cancels the request for the given session ID.
    .cancelInstall(mySessionId)

splitInstallManager
    // Cancels the request for the given session ID.
    .cancelInstall(mySessionId);

Accedere ai moduli

Per accedere al codice e alle risorse di un modulo scaricato dopo il download, la tua app deve attivare la libreria SplitCompat sia per l'app sia per ogni attività nei moduli delle funzionalità scaricati dall'app.

Tieni presente, tuttavia, che la piattaforma presenta le seguenti limitazioni all'accesso ai contenuti di un modulo per un determinato periodo di tempo (in alcuni casi, alcuni giorni) dopo il download del modulo:

• La piattaforma non può applicare nuove voci manifest introdotte dal modulo.
• La piattaforma non può accedere alle risorse del modulo per i componenti dell'interfaccia utente di sistema, come le notifiche. Se devi utilizzare immediatamente queste risorse, valuta la possibilità di includerle nel modulo di base della tua app.

Attiva SplitCompat

Affinché la tua app possa accedere al codice e alle risorse di un modulo scaricato, devi attivare SplitCompat utilizzando solo uno dei metodi descritti nelle sezioni seguenti.

Dopo aver attivato SplitCompat per la tua app, devi anche attivare SplitCompat per ogni attività nei moduli di funzionalità a cui vuoi che la tua app abbia accesso.

Dichiara SplitCompatApplication nel file manifest

Il modo più semplice per attivare SplitCompat è dichiarare SplitCompatApplication come sottoclasse di Application nel manifest della tua app, come mostrato di seguito:

<application
    ...
    android:name="com.google.android.play.core.splitcompat.SplitCompatApplication">
</application>

Dopo aver installato l'app su un dispositivo, puoi accedere automaticamente al codice e alle risorse dei moduli di funzionalità scaricati.

Richiama SplitCompat in fase di esecuzione

Puoi anche attivare SplitCompat in attività o servizi specifici in fase di esecuzione. L'attivazione di SplitCompat in questo modo è necessaria per lanciare le attività incluse nei moduli di funzionalità. Per farlo, sostituisci attachBaseContext come mostrato di seguito.

Se hai una classe Application personalizzata, fai in modo che estenda SplitCompatApplication per attivare SplitCompat per la tua app, come mostrato di seguito:

class MyApplication : SplitCompatApplication() {
    ...
}

public class MyApplication extends SplitCompatApplication {
    ...
}

SplitCompatApplication sostituisce semplicemente ContextWrapper.attachBaseContext() per includere SplitCompat.install(Context applicationContext). Se non vuoi che la tua classe Application espanda SplitCompatApplication, puoi sostituire manualmente il metodo attachBaseContext() come segue:

override fun attachBaseContext(base: Context) {
    super.attachBaseContext(base)
    // Emulates installation of future on demand modules using SplitCompat.
    SplitCompat.install(this)
}

@Override
protected void attachBaseContext(Context base) {
    super.attachBaseContext(base);
    // Emulates installation of future on demand modules using SplitCompat.
    SplitCompat.install(this);
}

Se il tuo modulo on demand è compatibile sia con le app istantanee sia con le app installate, puoi richiamare SplitCompat in modo condizionale, come segue:

override fun attachBaseContext(base: Context) {
    super.attachBaseContext(base)
    if (!InstantApps.isInstantApp(this)) {
        SplitCompat.install(this)
    }
}

@Override
protected void attachBaseContext(Context base) {
    super.attachBaseContext(base);
    if (!InstantApps.isInstantApp(this)) {
        SplitCompat.install(this);
    }
}

Attivare SplitCompat per le attività del modulo

Dopo aver attivato SplitCompat per l'app di base, devi attivarlo per ogni attività scaricata dall'app in un modulo di funzionalità. Per farlo, utilizza il metodo SplitCompat.installActivity(), come segue:

override fun attachBaseContext(base: Context) {
    super.attachBaseContext(base)
    // Emulates installation of on demand modules using SplitCompat.
    SplitCompat.installActivity(this)
}

@Override
protected void attachBaseContext(Context base) {
    super.attachBaseContext(base);
    // Emulates installation of on demand modules using SplitCompat.
    SplitCompat.installActivity(this);
}

Accedi ai componenti definiti nei moduli delle funzionalità

Avviare un'attività definita in un modulo di funzionalità

Puoi avviare le attività definite nei moduli delle funzionalità utilizzando startActivity() dopo aver attivato SplitCompat.

startActivity(Intent()
  .setClassName("com.package", "com.package.module.MyActivity")
  .setFlags(...))

startActivity(new Intent()
  .setClassName("com.package", "com.package.module.MyActivity")
  .setFlags(...));

Il primo parametro di setClassName è il nome del pacchetto dell'app e il secondo parametro è il nome completo della classe dell'attività.

Quando hai un'attività in un modulo della funzionalità scaricato on demand, devi abilitare SplitCompat nell'attività.

Avvia un servizio definito in un modulo di funzionalità

Puoi avviare i servizi definiti nei moduli delle funzionalità utilizzando startService() dopo aver attivato SplitCompat.

startService(Intent()
  .setClassName("com.package", "com.package.module.MyService")
  .setFlags(...))

startService(new Intent()
  .setClassName("com.package", "com.package.module.MyService")
  .setFlags(...));

Esportare un componente definito in un modulo di funzionalità

Non devi includere i componenti Android esportati all'interno di moduli facoltativi.

Il sistema di compilazione unisce le voci manifest di tutti i moduli nel modulo di base. Se un modulo facoltativo conteneva un componente esportato, sarebbe accessibile anche prima dell'installazione del modulo e potrebbe causare un arresto anomalo a causa del codice mancante quando viene richiamato da un'altra app.

Questo non è un problema per i componenti interni, a cui viene eseguito l'accesso solo dall'app, che può quindi verificare che il modulo sia installato prima di accedere al componente.

Se hai bisogno di un componente esportato e vuoi che i relativi contenuti si trovino in un modulo facoltativo, valuta la possibilità di implementare un pattern proxy. Puoi farlo aggiungendo un componente proxy esportato nella base. Quando viene eseguito l'accesso, il componente proxy può verificare la presenza del modulo che contiene i contenuti. Se il modulo è presente, il componente proxy può avviare il componente interno dal modulo tramite un Intent, ritrasmettendo l'intent dall'app chiamante. Se il modulo non è presente, il componente può scaricarlo o restituire un messaggio di errore appropriato all'app chiamante.

Accedere al codice e alle risorse dei moduli installati

Se attivi SplitCompat per il contesto dell'applicazione di base e le attività nel modulo delle funzionalità, puoi utilizzare il codice e le risorse di un modulo delle funzionalità come se facessero parte dell'APK di base, una volta installato il modulo facoltativo.

Codice di accesso da un altro modulo

Accedere al codice di base da un modulo

Il codice all'interno del modulo di base può essere utilizzato direttamente da altri moduli. Non devi fare nulla di speciale: basta importare e utilizzare i corsi di cui hai bisogno.

Accedere al codice di un modulo da un altro modulo

Non è possibile accedere in modo statico a un oggetto o a una classe all'interno di un modulo da un altro modulo, ma è possibile accedervi indirettamente utilizzando la riflessione.

Devi fare attenzione alla frequenza con cui si verifica questo fenomeno, a causa dei costi relativi al rendimento della riflessione. Per casi d'uso complessi, utilizza framework di dipendenza come Dagger 2 per garantire una singola chiamata di riflessione per la durata dell'applicazione.

Per semplificare le interazioni con l'oggetto dopo l'inizializzazione, è consigliabile definire un'interfaccia nel modulo di base e la relativa implementazione nel modulo della funzionalità. Ad esempio:

// In the base module
interface MyInterface {
  fun hello(): String
}

// In the feature module
object MyInterfaceImpl : MyInterface {
  override fun hello() = "Hello"
}

// In the base module, where we want to access the feature module code
val stringFromModule = (Class.forName("com.package.module.MyInterfaceImpl")
    .kotlin.objectInstance as MyInterface).hello();

// In the base module
public interface MyInterface {
  String hello();
}

// In the feature module
public class MyInterfaceImpl implements MyInterface {
  @Override
  public String hello() {
    return "Hello";
  }
}

// In the base module, where we want to access the feature module code
String stringFromModule =
   ((MyInterface) Class.forName("com.package.module.MyInterfaceImpl").getConstructor().newInstance()).hello();

Accedere a risorse e asset da un altro modulo

Una volta installato un modulo, puoi accedere alle risorse e agli asset al suo interno nel modo standard, con due avvertenze:

• Se accedi a una risorsa da un altro modulo, il modulo non avrà accesso all'identificatore della risorsa, anche se è comunque possibile accedere alla risorsa per nome. Tieni presente che il pacchetto da utilizzare per fare riferimento alla risorsa è il pacchetto del modulo in cui è definita la risorsa.
• Se vuoi accedere ad asset o risorse esistenti in un modulo appena installato da un altro modulo installato della tua app, devi farlo utilizzando il contesto dell'applicazione. Il contesto del componente che sta tentando di accedere alle risorse non verrà ancora aggiornato. In alternativa, puoi ricreare il componente (ad esempio chiamando Activity.recreate()) o reinstallare SplitCompat dopo l'installazione del modulo di funzionalità.

Caricare codice nativo in un'app utilizzando la pubblicazione on demand

Ti consigliamo di utilizzare ReLinker per caricare tutte le librerie native quando utilizzi il caricamento on demand dei moduli di funzionalità. ReLinker risolve un problema di caricamento delle librerie native dopo l'installazione di un modulo di funzionalità. Puoi scoprire di più su ReLinker nella sezione Suggerimenti JNI per Android.

Carica il codice nativo da un modulo facoltativo

Una volta installato un'app con split, ti consigliamo di caricarne il codice nativo tramite ReLinker. Per le app istantanee, devi utilizzare questo metodo speciale.

Se utilizzi System.loadLibrary() per caricare il codice nativo e la tua libreria nativa ha una dipendenza da un'altra libreria nel modulo, devi prima caricare manualmente quest'altra libreria. Se utilizzi ReLinker, l'operazione equivalente è Relinker.recursively().loadLibrary().

Se utilizzi dlopen() in codice nativo per caricare una libreria definita in un modulo facoltativo, non funzionerà con i percorsi delle librerie relativi. La soluzione migliore è recuperare il percorso assoluto della libreria dal codice Java tramite ClassLoader.findLibrary() e utilizzarlo nella chiamata dlopen(). Esegui questa operazione prima di inserire il codice nativo o utilizza una chiamata JNI dal codice nativo a Java.

Accedere alle app istantanee Android installate

Dopo che un modulo dell'app istantanea per Android viene segnalato come INSTALLED, puoi accedere al codice e alle risorse utilizzando un contesto dell'app aggiornato. Un contesto creato dall'app prima dell'installazione di un modulo (ad esempio, uno che è già memorizzato in una variabile) non contiene i contenuti del nuovo modulo. Un contesto nuovo, invece, può essere ottenuto, ad esempio, utilizzando createPackageContext.

// Generate a new context as soon as a request for a new module
// reports as INSTALLED.
override fun onStateUpdate(state: SplitInstallSessionState ) {
    if (state.sessionId() == mySessionId) {
        when (state.status()) {
            ...
            SplitInstallSessionStatus.INSTALLED -> {
                val newContext = context.createPackageContext(context.packageName, 0)
                // If you use AssetManager to access your app’s raw asset files, you’ll need
                // to generate a new AssetManager instance from the updated context.
                val am = newContext.assets
            }
        }
    }
}

// Generate a new context as soon as a request for a new module
// reports as INSTALLED.
@Override
public void onStateUpdate(SplitInstallSessionState state) {
    if (state.sessionId() == mySessionId) {
        switch (state.status()) {
            ...
            case SplitInstallSessionStatus.INSTALLED:
                Context newContext = context.createPackageContext(context.getPackageName(), 0);
                // If you use AssetManager to access your app’s raw asset files, you’ll need
                // to generate a new AssetManager instance from the updated context.
                AssetManager am = newContext.getAssets();
        }
    }
}

App istantanee Android su Android 8.0 e versioni successive

Quando richiedi un modulo on demand per un'app istantanea Android su Android 8.0 (livello API 26) e versioni successive, dopo che una richiesta di installazione viene segnalata come INSTALLED, devi aggiornare l'app con il contesto del nuovo modulo tramite una chiamata a SplitInstallHelper.updateAppInfo(Context context). In caso contrario, l'app non è ancora a conoscenza del codice e delle risorse del modulo. Dopo aver aggiornato i metadati dell'app, devi caricare i contenuti del modulo durante il successivo evento del thread principale chiamando un nuovo Handler, come mostrato di seguito:

override fun onStateUpdate(state: SplitInstallSessionState ) {
    if (state.sessionId() == mySessionId) {
        when (state.status()) {
            ...
            SplitInstallSessionStatus.INSTALLED -> {
                // You need to perform the following only for Android Instant Apps
                // running on Android 8.0 (API level 26) and higher.
                if (BuildCompat.isAtLeastO()) {
                    // Updates the app’s context with the code and resources of the
                    // installed module.
                    SplitInstallHelper.updateAppInfo(context)
                    Handler().post {
                        // Loads contents from the module using AssetManager
                        val am = context.assets
                        ...
                    }
                }
            }
        }
    }
}

@Override
public void onStateUpdate(SplitInstallSessionState state) {
    if (state.sessionId() == mySessionId) {
        switch (state.status()) {
            ...
            case SplitInstallSessionStatus.INSTALLED:
            // You need to perform the following only for Android Instant Apps
            // running on Android 8.0 (API level 26) and higher.
            if (BuildCompat.isAtLeastO()) {
                // Updates the app’s context with the code and resources of the
                // installed module.
                SplitInstallHelper.updateAppInfo(context);
                new Handler().post(new Runnable() {
                    @Override public void run() {
                        // Loads contents from the module using AssetManager
                        AssetManager am = context.getAssets();
                        ...
                    }
                });
            }
        }
    }
}

Carica le librerie C/C++

Se vuoi caricare librerie C/C++ da un modulo già scaricato dal dispositivo in un'app istantanea, utilizza SplitInstallHelper.loadLibrary(Context context, String libName), come mostrato di seguito:

override fun onStateUpdate(state: SplitInstallSessionState) {
    if (state.sessionId() == mySessionId) {
        when (state.status()) {
            SplitInstallSessionStatus.INSTALLED -> {
                // Updates the app’s context as soon as a module is installed.
                val newContext = context.createPackageContext(context.packageName, 0)
                // To load C/C++ libraries from an installed module, use the following API
                // instead of System.load().
                SplitInstallHelper.loadLibrary(newContext, “my-cpp-lib”)
                ...
            }
        }
    }
}

public void onStateUpdate(SplitInstallSessionState state) {
    if (state.sessionId() == mySessionId) {
        switch (state.status()) {
            case SplitInstallSessionStatus.INSTALLED:
                // Updates the app’s context as soon as a module is installed.
                Context newContext = context.createPackageContext(context.getPackageName(), 0);
                // To load C/C++ libraries from an installed module, use the following API
                // instead of System.load().
                SplitInstallHelper.loadLibrary(newContext, “my-cpp-lib”);
                ...
        }
    }
}

Limitazioni note

• Non è possibile utilizzare Android WebView in un'attività che accede a risorse o asset da un modulo facoltativo. Questo è dovuto a un'incompatibilità tra WebView e SplitCompat sul livello API Android 28 e versioni precedenti.
• Non puoi memorizzare nella cache gli oggetti ApplicationInfo di Android, i relativi contenuti o gli oggetti che li contengono all'interno della tua app. Devi sempre recuperare questi oggetti come necessario da un contesto dell'app. La memorizzazione nella cache di questi oggetti potrebbe causare l'arresto anomalo dell'app durante l'installazione di un modulo di funzionalità.

Gestire i moduli installati

Per controllare quali moduli della funzionalità sono attualmente installati sul dispositivo, puoi chiamare SplitInstallManager.getInstalledModules(), che restituisce un Set<String> dei nomi dei moduli installati, come mostrato di seguito.

val installedModules: Set<String> = splitInstallManager.installedModules

Set<String> installedModules = splitInstallManager.getInstalledModules();

Disinstallare i moduli

Puoi richiedere al dispositivo di disinstallare i moduli richiamando SplitInstallManager.deferredUninstall(List<String> moduleNames), come mostrato di seguito.

// Specifies two feature modules for deferred uninstall.
splitInstallManager.deferredUninstall(listOf("pictureMessages", "promotionalFilters"))

// Specifies two feature modules for deferred uninstall.
splitInstallManager.deferredUninstall(Arrays.asList("pictureMessages", "promotionalFilters"));

Le disinstallazioni dei moduli non avvengono immediatamente. In altre parole, il dispositivo le disinstalla in background in base alle necessità per risparmiare spazio di archiviazione. Puoi verificare che il dispositivo abbia eliminato un modulo richiamando SplitInstallManager.getInstalledModules() e controllando il risultato, come descritto nella sezione precedente.

Scaricare risorse linguistiche aggiuntive

Con gli app bundle, i dispositivi scaricano solo il codice e le risorse di cui hanno bisogno per eseguire la tua app. Pertanto, per le risorse linguistiche, il dispositivo di un utente scarica solo le risorse linguistiche della tua app corrispondenti a una o più lingue attualmente selezionate nelle impostazioni del dispositivo.

Se vuoi che la tua app abbia accesso a risorse linguistiche aggiuntive, ad esempio per implementare un selettore lingua in-app, puoi utilizzare la libreria Play Feature Delivery per scaricarle on demand. La procedura è simile a quella per il download di un modulo di funzionalità, come mostrato di seguito.

// Captures the user’s preferred language and persists it
// through the app’s SharedPreferences.
sharedPrefs.edit().putString(LANGUAGE_SELECTION, "fr").apply()
...

// Creates a request to download and install additional language resources.
val request = SplitInstallRequest.newBuilder()
        // Uses the addLanguage() method to include French language resources in the request.
        // Note that country codes are ignored. That is, if your app
        // includes resources for “fr-FR” and “fr-CA”, resources for both
        // country codes are downloaded when requesting resources for "fr".
        .addLanguage(Locale.forLanguageTag(sharedPrefs.getString(LANGUAGE_SELECTION)))
        .build()

// Submits the request to install the additional language resources.
splitInstallManager.startInstall(request)

// Captures the user’s preferred language and persists it
// through the app’s SharedPreferences.
sharedPrefs.edit().putString(LANGUAGE_SELECTION, "fr").apply();
...

// Creates a request to download and install additional language resources.
SplitInstallRequest request =
    SplitInstallRequest.newBuilder()
        // Uses the addLanguage() method to include French language resources in the request.
        // Note that country codes are ignored. That is, if your app
        // includes resources for “fr-FR” and “fr-CA”, resources for both
        // country codes are downloaded when requesting resources for "fr".
        .addLanguage(Locale.forLanguageTag(sharedPrefs.getString(LANGUAGE_SELECTION)))
        .build();

// Submits the request to install the additional language resources.
splitInstallManager.startInstall(request);

La richiesta viene gestita come se fosse una richiesta per un modulo di funzionalità. In altre parole, puoi monitorare lo stato della richiesta come faresti normalmente.

Se la tua app non richiede immediatamente le risorse linguistiche aggiuntive, puoi posticipare l'installazione quando l'app è in background, come mostrato di seguito.

splitInstallManager.deferredLanguageInstall(
    Locale.forLanguageTag(sharedPrefs.getString(LANGUAGE_SELECTION)))

splitInstallManager.deferredLanguageInstall(
    Locale.forLanguageTag(sharedPrefs.getString(LANGUAGE_SELECTION)));

Accedere alle risorse linguistiche scaricate

Per ottenere l'accesso alle risorse linguistiche scaricate, l'app deve eseguire il metodo SplitCompat.installActivity() all'interno del metodo attachBaseContext() di ogni attività che richiede l'accesso a queste risorse, come mostrato di seguito.

override fun attachBaseContext(base: Context) {
  super.attachBaseContext(base)
  SplitCompat.installActivity(this)
}

@Override
protected void attachBaseContext(Context base) {
  super.attachBaseContext(base);
  SplitCompat.installActivity(this);
}

Per ogni attività in cui vuoi utilizzare le risorse linguistiche scaricate dalla tua app, aggiornate il contesto di base e imposta una nuova impostazioni internazionali tramite il relativo Configuration:

override fun attachBaseContext(base: Context) {
  val configuration = Configuration()
  configuration.setLocale(Locale.forLanguageTag(sharedPrefs.getString(LANGUAGE_SELECTION)))
  val context = base.createConfigurationContext(configuration)
  super.attachBaseContext(context)
  SplitCompat.install(this)
}

@Override
protected void attachBaseContext(Context base) {
  Configuration configuration = new Configuration();
  configuration.setLocale(Locale.forLanguageTag(sharedPrefs.getString(LANGUAGE_SELECTION)));
  Context context = base.createConfigurationContext(configuration);
  super.attachBaseContext(context);
  SplitCompat.install(this);
}

Affinché queste modifiche vengano applicate, devi ricreare la tua attività dopo che la nuova lingua è stata installata e può essere utilizzata. Puoi utilizzare il metodo Activity#recreate().

when (state.status()) {
  SplitInstallSessionStatus.INSTALLED -> {
      // Recreates the activity to load resources for the new language
      // preference.
      activity.recreate()
  }
  ...
}

switch (state.status()) {
  case SplitInstallSessionStatus.INSTALLED:
      // Recreates the activity to load resources for the new language
      // preference.
      activity.recreate();
  ...
}

Disinstallare risorse linguistiche aggiuntive

Come per i moduli di funzionalità, puoi disinstallare risorse aggiuntive in qualsiasi momento. Prima di richiedere una disinstallazione, ti consigliamo di determinare prima quali lingue sono attualmente installate, come segue.

val installedLanguages: Set<String> = splitInstallManager.installedLanguages

Set<String> installedLanguages = splitInstallManager.getInstalledLanguages();

Puoi quindi decidere quali lingue disinstallare utilizzando il metodo deferredLanguageUninstall(), come mostrato di seguito.

splitInstallManager.deferredLanguageUninstall(
    Locale.forLanguageTag(sharedPrefs.getString(LANGUAGE_SELECTION)))

splitInstallManager.deferredLanguageUninstall(
    Locale.forLanguageTag(sharedPrefs.getString(LANGUAGE_SELECTION)));

Verificare localmente le installazioni dei moduli

La Play Feature Delivery Library ti consente di testare localmente la capacità della tua app di svolgere quanto segue, senza connettersi al Play Store:

• Richiedi e monitora le installazioni dei moduli.
• Gestire gli errori di installazione.
• Usa SplitCompat per accedere ai moduli.

Questa pagina descrive come eseguire il deployment degli APK suddivisi della tua app sul dispositivo di test in modo che Play Feature Delivery li utilizzi automaticamente per simulare la richiesta, il download e l'installazione dei moduli dal Play Store.

Anche se non è necessario apportare modifiche alla logica dell'app, devi soddisfare i seguenti requisiti:

• Scarica e installa la versione più recente di bundletool. Devi avere bundletool per creare un nuovo insieme di APK installabili dal bundle della tua app.

Creare un insieme di APK

Se non l'hai ancora fatto, crea gli APK suddivisi della tua app come segue:

1. Crea un app bundle per la tua app utilizzando uno dei seguenti metodi:
   • Utilizza Android Studio e il plug-in Android per Gradle per compilare e firmare un Android App Bundle.
   • Crea il bundle dell'app dalla riga di comando.

2. Utilizza bundletool per generare un insieme di APK per tutte le configurazioni del dispositivo con il seguente comando:

   bundletool build-apks --local-testing
     --bundle my_app.aab
     --output my_app.apks
   

Il flag --local-testing include metadati nei manifest degli APK che fanno sapere alla libreria Play Feature Delivery di utilizzare gli APK suddivisi localmente per testare l'installazione dei moduli delle funzionalità, senza connettersi al Play Store.

Esegui il deployment dell'app sul dispositivo

Dopo aver generato un insieme di APK utilizzando il flag --local-testing, utilizza bundletool per installare la versione di base dell'app e trasferire altri APK nello spazio di archiviazione locale del dispositivo. Puoi eseguire entrambe le azioni con il seguente comando:

bundletool install-apks --apks my_app.apks

Ora, quando avvii l'app e completi il flusso utente per scaricare e installare un modulo della funzionalità, la Play Feature Delivery Library utilizza gli APK che bundletool sono stati trasferiti nello spazio di archiviazione locale del dispositivo.

Simulare un errore di rete

Per simulare le installazioni dei moduli dal Play Store, la libreria Play Feature Delivery utilizza un'alternativa al SplitInstallManager, chiamata FakeSplitInstallManager, per richiedere il modulo. Quando utilizzi bundletool con il flag --local-testing per creare un insieme di APK e eseguirne il deployment sul dispositivo di test, vengono inclusi metadati che indicano alla Libreria di importazione di funzionalità di Play di passare automaticamente le chiamate API dell'app per invocare FakeSplitInstallManager anziché SplitInstallManager.

FakeSplitInstallManager include un flag booleano che puoi attivare per simulare un errore di rete la prossima volta che la tua app richiede l'installazione di un modulo. Per accedere a FakeSplitInstallManager nei tuoi test, puoi recuperarne un'istanza utilizzando FakeSplitInstallManagerFactory, come mostrato di seguito:

// Creates an instance of FakeSplitInstallManager with the app's context.
val fakeSplitInstallManager = FakeSplitInstallManagerFactory.create(context)
// Tells Play Feature Delivery Library to force the next module request to
// result in a network error.
fakeSplitInstallManager.setShouldNetworkError(true)

// Creates an instance of FakeSplitInstallManager with the app's context.
FakeSplitInstallManager fakeSplitInstallManager =
    FakeSplitInstallManagerFactory.create(context);
// Tells Play Feature Delivery Library to force the next module request to
// result in a network error.
fakeSplitInstallManager.setShouldNetworkError(true);