On-Demand-Auslieferung konfigurieren

Mit Funktionsmodulen können Sie bestimmte Funktionen und Ressourcen vom Basismodul Ihrer App trennen und sie dennoch in Ihr App Bundle aufnehmen. Mit Play Feature Delivery können Nutzer diese Komponenten beispielsweise später bei Bedarf herunterladen und installieren, nachdem sie bereits das Basis-APK Ihrer App installiert haben.

Nehmen wir beispielsweise eine SMS-App, die Funktionen zum Aufnehmen und Senden von Bildnachrichten enthält, aber nur ein kleiner Prozentsatz der Nutzer sendet Bildnachrichten. Es kann sinnvoll sein, die Bildnachrichtenfunktion als herunterladbares Funktionsmodul einzubinden. So ist der erste App-Download für alle Nutzer kleiner und nur Nutzer, die Bildnachrichten senden, müssen diese zusätzliche Komponente herunterladen.

Diese Art der Modularisierung erfordert mehr Aufwand und möglicherweise eine Umstrukturierung des vorhandenen Codes Ihrer App. Überlegen Sie daher genau, welche Funktionen Ihrer App am meisten davon profitieren würden, dass sie Nutzern auf Anfrage zur Verfügung stehen. UX-Best Practices für die On-Demand-Auslieferung

Wenn Sie App-Funktionen im Laufe der Zeit schrittweise modularisieren möchten, ohne erweiterte Bereitstellungsoptionen wie die On-Demand-Bereitstellung zu aktivieren, konfigurieren Sie stattdessen die Bereitstellung bei der Installation.

Auf dieser Seite wird beschrieben, wie Sie Ihrem App-Projekt ein Funktionsmodul hinzufügen und es für die On-Demand-Bereitstellung konfigurieren. Bevor Sie beginnen, müssen Sie Android Studio 3.5 oder höher und das Android-Gradle-Plug-in 3.5.0 oder höher verwenden.

Neues Modul für die On-Demand-Bereitstellung konfigurieren

Am einfachsten erstellen Sie ein neues Funktionsmodul mit Android Studio 3.5 oder höher. Da Funktionsmodule inhärent vom Basis-App-Modul abhängig sind, kannst du sie nur zu bereits vorhandenen App-Projekten hinzufügen.

So fügen Sie Ihrem App-Projekt mit Android Studio ein Funktionsmodul hinzu:

  1. Öffnen Sie Ihr App-Projekt in der IDE, falls Sie dies noch nicht getan haben.
  2. Wählen Sie in der Menüleiste File > New > New Module aus.
  3. Wählen Sie im Dialogfeld Create New Module (Neues Modul erstellen) die Option Dynamic Feature Module (Modul für dynamische Funktionen) aus und klicken Sie auf Next (Weiter).
  4. Führen Sie im Abschnitt Neues Modul konfigurieren die folgenden Schritte aus:
    1. Wählen Sie im Drop-down-Menü das Basis-App-Modul für Ihr App-Projekt aus.
    2. Geben Sie einen Modulnamen an. Die IDE verwendet diesen Namen, um das Modul in Ihrer Gradle-Einstellungsdatei als Gradle-Unterprojekt zu identifizieren. Wenn Sie Ihr App-Bundle erstellen, verwendet Gradle das letzte Element des Unterprojektnamens, um das Attribut <manifest split> in das Manifest des Funktionsmoduls einzufügen.
    3. Geben Sie den Paketnamen des Moduls an. Standardmäßig schlägt Android Studio einen Paketnamen vor, der den Root-Paketnamen des Basismoduls und den Modulnamen kombiniert, den Sie im vorherigen Schritt angegeben haben.
    4. Wählen Sie das Mindest-API-Level aus, das das Modul unterstützen soll. Dieser Wert sollte mit dem des Basismoduls übereinstimmen.
  5. Klicken Sie auf Weiter.
  6. Führen Sie im Bereich Optionen für Modul-Download folgende Schritte aus:

    1. Geben Sie den Modultitel mit bis zu 50 Zeichen an. Die Plattform verwendet diesen Titel, um das Modul für Nutzer zu identifizieren, z. B. wenn sie bestätigen müssen, ob sie das Modul herunterladen möchten. Aus diesem Grund muss das Basismodul Ihrer App den Modultitel als String-Ressource enthalten, die Sie übersetzen können. Wenn Sie das Modul mit Android Studio erstellen, fügt die IDE die String-Ressource für Sie dem Basismodul hinzu und fügt den folgenden Eintrag in das Manifest des Funktionsmoduls ein:

      <dist:module
          ...
          dist:title="@string/feature_title">
      </dist:module>
      
    2. Wählen Sie im Drop-down-Menü unter Einbindung bei der Installation die Option Modul nicht bei der Installation einbinden aus. Android Studio fügt das Folgende in das Manifest des Moduls ein, um Ihre Auswahl zu berücksichtigen:

      <dist:module ... >
        <dist:delivery>
            <dist:on-demand/>
        </dist:delivery>
      </dist:module>
      
    3. Klicken Sie das Kästchen neben Fusing an, wenn dieses Modul auf Geräten mit Android 4.4 (API‑Level 20) und niedriger verfügbar sein und in Multi‑APKs enthalten sein soll. Das bedeutet, dass Sie das On-Demand-Verhalten für dieses Modul aktivieren und das Zusammenführen deaktivieren können, um es von Geräten auszuschließen, die das Herunterladen und Installieren von unterteilten APKs nicht unterstützen. Android Studio fügt das Folgende in das Manifest des Moduls ein, um Ihre Auswahl zu berücksichtigen:

      <dist:module ...>
          <dist:fusing dist:include="true | false" />
      </dist:module>
      
  7. Klicken Sie auf Fertig.

