Konfigurowanie wyświetlania na żądanie

Moduły funkcji umożliwiają oddzielenie niektórych funkcji i zasobów od modułu podstawowego aplikacji i uwzględnienie ich w pakiecie aplikacji. Dzięki funkcji dostarczania funkcji z Google Play użytkownicy mogą np. później pobrać i zainstalować te komponenty na żądanie po zainstalowaniu podstawowego pliku APK aplikacji.

Weźmy na przykład aplikację do wysyłania SMS-ów, która zawiera funkcję robienia i wysyłania wiadomości z obrazem, ale tylko niewielki odsetek użytkowników wysyła takie wiadomości. Możesz dodać funkcję przesyłania wiadomości z obrazami jako pobierany moduł funkcji. Dzięki temu początkowe pobranie aplikacji jest mniejsze dla wszystkich użytkowników, a tylko użytkownicy, którzy wysyłają wiadomości z obrazami, muszą pobrać ten dodatkowy komponent.

Pamiętaj, że ten typ modułowości wymaga więcej pracy i możliwego przebudowania dotychczasowego kodu aplikacji. Dlatego dokładnie zastanów się, które z funkcji aplikacji najlepiej sprawdzą się w ramach funkcji na żądanie. Aby lepiej zrozumieć optymalne przypadki użycia i wytyczne dotyczące funkcji na żądanie, przeczytaj sprawdzone metody dotyczące wygody użytkownika w przypadku funkcji na żądanie.

Jeśli chcesz stopniowo modułować funkcje aplikacji z upływem czasu, bez włączania zaawansowanych opcji przesyłania, takich jak przesyłanie na żądanie, skonfiguruj przesyłanie w momencie instalacji.

Na tej stronie możesz dodać moduł funkcji do projektu aplikacji i skonfigurować go do dostarczania na żądanie. Zanim zaczniesz, upewnij się, że używasz Android Studio 3.5 lub nowszej wersji oraz wtyczki Android Gradle 3.5.0 lub nowszej.

Konfigurowanie nowego modułu do dostarczania na żądanie

Najłatwiej utworzyć nowy moduł funkcji za pomocą Android Studio 3.5 lub nowszej wersji. Ponieważ moduły funkcji są nieodłącznie zależne od modułu aplikacji podstawowej, możesz je dodawać tylko do istniejących projektów aplikacji.

Aby dodać moduł funkcji do projektu aplikacji za pomocą Android Studio:

1. Jeśli jeszcze tego nie zrobiono, otwórz projekt aplikacji w IDE.
2. Na pasku menu wybierz Plik > Nowy > Nowy moduł.
3. W oknie Create New Module (Utwórz nowy moduł) wybierz Dynamic Feature Module (Moduł dynamicznych funkcji) i kliknij Next (Dalej).
4. W sekcji Skonfiguruj nowy moduł wykonaj te czynności:
   1. W menu wybierz Moduł podstawowej aplikacji dla projektu aplikacji.
   2. Podaj nazwę modułu. IDE używa tej nazwy do identyfikowania modułu jako podprojektu Gradle w pliku ustawień Gradle. Podczas kompilowania pakietu aplikacji Gradle używa ostatniego elementu nazwy podprojektu, aby wstrzyknąć atrybut <manifest split> do pliku manifestu modułu funkcji.
   3. Podaj nazwę pakietu modułu. Domyślnie Android Studio sugeruje nazwę pakietu, która łączy nazwę pakietu katalogu głównego modułu bazy i nazwę modułu określoną w poprzednim kroku.
   4. Wybierz minimalny poziom interfejsu API, który ma obsługiwać moduł. Ta wartość powinna być taka sama jak w module podstawowym.
5. Kliknij Dalej.