Nachdem Android Studio das Modul erstellt hat, können Sie den Inhalt im Bereich Projekt prüfen. Wählen Sie dazu in der Menüleiste Ansicht > Toolfenster > Projekt aus. Der Standardcode, die Ressourcen und die Organisation sollten denen des Standard-App-Moduls ähneln.

Als Nächstes müssen Sie die On-Demand-Installationsfunktion mithilfe der Play Feature Delivery-Bibliothek implementieren.

Play Feature Delivery-Bibliothek in Ihr Projekt einbinden

Bevor Sie beginnen können, müssen Sie Ihrem Projekt zuerst die Play Feature Delivery Library hinzufügen.

On-Demand-Modul anfordern

Wenn Ihre App ein Featuremodul verwenden muss, kann sie es im Vordergrund über die Klasse SplitInstallManager anfordern. Wenn Sie eine Anfrage stellen, muss in Ihrer App der Name des Moduls angegeben werden, wie er durch das split-Element im Manifest des Zielmoduls definiert ist. Wenn Sie mit Android Studio ein Funktionsmodul erstellen, verwendet das Build-System den von Ihnen angegebenen Modulnamen, um diese Eigenschaft zur Kompilierungszeit in das Manifest des Moduls einzufügen. Weitere Informationen finden Sie unter Manifeste von Funktionsmodulen.

Nehmen wir beispielsweise an, eine App hat ein On-Demand-Modul zum Aufnehmen und Senden von Bildnachrichten über die Kamera des Geräts und dieses On-Demand-Modul gibt split="pictureMessages" in seinem Manifest an. Im folgenden Beispiel wird SplitInstallManager verwendet, um das Modul pictureMessages (zusammen mit einem zusätzlichen Modul für einige Werbefilter) anzufordern:

Kotlin

// 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 ->  ... }

Java

// 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 -> { ... });

Wenn Ihre App ein On-Demand-Modul anfordert, verwendet die Play Feature Delivery Library eine „Fire-and-Forget“-Strategie. Das heißt, die Anfrage zum Herunterladen des Moduls wird an die Plattform gesendet, aber es wird nicht überwacht, ob die Installation erfolgreich war. Damit der Nutzer nach der Installation weitergeleitet wird oder Fehler ordnungsgemäß behandelt werden, müssen Sie den Anfragestatus im Blick behalten.

Hinweis:Sie können ein Featuremodul anfordern, das bereits auf dem Gerät installiert ist. Die API betrachtet die Anfrage sofort als abgeschlossen, wenn sie feststellt, dass das Modul bereits installiert ist. Außerdem wird ein installiertes Modul von Google Play automatisch auf dem neuesten Stand gehalten. Wenn Sie also eine neue Version Ihres App-Bundles hochladen, aktualisiert die Plattform alle installierten APKs, die zu Ihrer App gehören. Weitere Informationen finden Sie unter App-Updates verwalten.

Damit Ihre App auf den Code und die Ressourcen des Moduls zugreifen kann, muss SplitCompat aktiviert sein. Hinweis: SplitCompat ist für Android-Instant Apps nicht erforderlich.

Installation von On-Demand-Modulen verzögern

Wenn ein On-Demand-Modul nicht sofort mit Ihrer App heruntergeladen und installiert werden soll, können Sie die Installation auf einen Zeitpunkt verschieben, an dem die App im Hintergrund ausgeführt wird. Dies eignet sich besonders gut für im Voraus geladene Werbematerialien, die bei einem späteren App-Start ausgeliefert werden.

Sie können ein Modul angeben, das später heruntergeladen werden soll, indem Sie die Methode deferredInstall() verwenden, wie unten gezeigt. Im Gegensatz zu SplitInstallManager.startInstall() muss Ihre App nicht im Vordergrund ausgeführt werden, um eine Anfrage für eine verzögerte Installation zu initiieren.

Kotlin

// 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"))

Java

// 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"));

Anfragen für verzögerte Installationen werden auf Best-Effort-Basis bearbeitet. Sie können den Fortschritt nicht nachverfolgen. Bevor Sie also versuchen, auf ein Modul zuzugreifen, das Sie für die verzögerte Installation angegeben haben, sollten Sie prüfen, ob das Modul installiert wurde. Wenn das Modul sofort verfügbar sein soll, verwenden Sie stattdessen SplitInstallManager.startInstall(), um es anzufordern, wie im vorherigen Abschnitt beschrieben.

Anfragestatus überwachen

Wenn Sie eine Fortschrittsanzeige aktualisieren, nach der Installation einen Intent auslösen oder einen Anforderungsfehler ordnungsgemäß verarbeiten möchten, müssen Sie auf Statusaktualisierungen der asynchronen Aufgabe SplitInstallManager.startInstall() warten. Bevor Sie Updates für Ihre Installationsanfrage erhalten können, müssen Sie einen Listener registrieren und die Sitzungs-ID für die Anfrage abrufen, wie unten gezeigt.

Kotlin

// 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)

Java

// 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);

Anforderungsfehler behandeln

Beachten Sie, dass die On-Demand-Installation von Funktionsmodulen manchmal fehlschlagen kann, genau wie die Installation von Apps nicht immer erfolgreich ist. Die Installation kann aufgrund von Problemen wie geringem Gerätespeicher, fehlender Netzwerkverbindung oder fehlender Anmeldung des Nutzers im Google Play Store fehlschlagen. Vorschläge, wie Sie diese Situationen aus Nutzersicht elegant handhaben können, finden Sie in unseren UX-Richtlinien für die On-Demand-Lieferung.

Im Code sollten Sie Fehler beim Herunterladen oder Installieren eines Moduls mit addOnFailureListener() abfangen, wie unten gezeigt:

Kotlin

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.
                    }
                }
            }
        }
}

Java

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.
                    }
                }
            }
        });
}

In der folgenden Tabelle werden die Fehlerstatus beschrieben, die Ihre App möglicherweise verarbeiten muss:

Fehlercode Beschreibung Vorgeschlagene Maßnahme
ACTIVE_SESSIONS_LIMIT_EXCEEDED Die Anfrage wird abgelehnt, weil mindestens eine vorhandene Anfrage derzeit heruntergeladen wird. Prüfen Sie, ob noch Anfragen heruntergeladen werden, wie im Beispiel oben gezeigt.
MODULE_UNAVAILABLE Google Play kann das angeforderte Modul nicht finden, da die aktuelle installierte Version der App, das Gerät und das Google Play-Konto des Nutzers nicht übereinstimmen. Wenn der Nutzer keinen Zugriff auf das Modul hat, benachrichtige ihn.
INVALID_REQUEST Google Play hat die Anfrage erhalten, sie ist aber ungültig. Prüfen Sie, ob die in der Anfrage enthaltenen Informationen vollständig und korrekt sind.
SESSION_NOT_FOUND Für die angegebene Sitzungs-ID wurde keine Sitzung gefunden. Wenn Sie den Status einer Anfrage anhand der Sitzungs-ID überwachen möchten, achten Sie darauf, dass die Sitzungs-ID korrekt ist.
API_NOT_AVAILABLE Die Play Feature Delivery Library wird auf dem aktuellen Gerät nicht unterstützt. Das Gerät kann also keine Funktionen auf Anfrage herunterladen und installieren. Auf Geräten mit Android 4.4 (API-Level 20) oder niedriger sollten Sie Funktionsmodule bei der Installation mit der Manifest-Property dist:fusing einbinden. Weitere Informationen zum Manifest von Funktionsmodulen
NETWORK_ERROR Die Anfrage ist aufgrund eines Netzwerkfehlers fehlgeschlagen. Fordern Sie den Nutzer auf, entweder eine Netzwerkverbindung herzustellen oder zu einem anderen Netzwerk zu wechseln.
ACCESS_DENIED Die App kann die Anfrage aufgrund unzureichender Berechtigungen nicht registrieren. Das passiert in der Regel, wenn die App im Hintergrund ausgeführt wird. Wiederholen Sie die Anfrage, wenn die App in den Vordergrund zurückkehrt.
INCOMPATIBLE_WITH_EXISTING_SESSION Die Anfrage enthält ein oder mehrere Module, die bereits angefordert, aber noch nicht installiert wurden. Entweder erstellen Sie eine neue Anfrage, die keine Module enthält, die Ihre App bereits angefordert hat, oder Sie warten, bis alle derzeit angeforderten Module installiert sind, bevor Sie die Anfrage noch einmal senden.

Wenn Sie ein Modul anfordern, das bereits installiert ist, wird kein Fehler ausgegeben.

SERVICE_DIED Der für die Bearbeitung der Anfrage zuständige Dienst wurde beendet. Wiederholen Sie die Anfrage.

Ihre SplitInstallStateUpdatedListener erhält eine SplitInstallSessionState mit diesem Fehlercode, dem Status FAILED und der Sitzungs-ID -1.

INSUFFICIENT_STORAGE Auf dem Gerät ist nicht genügend freier Speicherplatz vorhanden, um das Funktionsmodul zu installieren. Benachrichtigen Sie den Nutzer, dass er nicht genügend Speicherplatz hat, um diese Funktion zu installieren.
SPLITCOMPAT_VERIFICATION_ERROR, SPLITCOMPAT_EMULATION_ERROR, SPLITCOMPAT_COPY_ERROR SplitCompat konnte das Funktionsmodul nicht laden. Diese Fehler sollten nach dem nächsten Neustart der App automatisch behoben werden.
PLAY_STORE_NOT_FOUND Die Play Store App ist auf dem Gerät nicht installiert. Informiere den Nutzer, dass die Play Store App zum Herunterladen dieser Funktion erforderlich ist.
APP_NOT_OWNED Die App wurde nicht über Google Play installiert und die Funktion kann nicht heruntergeladen werden. Dieser Fehler kann nur bei verzögerten Installationen auftreten. Wenn der Nutzer die App bei Google Play erwerben soll, verwenden Sie startInstall(), um die erforderliche Nutzerbestätigung zu erhalten.
INTERNAL_ERROR Im Play Store ist ein interner Fehler aufgetreten. Wiederholen Sie die Anfrage.