6. W sekcji Opcje pobierania modułu wykonaj te czynności:

   1. Podaj Tytuł modułu, który może mieć maksymalnie 50 znaków. Platforma używa tego tytułu, aby identyfikować moduł dla użytkowników, na przykład w celu potwierdzenia, czy użytkownik chce go pobrać. Z tego powodu moduł podstawowy aplikacji musi zawierać tytuł modułu jako zasób ciągu tekstowego, który możesz przetłumaczyć. Podczas tworzenia modułu w Android Studio IDE automatycznie dodaje do modułu podstawowego zasób ciągu znaków i wstrzykuje do pliku manifestu modułu funkcji następujący wpis:

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

   2. W menu Uwzględnienie w czasie instalacji wybierz Nie uwzględniaj modułu w czasie instalacji. Android Studio wstrzykuje do pliku manifestu modułu następujące informacje:

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

   3. Zaznacz pole obok opcji Fusing, jeśli chcesz, aby ten moduł był dostępny na urządzeniach z Androidem 4.4 (poziom interfejsu API 20) lub starszym i włączony w wiele pliki APK. Oznacza to, że możesz włączyć działanie tego modułu na żądanie i wyłączyć łączenie, aby pominąć go na urządzeniach, które nie obsługują pobierania i instalowania podzielonych plików APK. Android Studio wstrzykuje do pliku manifestu modułu następujące informacje:

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

7. Kliknij Zakończ.

Gdy Android Studio utworzy moduł, sprawdź jego zawartość w panelu Projekt (na pasku menu kliknij Widok > Okna narzędzia > Projekt). Domyślny kod, zasoby i organizacja powinny być podobne do tych w standardowym module aplikacji.

Następnie musisz zaimplementować funkcję instalacji na żądanie za pomocą biblioteki Play Feature Delivery.

Dodawanie biblioteki Play Feature Delivery do projektu

Zanim zaczniesz, musisz najpierw dodać do projektu Bibliotekę funkcji Google Play.

Prośba o moduł na żądanie

Gdy aplikacja potrzebuje użyć modułu funkcji, może poprosić o jego uruchomienie, gdy jest na pierwszym planie, za pomocą klasy SplitInstallManager. Podczas wysyłania żądania aplikacja musi podać nazwę modułu zgodnie z definicją elementu split w pliku manifestu modułu docelowego. Gdy tworzysz moduł funkcji za pomocą Android Studio, system kompilacji używa podanej przez Ciebie nazwy modułu, aby w momencie kompilacji wstrzyknąć tę właściwość do pliku manifestu modułu. Więcej informacji znajdziesz w pliku manifestu modułu funkcji.

Wyobraź sobie na przykład aplikację, która ma moduł na żądanie do robienia i wysyłania wiadomości obrazkowych za pomocą aparatu urządzenia. Moduł ten określa w swoim pliku manifestu wartość split="pictureMessages". W tym przykładzie SplitInstallManager jest używany do wysyłania żądania do modułu pictureMessages (oraz dodatkowego modułu do niektórych filtrów promocyjnych):

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

Gdy aplikacja żąda modułu na żądanie, biblioteka Play Feature Delivery stosuje strategię „wypal i zapomnij”. Oznacza to, że wysyła żądanie pobrania modułu do platformy, ale nie sprawdza, czy instalacja się powiodła. Aby kontynuować proces użytkownika po instalacji lub odpowiednio obsługiwać błędy, monitoruj stan żądania.

Uwaga: możesz poprosić o moduł funkcji, który jest już zainstalowany na urządzeniu. Jeśli wykryje, że moduł jest już zainstalowany, interfejs API natychmiast uzna żądanie za zrealizowane. Dodatkowo po zainstalowaniu modułu Google Play automatycznie aktualizuje go. Oznacza to, że gdy prześlesz nową wersję pakietu aplikacji, platforma zaktualizuje wszystkie zainstalowane pliki APK należące do Twojej aplikacji. Więcej informacji znajdziesz w artykule Zarządzanie aktualizacjami aplikacji.

Aby mieć dostęp do kodu i zasobów modułu, aplikacja musi włączać SplitCompat. Pamiętaj, że w przypadku aplikacji błyskawicznych na Androida nie jest wymagane użycie interfejsu SplitCompat.