Wenn ein Nutzer den Download eines On-Demand-Moduls anfordert und ein Fehler auftritt, sollten Sie ein Dialogfeld mit zwei Optionen für den Nutzer anzeigen: Erneut versuchen (wodurch die Anfrage noch einmal versucht wird) und Abbrechen (wodurch die Anfrage abgebrochen wird). Für zusätzlichen Support sollten Sie auch einen Hilfe-Link angeben, der Nutzer zur Google Play-Hilfe weiterleitet.

Statusaktualisierungen verarbeiten

Nachdem Sie einen Listener registriert und die Sitzungs-ID für Ihre Anfrage aufgezeichnet haben, verwenden Sie StateUpdatedListener.onStateUpdate(), um Statusänderungen zu verarbeiten, wie unten gezeigt.

Kotlin

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.
            }
        }
    }
}

Java

@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.
        }
    }
}

Die möglichen Status für Ihre Installationsanfrage sind in der folgenden Tabelle beschrieben.

Anforderungsstatus Beschreibung Vorgeschlagene Maßnahme
AUSSTEHEND Die Anfrage wurde akzeptiert und der Download sollte in Kürze starten. Initialisieren Sie UI-Komponenten wie eine Fortschrittsanzeige, um dem Nutzer Feedback zum Download zu geben.
REQUIRES_USER_CONFIRMATION Für den Download ist eine Nutzerbestätigung erforderlich. Dieser Status tritt am häufigsten auf, wenn die App nicht über Google Play installiert wurde. Fordern Sie den Nutzer auf, den Download der Funktion über Google Play zu bestätigen. Weitere Informationen finden Sie im Abschnitt zum Einholen der Nutzerbestätigung.
Downloads Der Download wird ausgeführt. Wenn Sie einen Fortschrittsbalken für den Download bereitstellen, verwenden Sie die Methoden SplitInstallSessionState.bytesDownloaded() und SplitInstallSessionState.totalBytesToDownload(), um die Benutzeroberfläche zu aktualisieren (siehe das Codebeispiel über dieser Tabelle).
HERUNTERGELADEN Das Gerät hat das Modul heruntergeladen, die Installation hat aber noch nicht begonnen. Apps sollten SplitCompat aktivieren, um auf heruntergeladene Module zugreifen zu können und diesen Status zu vermeiden. Dies ist erforderlich, um auf den Code und die Ressourcen des Funktionsmoduls zuzugreifen.
Installation... Das Modul wird gerade auf dem Gerät installiert. Aktualisieren Sie die Fortschrittsanzeige. Dieser Status ist in der Regel nur von kurzer Dauer.
INSTALLIERT Das Modul ist auf dem Gerät installiert. Zugriffscode und Ressource im Modul für die Fortsetzung der User Journey.

Wenn das Modul für eine Android-Sofort-App ist, die auf Android 8.0 (API-Level 26) oder höher ausgeführt wird, müssen Sie splitInstallHelper verwenden, um App-Komponenten mit dem neuen Modul zu aktualisieren.

FEHLER Die Anfrage ist fehlgeschlagen, bevor das Modul auf dem Gerät installiert wurde. Fordern Sie den Nutzer auf, den Antrag noch einmal zu senden oder ihn zu stornieren.
WIRD ABGEBROCHEN Das Gerät bricht die Anfrage gerade ab. Weitere Informationen zum Abbrechen einer Installationsanfrage
GESTRICHEN Die Anfrage wurde abgebrochen.

Nutzerbestätigung einholen

In einigen Fällen ist möglicherweise eine Bestätigung durch den Nutzer erforderlich, bevor eine Downloadanfrage bei Google Play ausgeführt wird. Das kann beispielsweise der Fall sein, wenn Ihre App nicht über Google Play installiert wurde oder Sie versuchen, eine große Datei über mobile Daten herunterzuladen. In solchen Fällen wird der Status für die Anforderungsberichte REQUIRES_USER_CONFIRMATION und Ihre App muss die Bestätigung des Nutzers einholen, bevor das Gerät die Module in der Anfrage herunterladen und installieren kann. Um die Bestätigung zu erhalten, sollte Ihre App den Nutzer so auffordern:

Kotlin

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)
    }
    ...
 }

Java

@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);
    }
    ...
 }

Sie können einen Launcher für Aktivitätsergebnisse mit dem integrierten Vertrag ActivityResultContracts.StartIntentSenderForResult registrieren. Weitere Informationen finden Sie unter Activity Result APIs.

Der Status der Anfrage wird je nach Antwort des Nutzers aktualisiert:

  • Wenn der Nutzer die Bestätigung akzeptiert, ändert sich der Status der Anfrage in PENDING und der Download wird fortgesetzt.
  • Wenn der Nutzer die Bestätigung ablehnt, ändert sich der Anfragestatus in CANCELED.
  • Wenn der Nutzer keine Auswahl trifft, bevor der Dialog geschlossen wird, bleibt der Anfragestatus REQUIRES_USER_CONFIRMATION. Ihre App kann den Nutzer noch einmal auffordern, die Anfrage abzuschließen.

Wenn Sie einen Callback mit der Antwort des Nutzers erhalten möchten, können Sie den ActivityResultCallback überschreiben, wie unten gezeigt.

Kotlin

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.
    }
}

Java

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.
        }
    });

Installationsanfrage abbrechen

Wenn Ihre App eine Anfrage vor der Installation abbrechen muss, kann sie die Methode cancelInstall() mit der Sitzungs-ID der Anfrage aufrufen, wie unten dargestellt.

Kotlin

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

Java

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

Auf Module zugreifen

Damit Ihre App nach dem Download auf Code und Ressourcen aus einem heruntergeladenen Modul zugreifen kann, muss die SplitCompat Library sowohl für Ihre App als auch für jede Aktivität in den Funktionsmodulen, die Ihre App herunterlädt, aktiviert sein.

Beachten Sie jedoch, dass der Zugriff auf die Inhalte eines Moduls auf der Plattform für einige Zeit (Tage, in einigen Fällen) nach dem Herunterladen des Moduls den folgenden Einschränkungen unterliegt:

  • Die Plattform kann keine neuen Manifesteinträge anwenden, die durch das Modul eingeführt werden.
  • Die Plattform kann nicht auf die Ressourcen des Moduls für System-UI-Komponenten wie Benachrichtigungen zugreifen. Wenn Sie solche Ressourcen sofort verwenden müssen, sollten Sie sie in das Basismodul Ihrer App aufnehmen.

SplitCompat aktivieren

Damit Ihre App auf Code und Ressourcen aus einem heruntergeladenen Modul zugreifen kann, müssen Sie SplitCompat mit nur einer der in den folgenden Abschnitten beschriebenen Methoden aktivieren.

Nachdem Sie SplitCompat für Ihre App aktiviert haben, müssen Sie SplitCompat auch für jede Aktivität in den Funktionsmodulen aktivieren, auf die Ihre App zugreifen soll.

SplitCompatApplication im Manifest deklarieren

Die einfachste Möglichkeit, SplitCompat zu aktivieren, besteht darin, SplitCompatApplication als Application-Unterklasse im Manifest Ihrer App zu deklarieren, wie unten dargestellt:

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

Nachdem die App auf einem Gerät installiert wurde, können Sie automatisch auf Code und Ressourcen aus heruntergeladenen Funktionsmodulen zugreifen.

SplitCompat zur Laufzeit aufrufen

Sie können SplitCompat auch zur Laufzeit in bestimmten Aktivitäten oder Diensten aktivieren. Das Aktivieren von SplitCompat auf diese Weise ist erforderlich, um Aktivitäten zu starten, die in Funktionsmodulen enthalten sind. Überschreiben Sie dazu attachBaseContext wie unten gezeigt.

Wenn Sie eine benutzerdefinierte Application-Klasse haben, lassen Sie sie stattdessen von SplitCompatApplication erben, um SplitCompat für Ihre App zu aktivieren, wie unten gezeigt:

Kotlin

class MyApplication : SplitCompatApplication() {
    ...
}

Java

public class MyApplication extends SplitCompatApplication {
    ...
}

SplitCompatApplication überschreibt einfach ContextWrapper.attachBaseContext(), um SplitCompat.install(Context applicationContext) einzuschließen. Wenn Ihre Application-Klasse nicht von SplitCompatApplication abgeleitet werden soll, können Sie die attachBaseContext()-Methode manuell überschreiben:

Kotlin

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

Java

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

Wenn Ihr On-Demand-Modul sowohl mit Instant Apps als auch mit installierten Apps kompatibel ist, können Sie SplitCompat bedingt aufrufen:

Kotlin

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

Java

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

SplitCompat für Modulaktivitäten aktivieren

Nachdem Sie SplitCompat für Ihre Basis-App aktiviert haben, müssen Sie SplitCompat für jede Aktivität aktivieren, die Ihre App in einem Funktionsmodul herunterlädt. Verwenden Sie dazu die Methode SplitCompat.installActivity():

Kotlin

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

Java

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

Auf Komponenten zugreifen, die in Funktionsmodulen definiert sind

Aktivität starten, die in einem Funktionsmodul definiert ist

Sie können Aktivitäten, die in Funktionsmodulen definiert sind, mit startActivity() starten, nachdem Sie SplitCompat aktiviert haben.

Kotlin

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

Java

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

Der erste Parameter für setClassName ist der Paketname der App und der zweite Parameter ist der vollständige Klassenname der Aktivität.

Wenn Sie eine Aktivität in einem Funktionsmodul haben, das Sie bei Bedarf heruntergeladen haben, müssen Sie SplitCompat in der Aktivität aktivieren.

Dienst starten, der in einem Funktionsmodul definiert ist

Sie können Dienste, die in Funktionsmodulen definiert sind, mit startService() starten, nachdem Sie SplitCompat aktiviert haben.