Opóźnianie instalacji modułów na żądanie

Jeśli nie chcesz, aby aplikacja natychmiast pobierała i instalowała moduł na żądanie, możesz odroczyć instalację na czas, gdy aplikacja działa w tle. Możesz to zrobić na przykład, jeśli chcesz wstępnie załadować materiały promocyjne na potrzeby późniejszego uruchomienia aplikacji.

Aby określić moduł do pobrania później, użyj metody deferredInstall(), jak pokazano poniżej. W odróżnieniu od SplitInstallManager.startInstall() aplikacja nie musi być na pierwszym planie, aby zainicjować żądanie opóźnionej instalacji.

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

Prośby o odroczone instalacje są realizowane zgodnie z zasadą możliwie najlepszej obsługi i nie można śledzić ich postępów. Dlatego zanim spróbujesz uzyskać dostęp do modułu, który został przez Ciebie oznaczony jako opóźniony, sprawdź, czy moduł został zainstalowany. Jeśli chcesz, aby moduł był dostępny od razu, poproś o niego, używając właściwości SplitInstallManager.startInstall(), jak pokazano w poprzedniej sekcji.

Sprawdzanie stanu prośby

Aby móc aktualizować pasek postępu, wywołać intencję po instalacji lub prawidłowo obsłużyć błąd żądania, musisz nasłuchiwać aktualizacji stanu z niesynchronizowanego zadania SplitInstallManager.startInstall(). Zanim zaczniesz otrzymywać aktualizacje dotyczące żądania instalacji, zarejestruj odbiorczy i uzyskaj identyfikator sesji dla żądania, jak pokazano poniżej.

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

Obsługa błędów żądań

Pamiętaj, że instalacja modułów funkcji na żądanie może czasami się nie udać, podobnie jak instalacja aplikacji. Niemożność zainstalowania może być spowodowana problemami takimi jak za mało miejsca na urządzeniu, brak połączenia z internetem lub brak zalogowania się użytkownika w Sklepie Google Play. Aby dowiedzieć się, jak łagodnie rozwiązywać takie sytuacje z perspektywy użytkownika, zapoznaj się z wskazówkami dotyczącymi interfejsu użytkownika w przypadku dostawy na żądanie.

W kodzie należy obsłużyć błędy pobierania lub instalowania modułu za pomocą addOnFailureListener(), jak pokazano poniżej:

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

Tabela poniżej opisuje stany błędów, które aplikacja może musieć obsłużyć:

Jeśli użytkownik poprosi o pobieranie modułu na żądanie i wystąpi błąd, rozważ wyświetlenie okna dialogowego z 2 opcjami: Spróbuj ponownie (który ponownie próbuje wysłać żądanie) i Anuluj (który anuluje żądanie). Aby uzyskać dodatkową pomoc, możesz też podać link do Centrum pomocy, który przekieruje użytkowników do Centrum pomocy Google Play.

Obsługa aktualizacji stanu

Po zarejestrowaniu listenera i zarejestrowaniu identyfikatora sesji dla żądania użyj funkcji StateUpdatedListener.onStateUpdate() do obsługi zmian stanu, jak pokazano poniżej.

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

Możliwe stany żądania instalacji opisaliśmy w tabeli poniżej.

Uzyskiwanie potwierdzenia użytkownika

W niektórych przypadkach Google Play może wymagać potwierdzenia przez użytkownika przed spełnieniem prośby o pobieranie. Może się tak zdarzyć, jeśli aplikacja nie została zainstalowana przez Google Play lub jeśli próbujesz pobrać duże pliki za pomocą danych mobilnych. W takich przypadkach stan żądania to REQUIRES_USER_CONFIRMATION, a Twoja aplikacja musi uzyskać potwierdzenie użytkownika, zanim urządzenie będzie mogło pobrać i zainstalować moduły z żądania. Aby uzyskać potwierdzenie, aplikacja powinna wyświetlić użytkownikowi takie prompty:

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