Kotlin

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

Java

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

Komponente exportieren, die in einem Funktionsmodul definiert ist

Exportierte Android-Komponenten sollten nicht in optionalen Modulen enthalten sein.

Das Build-System führt Manifesteinträge für alle Module in das Basismodul zusammen. Wenn ein optionales Modul eine exportierte Komponente enthält, ist diese auch vor der Installation des Moduls zugänglich. Wenn sie von einer anderen App aufgerufen wird, kann dies zu einem Absturz aufgrund von fehlendem Code führen.

Bei internen Komponenten ist das kein Problem, da nur die App auf sie zugreift. Die App kann also prüfen, ob das Modul installiert ist, bevor sie auf die Komponente zugreift.

Wenn Sie eine exportierte Komponente benötigen und deren Inhalt in einem optionalen Modul sein soll, sollten Sie ein Proxy-Muster implementieren. Dazu können Sie eine exportierte Proxykomponente in die Basis einfügen. Beim Zugriff kann die Proxykomponente prüfen, ob das Modul mit den Inhalten vorhanden ist. Wenn das Modul vorhanden ist, kann die Proxykomponente die interne Komponente aus dem Modul über einen Intent starten und den Intent von der aufrufenden App weiterleiten. Wenn das Modul nicht vorhanden ist, kann die Komponente das Modul herunterladen oder eine entsprechende Fehlermeldung an die aufrufende App zurückgeben.

Auf Code und Ressourcen aus installierten Modulen zugreifen

Wenn Sie SplitCompat für den Basis-App-Kontext und die Aktivitäten in Ihrem Funktionsmodul aktivieren, können Sie den Code und die Ressourcen eines Funktionsmoduls verwenden, als wäre es Teil des Basis-APKs, sobald das optionale Modul installiert ist.

Auf Code aus einem anderen Modul zugreifen

Über ein Modul auf den Basiscode zugreifen

Code, der sich in Ihrem Basismodul befindet, kann direkt von anderen Modulen verwendet werden. Sie müssen nichts Besonderes tun. Importieren Sie einfach die benötigten Klassen und verwenden Sie sie.

Von einem anderen Modul aus auf Modulcode zugreifen

Auf ein Objekt oder eine Klasse in einem Modul kann nicht statisch direkt von einem anderen Modul aus zugegriffen werden, aber indirekt über die Reflektion.

Sie sollten darauf achten, wie oft dies geschieht, da die Leistungskosten der Reflektion hoch sein können. Verwenden Sie für komplexe Anwendungsfälle Frameworks für die Abhängigkeitsinjektion wie Dagger 2, um sicherzustellen, dass pro Anwendungslebenszyklus nur ein Reflexionsaufruf erfolgt.

Um die Interaktionen mit dem Objekt nach der Instanziierung zu vereinfachen, empfiehlt es sich, eine Schnittstelle im Basismodul und ihre Implementierung im Featuremodul zu definieren. Beispiel:

Kotlin

// 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();

Java

// 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();

Auf Ressourcen und Assets aus einem anderen Modul zugreifen

Nach der Installation eines Moduls können Sie auf Ressourcen und Assets im Modul auf die übliche Weise zugreifen. Es gibt jedoch zwei Einschränkungen:

  • Wenn Sie von einem anderen Modul aus auf eine Ressource zugreifen, hat das Modul keinen Zugriff auf die Ressourcen-ID. Auf die Ressource kann aber weiterhin über den Namen zugegriffen werden. Das Paket, das zum Verweisen auf die Ressource verwendet wird, ist das Paket des Moduls, in dem die Ressource definiert ist.
  • Wenn Sie von einem anderen installierten Modul Ihrer App aus auf Assets oder Ressourcen zugreifen möchten, die in einem neu installierten Modul vorhanden sind, müssen Sie dies über den Anwendungskontext tun. Der Kontext der Komponente, die auf die Ressourcen zugreifen möchte, wird noch nicht aktualisiert. Alternativ können Sie die Komponente neu erstellen (z. B. durch Aufrufen von Activity.recreate()) oder SplitCompat neu installieren, nachdem das Funktionsmodul installiert wurde.

Nativen Code in einer App mit On-Demand-Bereitstellung laden

Wir empfehlen, ReLinker zu verwenden, um alle Ihre nativen Bibliotheken zu laden, wenn Sie die On-Demand-Bereitstellung von Funktionsmodulen nutzen. ReLinker behebt ein Problem beim Laden nativer Bibliotheken nach der Installation eines Funktionsmoduls. Weitere Informationen zu ReLinker finden Sie unter Android JNI Tips.

Nativen Code aus einem optionalen Modul laden

Nachdem ein Split installiert wurde, empfehlen wir, den zugehörigen nativen Code über ReLinker zu laden. Für Instant-Apps sollten Sie diese spezielle Methode verwenden.

Wenn Sie System.loadLibrary() verwenden, um Ihren nativen Code zu laden, und Ihre native Bibliothek eine Abhängigkeit von einer anderen Bibliothek im Modul hat, müssen Sie diese andere Bibliothek zuerst manuell laden. Wenn Sie ReLinker verwenden, ist der entsprechende Vorgang Relinker.recursively().loadLibrary().