Możesz zarejestrować inicjator wyników aktywności, korzystając z wbudowanego kontraktu ActivityResultContracts.StartIntentSenderForResult. Zobacz interfejsy ActivityResult API.

Stan prośby jest aktualizowany w zależności od odpowiedzi użytkownika:

• Jeśli użytkownik zaakceptuje potwierdzenie, stan prośby zmieni się na PENDING i rozpocznie się pobieranie.
• Jeśli użytkownik odrzuci potwierdzenie, stan prośby zmieni się na CANCELED.
• Jeśli użytkownik nie wybierze opcji przed zniszczeniem okna dialogowego, stan żądania pozostanie taki sam jak REQUIRES_USER_CONFIRMATION. Aplikacja może ponownie poprosić użytkownika o wykonanie żądania.

Aby otrzymać wywołanie zwrotne z odpowiedzią użytkownika, możesz zastąpić metodę ActivityResultCallback, jak pokazano poniżej.

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

Anulowanie prośby o instalację

Jeśli aplikacja musi anulować żądanie przed jego zainstalowaniem, może wywołać metodę cancelInstall(), korzystając z identyfikatora sesji żądania, jak pokazano poniżej.

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

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

Dostęp do modułów

Aby uzyskać dostęp do kodu i zasobów z pobranego modułu po jego pobraniu, aplikacja musi włączyć bibliotekę SplitCompat zarówno dla aplikacji, jak i każdej aktywności w modułach funkcji, które aplikacja pobiera.

Pamiętaj jednak, że po pobraniu modułu platforma ma przez pewien czas (w niektórych przypadkach przez kilka dni) te ograniczenia dostępu do treści modułu:

• Platforma nie może zastosować żadnych nowych wpisów w pliku manifestu wprowadzonych przez moduł.
• Platforma nie ma dostępu do zasobów modułu dla komponentów interfejsu użytkownika systemu, takich jak powiadomienia. Jeśli chcesz od razu używać takich zasobów, rozważ uwzględnienie ich w module podstawowym aplikacji.

Włączanie SplitCompat

Aby aplikacja miała dostęp do kodu i zasobów z pobranej biblioteki, musisz włączyć SplitCompat, korzystając z jednej z metod opisanych w poniższych sekcjach.

Po włączeniu SplitCompat w aplikacji musisz też włączyć SplitCompat dla każdej aktywności w modułach funkcji, do których aplikacja ma mieć dostęp.

Zadeklaruj SplitCompatApplication w pliku manifestu

Najprostszym sposobem włączenia obsługi SplitCompat jest zadeklarowanie SplitCompatApplication jako podklasy Application w pliku manifestu aplikacji, jak pokazano poniżej:

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

Po zainstalowaniu aplikacji na urządzeniu możesz automatycznie uzyskać dostęp do kodu i zasobów z pobranej aplikacji.

Wywoływanie interfejsu SplitCompat w czasie wykonywania

Możesz też włączyć SplitCompat w określonych czynnościach lub usługach w czasie działania. Włączenie tej opcji w ten sposób jest wymagane do uruchamiania działań zawartych w modułach funkcji. Aby to zrobić, zastąpij attachBaseContext wartością widoczną poniżej.

Jeśli masz niestandardową klasę Application, zamiast niej rozszerz klasę SplitCompatApplication, aby umożliwić korzystanie z SplitCompat w aplikacji, jak pokazano poniżej:

class MyApplication : SplitCompatApplication() {
    ...
}

public class MyApplication extends SplitCompatApplication {
    ...
}

SplitCompatApplication po prostu zastępuje ContextWrapper.attachBaseContext(), aby uwzględnić SplitCompat.install(Context applicationContext). Jeśli nie chcesz, aby klasa Application rozszerzała się do SplitCompatApplication, możesz ręcznie zastąpić metodę attachBaseContext() w ten sposób:

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