Wenn Sie dlopen() in nativem Code verwenden, um eine Bibliothek zu laden, die in einem optionalen Modul definiert ist, funktioniert dies nicht mit relativen Bibliothekspfaden. Die beste Lösung besteht darin, den absoluten Pfad der Bibliothek über ClassLoader.findLibrary() aus dem Java-Code abzurufen und dann in Ihrem dlopen()-Aufruf zu verwenden. Führen Sie dies aus, bevor Sie den nativen Code eingeben, oder verwenden Sie einen JNI-Aufruf von Ihrem nativen Code in Java.

Auf installierte Android Instant Apps zugreifen

Wenn ein Android-Instant App-Modul als INSTALLED gemeldet wird, können Sie mit einem aktualisierten App-Kontext auf den Code und die Ressourcen zugreifen. Ein Kontext, der von Ihrer App vor der Installation eines Moduls erstellt wird (z. B. einer, der bereits in einer Variablen gespeichert ist), enthält nicht den Inhalt des neuen Moduls. Ein neuer Kontext ist jedoch möglich. Er kann beispielsweise mit createPackageContext abgerufen werden.

Kotlin

// 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
            }
        }
    }
}

Java

// 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();
        }
    }
}

Android-Sofort-Apps unter Android 8.0 und höher

Wenn Sie ein On-Demand-Modul für eine Android-Sofort-App unter Android 8.0 (API-Level 26) und höher anfordern, müssen Sie die App nach dem Melden einer Installationsanfrage als INSTALLED mit dem Kontext des neuen Moduls aktualisieren. Dazu rufen Sie SplitInstallHelper.updateAppInfo(Context context) auf. Andernfalls sind der App der Code und die Ressourcen des Moduls noch nicht bekannt. Nachdem Sie die Metadaten der App aktualisiert haben, sollten Sie den Inhalt des Moduls während des nächsten Hauptthread-Ereignisses laden, indem Sie ein neues Handler aufrufen, wie unten gezeigt:

Kotlin

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
                        ...
                    }
                }
            }
        }
    }
}

Java

@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();
                        ...
                    }
                });
            }
        }
    }
}

C/C++-Bibliotheken laden

Wenn Sie C/C++-Bibliotheken aus einem Modul laden möchten, das das Gerät bereits in einer Sofort-App heruntergeladen hat, verwenden Sie SplitInstallHelper.loadLibrary(Context context, String libName), wie unten gezeigt:

Kotlin

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)
                ...
            }
        }
    }
}

Java

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);
                ...
        }
    }
}

Bekannte Einschränkungen

  • Es ist nicht möglich, Android WebView in einer Aktivität zu verwenden, die auf Ressourcen oder Assets aus einem optionalen Modul zugreift. Dies liegt an einer Inkompatibilität zwischen WebView und SplitCompat auf Android-API-Level 28 und niedriger.
  • Sie dürfen Android-ApplicationInfo-Objekte, deren Inhalte oder Objekte, die sie enthalten, nicht in Ihrer App zwischenspeichern. Sie sollten diese Objekte immer bei Bedarf aus einem App-Kontext abrufen. Das Zwischenspeichern solcher Objekte kann dazu führen, dass die App beim Installieren eines Funktionsmoduls abstürzt.

Installierte Module verwalten

Wenn Sie prüfen möchten, welche Funktionsmodule derzeit auf dem Gerät installiert sind, können Sie SplitInstallManager.getInstalledModules() aufrufen. Dadurch wird ein Set<String> mit den Namen der installierten Module zurückgegeben, wie unten dargestellt.

Kotlin

val installedModules: Set<String> = splitInstallManager.installedModules

Java

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

Module deinstallieren

Sie können das Gerät auffordern, Module zu deinstallieren, indem Sie SplitInstallManager.deferredUninstall(List<String> moduleNames) aufrufen, wie unten gezeigt.

Kotlin

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

Java

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

Die Deinstallation von Modulen erfolgt nicht sofort. Das Gerät deinstalliert sie also bei Bedarf im Hintergrund, um Speicherplatz zu sparen. Sie können bestätigen, dass das Gerät ein Modul gelöscht hat, indem Sie SplitInstallManager.getInstalledModules() aufrufen und das Ergebnis wie im vorherigen Abschnitt beschrieben prüfen.

Zusätzliche Sprachressourcen herunterladen

Mit App-Bundles werden auf Geräten nur der Code und die Ressourcen heruntergeladen, die zum Ausführen Ihrer App erforderlich sind. Bei Sprachressourcen werden auf dem Gerät eines Nutzers also nur die Sprachressourcen Ihrer App heruntergeladen, die der oder den in den Geräteeinstellungen ausgewählten Sprache(n) entsprechen.

Wenn Ihre App auf zusätzliche Sprachressourcen zugreifen soll, z. B. um eine In-App-Sprachauswahl zu implementieren, können Sie diese mit der Play Feature Delivery Library bei Bedarf herunterladen. Der Prozess ähnelt dem Herunterladen eines Funktionsmoduls, wie unten dargestellt.

Kotlin

// 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)

Java

// 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);