Jeśli moduł na żądanie jest zgodny zarówno z aplikacjami błyskawicznymi, jak i z zainstalowanymi aplikacjami, możesz wywołać SplitCompat warunkowo w ten sposób:

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

Włączanie SplitCompat dla działań modułu

Po włączeniu obsługi SplitCompat w aplikacji podstawowej musisz włączyć obsługę SplitCompat dla każdej aktywności, którą aplikacja pobiera w module funkcji. Aby to zrobić, użyj metody SplitCompat.installActivity() w ten sposób:

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

Dostęp do komponentów zdefiniowanych w modułach funkcji

Rozpoczynanie aktywności zdefiniowanej w module funkcji

Po włączeniu SplitCompat możesz uruchamiać czynności zdefiniowane w modułach funkcji za pomocą funkcji startActivity().

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

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

Pierwszy parametr funkcji setClassName to nazwa pakietu aplikacji, a drugi to pełna nazwa klasy działania.

Jeśli w ramach modułu funkcji, który został pobrany na żądanie, masz działanie, musisz w nim włączyć SplitCompat.

Uruchamianie usługi zdefiniowanej w module funkcji

Po włączeniu SplitCompat możesz uruchamiać usługi zdefiniowane w modułach funkcji za pomocą funkcji startService().

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

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

Eksportowanie komponentu zdefiniowanego w module funkcji

Nie należy umieszczać w modułach opcjonalnych komponentów wyeksportowanych z Androida.

System kompilacji scala wpisy w pliku manifestu dla wszystkich modułów z modułem podstawowym. Jeśli opcjonalny moduł zawierałby wyeksportowany komponent, byłby on dostępny nawet przed zainstalowaniem modułu i mógłby spowodować awarię z powodu braku kodu, gdy zostanie wywołany z innej aplikacji.

W przypadku komponentów wewnętrznych nie ma to znaczenia, ponieważ są one dostępne tylko dla aplikacji, która może sprawdzić, czy moduł jest zainstalowany, zanim uzyska dostęp do komponentu.

Jeśli potrzebujesz wyeksportowanego komponentu i chcesz, aby jego zawartość znajdowała się w opcjonalnym module, rozważ zaimplementowanie wzorca proxy. Możesz to zrobić, dodając do bazy komponent zastępczy wyeksportowany z podstawy. Po uzyskaniu dostępu komponent zastępczy może sprawdzić, czy istnieje moduł zawierający treści. Jeśli moduł jest obecny, komponent pośredniczący może uruchomić komponent wewnętrzny z modułu za pomocą Intent, przekazując intencję z aplikacji wywołującej. Jeśli moduł nie jest obecny, komponent może go pobrać lub zwrócić odpowiedni komunikat o błędzie do aplikacji wywołującej.

dostęp do kodu i zasobów z zainstalowanych modułów,

Jeśli włączysz SplitCompat w kontekście podstawowej aplikacji i aktywności w module funkcji, po zainstalowaniu opcjonalnego modułu możesz używać kodu i zasobów z modułu funkcji tak, jakby były częścią podstawowego pliku APK.

Kod dostępu z innego modułu

Dostęp do kodu podstawowego z modułu

Kod znajdujący się w module podstawowym może być używany bezpośrednio przez inne moduły. Nie musisz robić nic specjalnego. Wystarczy zaimportować potrzebne klasy i z nich korzystać.

Dostęp do kodu modułu z innego modułu

Obiekt lub klasa w module nie mogą być dostępne statycznie z innego modułu, ale można uzyskać do nich dostęp pośrednio, korzystając z odzwierciedlenia.

Pamiętaj, że ze względu na koszty związane z odbiciem światła należy zwracać uwagę na to, jak często to się zdarza. W skomplikowanych przypadkach użyj frameworków do wstrzykiwania zależności, takich jak Dagger 2, aby zagwarantować pojedynczy wywołanie odblasku na czas życia aplikacji.

Aby uprościć interakcje z obiektem po jego instancjowaniu, zalecamy zdefiniowanie interfejsu w module podstawowym, a jego implementację w module funkcji. Na przykład:

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

Dostęp do zasobów i komponentów z innego modułu

Po zainstalowaniu modułu możesz uzyskać dostęp do zasobów i komponentów w module w standardowy sposób, z dwoma wyjątkami:

• Jeśli uzyskujesz dostęp do zasobu z innego modułu, moduł nie będzie mieć dostępu do identyfikatora zasobu, ale zasób będzie nadal dostępny według nazwy. Pamiętaj, że pakiet, którego należy użyć do odwołania się do zasobu, to pakiet modułu, w którym zdefiniowano zasób.
• Jeśli chcesz uzyskać dostęp do zasobów znajdujących się w nowo zainstalowanym module z innego zainstalowanego modułu aplikacji, musisz to zrobić za pomocą kontekstu aplikacji. Kontekst komponentu, który próbuje uzyskać dostęp do zasobów, nie zostanie jeszcze zaktualizowany. Możesz też ponownie utworzyć ten komponent (np. wywołując metodę Activity.recreate()) lub ponownie zainstalować SplitCompat po zainstalowaniu modułu funkcji.

Ładowanie kodu natywnego w aplikacji za pomocą dostawy na żądanie

Zalecamy używanie ReLinkera do ładowania wszystkich natywnych bibliotek podczas dostarczania modułów funkcji na żądanie. ReLinker rozwiązuje problem z wczytywaniem bibliotek natywnych po zainstalowaniu modułu funkcji. Więcej informacji o ReLinker znajdziesz w artykule Wskazówki dotyczące JNI na Androidzie.

Wczytywanie kodu natywnego z opcjonalnego modułu

Po zainstalowaniu podziału zalecamy załadowanie jego kodu natywnego za pomocą ReLinkera. W przypadku aplikacji błyskawicznych należy użyć tej specjalnej metody.

Jeśli używasz funkcji System.loadLibrary() do wczytania kodu natywnego, a biblioteka natywnych ma zależność od innej biblioteki w module, musisz najpierw wczytać tę inną bibliotekę ręcznie. Jeśli używasz ReLinkera, odpowiednią operacją jest Relinker.recursively().loadLibrary().

Jeśli w kodzie natywnym używasz funkcji dlopen() do wczytywania biblioteki zdefiniowanej w opcjonalnym module, nie będzie ona działać z względnymi ścieżkami biblioteki. Najlepszym rozwiązaniem jest pobranie ścieżki bezwzględnej biblioteki z kodu Java za pomocą funkcji ClassLoader.findLibrary(), a potem użycie jej w wywołaniu dlopen(). Zrób to przed wpisaniem kodu natywnego lub użyciem wywołania JNI z Twojego kodu natywnego do kodu Java.

Dostęp do zainstalowanych aplikacji błyskawicznych na Androida

Gdy moduł aplikacji błyskawicznej na Androida zostanie zgłoszony jako INSTALLED, możesz uzyskać dostęp do jego kodu i zasobów za pomocą odświeżonego kontekstu aplikacji. Kontekst utworzony przez aplikację przed zainstalowaniem modułu (np. zapisany w zmiennej) nie zawiera treści nowego modułu. Nowy kontekst jest jednak potrzebny. Można go uzyskać, na przykład, za pomocą 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();
        }
    }
}

Aplikacje błyskawiczne na Androidzie w wersji 8.0 lub nowszej

Gdy żądasz przesłania modułu na żądanie do aplikacji błyskawicznej na Androida w wersji 8.0 (poziom interfejsu API 26) lub nowszej, po zgłoszeniu prośby o instalację (INSTALLED) musisz zaktualizować aplikację, dodając kontekst nowego modułu za pomocą wywołania SplitInstallHelper.updateAppInfo(Context context). W przeciwnym razie aplikacja nie ma jeszcze dostępu do kodu i zasobów modułu. Po zaktualizowaniu metadanych aplikacji załaduj zawartość modułu podczas następnego zdarzenia głównego wątku, wywołując nową funkcję Handler, jak pokazano poniżej:

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