Die Anfrage wird so behandelt, als wäre es eine Anfrage für ein Funktionsmodul. Das heißt, Sie können den Anfragestatus wie gewohnt überwachen.

Wenn Ihre App die zusätzlichen Sprachressourcen nicht sofort benötigt, können Sie die Installation auf einen Zeitpunkt verschieben, an dem die App im Hintergrund ausgeführt wird, wie unten gezeigt.

Kotlin

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

Java

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

Auf heruntergeladene Sprachressourcen zugreifen

Damit Ihre App auf heruntergeladene Sprachressourcen zugreifen kann, muss sie die Methode SplitCompat.installActivity() in der Methode attachBaseContext() jeder Aktivität ausführen, die Zugriff auf diese Ressourcen benötigt, wie unten gezeigt.

Kotlin

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

Java

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

Aktualisieren Sie für jede Aktivität, für die Sie Sprachressourcen verwenden möchten, die Ihre App heruntergeladen hat, den Basis-Context und legen Sie ein neues Gebietsschema über das Configuration fest:

Kotlin

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)
}

Java

@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);
}

Damit diese Änderungen wirksam werden, müssen Sie Ihre Aktivität neu erstellen, nachdem die neue Sprache installiert und einsatzbereit ist. Dazu können Sie die Methode Activity#recreate() verwenden.

Kotlin

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

Java

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

Zusätzliche Sprachressourcen deinstallieren

Ähnlich wie bei Funktionsmodulen können Sie zusätzliche Ressourcen jederzeit deinstallieren. Bevor Sie eine Deinstallation beantragen, sollten Sie zuerst feststellen, welche Sprachen derzeit installiert sind. Gehen Sie dazu so vor:

Kotlin

val installedLanguages: Set<String> = splitInstallManager.installedLanguages

Java

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

Anschließend können Sie mit der Methode deferredLanguageUninstall() entscheiden, welche Sprachen deinstalliert werden sollen.

Kotlin

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

Java

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

Modulinstallationen lokal testen

Mit der Play Feature Delivery Library können Sie lokal testen, ob Ihre App Folgendes ausführen kann, ohne eine Verbindung zum Play Store herzustellen:

Auf dieser Seite wird beschrieben, wie Sie die Split-APKs Ihrer App auf Ihrem Testgerät bereitstellen, damit Play Feature Delivery diese APKs automatisch verwendet, um das Anfordern, Herunterladen und Installieren von Modulen aus dem Play Store zu simulieren.

Sie müssen zwar keine Änderungen an der Logik Ihrer App vornehmen, aber die folgenden Anforderungen erfüllen:

  • Laden Sie die aktuelle Version von bundletool herunter und installieren Sie sie. Sie benötigen bundletool, um aus dem App-Bundle Ihrer App eine neue Reihe installierbarer APKs zu erstellen.

Mehrere APKs erstellen

Erstellen Sie die Split-APKs Ihrer App, falls noch nicht geschehen:

  1. Erstellen Sie ein App-Bundle für Ihre App mit einer der folgenden Methoden:
  2. Verwenden Sie bundletool, um mit dem folgenden Befehl eine Reihe von APKs für alle Gerätekonfigurationen zu generieren:

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

Das Flag --local-testing enthält Metadaten in den Manifesten Ihrer APKs, die der Play Feature Delivery Library mitteilen, dass die lokalen Split-APKs zum Testen der Installation von Funktionsmodulen verwendet werden sollen, ohne dass eine Verbindung zum Play Store hergestellt wird.

App auf dem Gerät bereitstellen

Nachdem Sie mit dem Flag --local-testing eine Reihe von APKs erstellt haben, können Sie mit bundletool die Basisversion Ihrer App installieren und zusätzliche APKs in den lokalen Speicher Ihres Geräts übertragen. Sie können beide Aktionen mit dem folgenden Befehl ausführen:

bundletool install-apks --apks my_app.apks

Wenn Sie Ihre App starten und den Nutzerfluss zum Herunterladen und Installieren eines Funktionsmoduls durchlaufen, verwendet die Play Feature Delivery Library die APKs, die bundletool in den lokalen Speicher des Geräts übertragen hat.

Netzwerkfehler simulieren

Um die Installation von Modulen aus dem Play Store zu simulieren, verwendet die Play Feature Delivery Library anstelle von SplitInstallManager die Alternative FakeSplitInstallManager, um das Modul anzufordern. Wenn Sie bundletool mit dem Flag --local-testing verwenden, um eine Reihe von APKs zu erstellen und auf Ihrem Testgerät bereitzustellen, sind Metadaten enthalten, die die Play Feature Delivery Library anweisen, die API-Aufrufe Ihrer App automatisch so umzuschalten, dass FakeSplitInstallManager anstelle von SplitInstallManager aufgerufen wird.

FakeSplitInstallManager enthält ein boolesches Flag, das Sie aktivieren können, um einen Netzwerkfehler zu simulieren, wenn Ihre App das nächste Mal die Installation eines Moduls anfordert. Wenn Sie in Ihren Tests auf FakeSplitInstallManager zugreifen möchten, können Sie eine Instanz davon mit FakeSplitInstallManagerFactory abrufen, wie unten gezeigt:

Kotlin

// 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)

Java

// 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);