Wczytywanie bibliotek C/C++

Jeśli chcesz wczytać biblioteki C/C++ z modułu, który został już pobrany na urządzenie w ramach aplikacji błyskawicznej, użyj funkcji SplitInstallHelper.loadLibrary(Context context, String libName), jak pokazano poniżej:

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

Znane ograniczenia

• Nie można używać interfejsu WebView w Androidzie w aktywności, która uzyskuje dostęp do zasobów lub zasobów komponentów z opcjonalnego modułu. Wynika to z niezgodności między WebView a SplitCompat w Androidzie na poziomie interfejsu API 28 lub niższym.
• Nie możesz zapisywać w pamięci podręcznej obiektów ApplicationInfo Androida, ich zawartości ani obiektów, które je zawierają, w aplikacji. Zawsze pobieraj te obiekty w miarę potrzeby z kontekstu aplikacji. Buforowanie takich obiektów może spowodować zawieszenie aplikacji podczas instalowania modułu funkcji.

Zarządzanie zainstalowanymi modułami

Aby sprawdzić, które moduły funkcji są obecnie zainstalowane na urządzeniu, możesz wywołać funkcję SplitInstallManager.getInstalledModules(), która zwraca Set<String> nazw zainstalowanych modułów, jak pokazano poniżej.

val installedModules: Set<String> = splitInstallManager.installedModules

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

Odinstaluj moduły

Aby poprosić urządzenie o odinstalowanie modułów, wywołaj SplitInstallManager.deferredUninstall(List<String> moduleNames), jak pokazano poniżej.

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

Odinstalowanie modułu nie następuje natychmiast. Oznacza to, że urządzenie odinstalowuje je w tle, gdy zajdzie taka potrzeba, aby zaoszczędzić miejsce na dane. Aby sprawdzić, czy urządzenie usunęło moduł, wywołaj go za pomocą polecenia SplitInstallManager.getInstalledModules() i sprawdź wynik w sposób opisany w poprzedniej sekcji.

Pobieranie dodatkowych zasobów językowych

W przypadku pakietów aplikacji urządzenia pobierają tylko kod i zasoby, których potrzebują do uruchomienia aplikacji. W przypadku zasobów językowych urządzenie użytkownika pobiera tylko te zasoby językowe aplikacji, które odpowiadają co najmniej jednemu językowi wybranemu w ustawieniach urządzenia.

Jeśli chcesz, aby Twoja aplikacja miała dostęp do dodatkowych zasobów językowych (np. do implementowania selektora języka), możesz pobrać je na żądanie z biblioteki funkcji Google Play. Proces jest podobny do pobierania modułu funkcji, jak pokazano poniżej.

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

Prośba jest obsługiwana tak, jakby była prośbą o moduł funkcji. Oznacza to, że możesz monitorować stan prośby tak jak zwykle.

Jeśli aplikacja nie wymaga natychmiastowego zainstalowania dodatkowych zasobów językowych, możesz odłożyć instalację na czas, gdy aplikacja działa w tle (patrz poniżej).

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

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

Dostęp do pobranych zasobów językowych

Aby uzyskać dostęp do pobranych zasobów językowych, aplikacja musi wywołać metodę SplitCompat.installActivity() w ramach metody attachBaseContext() każdej aktywności, która wymaga dostępu do tych zasobów, jak pokazano poniżej.

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

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

W przypadku każdej aktywności, w której chcesz używać zasobów językowych pobranych przez aplikację, zaktualizuj kontekst podstawowy i ustaw nowy język za pomocą funkcji 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);
}

Aby te zmiany zaczęły obowiązywać, musisz ponownie utworzyć aktywność po zainstalowaniu nowego języka i uruchomieniu go. Możesz użyć metody 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();
  ...
}

Odinstalowywanie dodatkowych zasobów językowych

Podobnie jak w przypadku modułów funkcji, dodatkowe zasoby możesz odinstalować w dowolnym momencie. Zanim poprosisz o odinstalowanie, możesz najpierw sprawdzić, które języki są obecnie zainstalowane.

val installedLanguages: Set<String> = splitInstallManager.installedLanguages

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

Następnie możesz zdecydować, które języki chcesz odinstalować, korzystając z metody deferredLanguageUninstall(), jak pokazano poniżej.

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

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

Testowanie lokalnie instalacji modułu

Biblioteka funkcji dostarczania w Google Play umożliwia testowanie lokalnie możliwości aplikacji w zakresie wykonywania tych czynności bez łączenia się ze Sklepem Play:

• Proś o instalację modułów i monitoruj ich instalację.
• Obsługa błędów instalacji.
• Użyj SplitCompat, aby otworzyć moduły.

Na tej stronie opisaliśmy, jak wdrożyć podzielone pliki APK aplikacji na urządzenie testowe, aby Play Feature Delivery automatycznie używało tych plików do symulowania żądania, pobierania i instalowania modułów ze Sklepu Play.

Chociaż nie musisz wprowadzać żadnych zmian w logice aplikacji, musisz spełnić te wymagania:

• Pobierz i zainstaluj najnowszą wersję aplikacji bundletool. Musisz użyć narzędzia bundletool, aby utworzyć nowy zestaw pakietów APK do zainstalowania z pakietu aplikacji.

Tworzenie zestawu plików APK

Jeśli jeszcze tego nie zrobiono, skompiluj podzielone pliki APK aplikacji w ten sposób:

1. Utwórz pakiet aplikacji za pomocą jednej z tych metod:
   • Użyj Android Studio i wtyczki Androida do obsługi Gradle, aby skompilować i podpisać pakiet Android App Bundle.
   • Utwórz pakiet aplikacji z poziomu wiersza poleceń.

2. Użyj narzędzia bundletool, aby wygenerować zestaw plików APK dla wszystkich konfiguracji urządzeń za pomocą tego polecenia:

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

Flaga --local-testing zawiera metadane w pliku manifestu pliku APK, które informują Bibliotekę Play Feature Delivery o tym, że należy użyć lokalnie podzielonych plików APK do testowania instalowania modułów funkcji bez łączenia się ze Sklepem Play.

Wdrażanie aplikacji na urządzeniu

Po utworzeniu zestawu plików APK za pomocą flagi --local-testing użyj opcji bundletool, aby zainstalować podstawową wersję aplikacji i przekazać dodatkowe pliki APK do pamięci lokalnej urządzenia. Możesz wykonać obie te czynności za pomocą tego polecenia:

bundletool install-apks --apks my_app.apks

Gdy teraz uruchomisz aplikację i ukończysz proces pobierania i instalowania modułu funkcji, Biblioteka funkcji w Google Play użyje plików APK, które bundletoolzostały przeniesione do pamięci lokalnej urządzenia.

Symulowanie błędu sieci

Aby symulować instalacje modułów ze Sklepu Play, biblioteka Play Feature Delivery używa alternatywy dla SplitInstallManager, zwanej FakeSplitInstallManager, do żądania modułu. Gdy użyjesz bundletool z flagą --local-testing, aby utworzyć zestaw plików APK i wdrożyć je na urządzeniu testowym, zawiera ona metadane, które instruują Bibliotekę funkcji Play do automatycznego przełączania wywołań interfejsu API aplikacji na wywołanie FakeSplitInstallManager zamiast SplitInstallManager.

FakeSplitInstallManager zawiera flagę logiczną, którą możesz włączyć, aby symulować błąd sieci następnym razem, gdy aplikacja poprosi o zainstalowanie modułu. Aby uzyskać dostęp do FakeSplitInstallManager w testach, możesz uzyskać jego instancję za pomocą funkcji FakeSplitInstallManagerFactory, jak pokazano poniżej:

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