Diese Seite wurde von der Cloud Translation API übersetzt.

API-Verfügbarkeit mit ModuleInstallClient sicherstellen

Wie in der Übersicht über Google Play-Dienste beschrieben Artikel, werden von Google Play-Diensten bereitgestellte SDKs durch Dienste auf dem Gerät unterstützt auf Google-zertifizierten Android-Geräten. Um Speicherplatz und Arbeitsspeicher im gesamte Geräteflotte, einige Dienste werden on demand installiert, wenn es klar ist dass ein bestimmtes Gerät die entsprechende Funktionalität benötigt. Beispiel: ML Kit bietet diese Option wenn Sie Modelle in Google Play-Diensten verwenden.

Meistens wird ein Dienst (oder „Modul“) heruntergeladen und die parallel zu einer Anwendung installiert werden, die sie erfordert, basierend auf einer Abhängigkeit im AndroidManifest.xml des SDK. Wenn Sie mehr Kontrolle haben möchten, installieren Sie APIs für das Modul bieten die Möglichkeit, die Modulverfügbarkeit explizit zu prüfen, Installation, Überwachung des Anfragestatus und Behandlung von Fehlern.

Führen Sie die folgenden Schritte aus, um die API-Verfügbarkeit mit ModuleInstallClient sicherzustellen. Beachten Sie, dass die folgenden Code-Snippets den Parameter TensorFlow Lite SDK (play-services-tflite-java) als Beispielbibliothek verwenden. Diese Schritte sind jedoch gilt für jede Bibliothek, die in OptionalModuleApi integriert ist. Dieses wird mit zusätzlichen Informationen aktualisiert, sobald weitere SDKs Unterstützung anbieten.

Hinweis

Führen Sie die Schritte in den folgenden Abschnitten aus, um Ihre App vorzubereiten.

Voraussetzungen für Apps

Achten Sie darauf, dass die Build-Datei Ihrer App die folgenden Werte enthält:

Ein minSdkVersion von 19 oder höher

Eigene App konfigurieren

Fügen Sie in der Datei settings.gradle der obersten Ebene Maven-Repository von Google und der Maven Central Repository innerhalb der Block dependencyResolutionManagement:
```
dependencyResolutionManagement {
    repositories {
        google()
        mavenCentral()
    }
}
```
Fügen Sie in der Gradle-Build-Datei Ihres Moduls (in der Regel app/build.gradle) den Parameter Abhängigkeiten der Google Play-Dienste für play-services-base und play-services-tflite-java:
```
dependencies {
  implementation 'com.google.android.gms:play-services-base:18.5.0'
  implementation 'com.google.android.gms:play-services-tflite-java:16.2.0-beta02'
}
```

Modulverfügbarkeit prüfen

Rufen Sie eine Instanz von ModuleInstallClient ab:

Kotlin

val moduleInstallClient = ModuleInstall.getClient(context)

Java

ModuleInstallClient moduleInstallClient = ModuleInstall.getClient(context);

Prüfen Sie die Verfügbarkeit eines optionalen Moduls mithilfe der zugehörigen OptionalModuleApi:

Kotlin

val optionalModuleApi = TfLite.getClient(context)
moduleInstallClient
  .areModulesAvailable(optionalModuleApi)
  .addOnSuccessListener {
    if (it.areModulesAvailable()) {
      // Modules are present on the device...
    } else {
      // Modules are not present on the device...
    }
  }
  .addOnFailureListener {
    // Handle failure...
  }

Java

OptionalModuleApi optionalModuleApi = TfLite.getClient(context);
moduleInstallClient
    .areModulesAvailable(optionalModuleApi)
    .addOnSuccessListener(
        response -> {
          if (response.areModulesAvailable()) {
            // Modules are present on the device...
          } else {
            // Modules are not present on the device...
          }
        })
    .addOnFailureListener(
        e -> {
          // Handle failure…
        });

Anfrage für verzögerte Installation senden

Rufen Sie eine Instanz von ModuleInstallClient ab:

Kotlin

val moduleInstallClient = ModuleInstall.getClient(context)

Java

ModuleInstallClient moduleInstallClient = ModuleInstall.getClient(context);

Senden Sie die ausgesetzte Anfrage:

Kotlin

val optionalModuleApi = TfLite.getClient(context)
moduleInstallClient.deferredInstall(optionalModuleApi)

Java

OptionalModuleApi optionalModuleApi = TfLite.getClient(context);
moduleInstallClient.deferredInstall(optionalModuleApi);

Dringende Anfrage zur Modulinstallation senden

Rufen Sie eine Instanz von ModuleInstallClient ab:

Kotlin

val moduleInstallClient = ModuleInstall.getClient(context)

Java

ModuleInstallClient moduleInstallClient = ModuleInstall.getClient(context);

(Optional) InstallStatusListener für den Installationsstatus erstellen Aktualisierungen.

Wenn Sie den Download-Fortschritt in einer benutzerdefinierten Benutzeroberfläche (für wie eine Fortschrittsanzeige, können Sie eine InstallStatusListener erstellen, um um Updates zum Installationsstatus zu erhalten.

Kotlin

inner class ModuleInstallProgressListener : InstallStatusListener {
  override fun onInstallStatusUpdated(update: ModuleInstallStatusUpdate) {
    // Progress info is only set when modules are in the progress of downloading.
    update.progressInfo?.let {
      val progress = (it.bytesDownloaded * 100 / it.totalBytesToDownload).toInt()
      // Set the progress for the progress bar.
      progressBar.setProgress(progress)
    }

    if (isTerminateState(update.installState)) {
      moduleInstallClient.unregisterListener(this)
    }
  }

  fun isTerminateState(@InstallState state: Int): Boolean {
    return state == STATE_CANCELED || state == STATE_COMPLETED || state == STATE_FAILED
  }
}

val listener = ModuleInstallProgressListener()

Java

static final class ModuleInstallProgressListener implements InstallStatusListener {
    @Override
    public void onInstallStatusUpdated(ModuleInstallStatusUpdate update) {
      ProgressInfo progressInfo = update.getProgressInfo();
      // Progress info is only set when modules are in the progress of downloading.
      if (progressInfo != null) {
        int progress =
            (int)
                (progressInfo.getBytesDownloaded() * 100 / progressInfo.getTotalBytesToDownload());
        // Set the progress for the progress bar.
        progressBar.setProgress(progress);
      }
      // Handle failure status maybe…

      // Unregister listener when there are no more install status updates.
      if (isTerminateState(update.getInstallState())) {

        moduleInstallClient.unregisterListener(this);
      }
    }

    public boolean isTerminateState(@InstallState int state) {
      return state == STATE_CANCELED || state == STATE_COMPLETED || state == STATE_FAILED;
    }
  }

InstallStatusListener listener = new ModuleInstallProgressListener();

Konfigurieren Sie die ModuleInstallRequest und fügen Sie die OptionalModuleApi zum Anfrage:

Kotlin

val optionalModuleApi = TfLite.getClient(context)
val moduleInstallRequest =
  ModuleInstallRequest.newBuilder()
    .addApi(optionalModuleApi)
    // Add more APIs if you would like to request multiple optional modules.
    // .addApi(...)
    // Set the listener if you need to monitor the download progress.
    // .setListener(listener)
    .build()

Java

OptionalModuleApi optionalModuleApi = TfLite.getClient(context);
ModuleInstallRequest moduleInstallRequest =
    ModuleInstallRequest.newBuilder()
        .addApi(optionalModuleApi)
        // Add more API if you would like to request multiple optional modules
        //.addApi(...)
        // Set the listener if you need to monitor the download progress
        //.setListener(listener)
        .build();

Senden Sie die Installationsanfrage:

Kotlin

moduleInstallClient
  .installModules(moduleInstallRequest)
  .addOnSuccessListener {
    if (it.areModulesAlreadyInstalled()) {
      // Modules are already installed when the request is sent.
    }
  }
  .addOnFailureListener {
    // Handle failure…
  }

Java

moduleInstallClient.installModules(moduleInstallRequest)
    .addOnSuccessListener(
        response -> {
          if (response.areModulesAlreadyInstalled()) {
            // Modules are already installed when the request is sent.
          }
        })
    .addOnFailureListener(
        e -> {
          // Handle failure...
        });

Lokale Tests mit `FakeModuleInstallClient`

Die SDKs der Google Play-Dienste stellen die FakeModuleInstallClient bereit, damit Sie Folgendes tun können: Simulieren Sie die Ergebnisse der Modulinstallations-APIs in Tests mithilfe einer Abhängigkeit. Injektion.

Voraussetzungen für Apps

Konfigurieren Sie Ihre App für die Verwendung Hilt Dependency Injection Framework

Im Test `ModuleInstallClient` durch `FakeModuleInstallClient` ersetzen

Abhängigkeit hinzufügen:

Fügen Sie in der Gradle-Build-Datei Ihres Moduls (in der Regel app/build.gradle) den Parameter Abhängigkeiten der Google Play-Dienste für play-services-base-testing in Ihrem testen.
```
  dependencies {
    // other dependencies...

    testImplementation 'com.google.android.gms:play-services-base-testing:16.1.0'
  }
```

Erstellen Sie ein Hilt-Modul, um ModuleInstallClient bereitzustellen:

Kotlin

@Module
@InstallIn(ActivityComponent::class)
object ModuleInstallModule {

  @Provides
  fun provideModuleInstallClient(
    @ActivityContext context: Context
  ): ModuleInstallClient = ModuleInstall.getClient(context)
}

Java

@Module
@InstallIn(ActivityComponent.class)
public class ModuleInstallModule {
  @Provides
  public static ModuleInstallClient provideModuleInstallClient(
    @ActivityContext Context context) {
    return ModuleInstall.getClient(context);
  }
}

Fügen Sie ModuleInstallClient in die Aktivität ein:

Kotlin

@AndroidEntryPoint
class MyActivity: AppCompatActivity() {
  @Inject lateinit var moduleInstallClient: ModuleInstallClient

  ...
}

Java

@AndroidEntryPoint
public class MyActivity extends AppCompatActivity {
  @Inject ModuleInstallClient moduleInstallClient;

  ...
}

Ersetzen Sie die Bindung im Test:

Kotlin

@UninstallModules(ModuleInstallModule::class)
@HiltAndroidTest
class MyActivityTest {
  ...
  private val context:Context = ApplicationProvider.getApplicationContext()
  private val fakeModuleInstallClient = FakeModuleInstallClient(context)
  @BindValue @JvmField
  val moduleInstallClient: ModuleInstallClient = fakeModuleInstallClient

  ...
}

Java

@UninstallModules(ModuleInstallModule.class)
@HiltAndroidTest
class MyActivityTest {
  ...
  private static final Context context = ApplicationProvider.getApplicationContext();
  private final FakeModuleInstallClient fakeModuleInstallClient = new FakeModuleInstallClient(context);
  @BindValue ModuleInstallClient moduleInstallClient = fakeModuleInstallClient;

  ...
}

Modulverfügbarkeit simulieren

Kotlin

@Test
fun checkAvailability_available() {
  // Reset any previously installed modules.
  fakeModuleInstallClient.reset()

  val availableModule = TfLite.getClient(context)
  fakeModuleInstallClient.setInstalledModules(api)

  // Verify the case where modules are already available...
}

@Test
fun checkAvailability_unavailable() {
  // Reset any previously installed modules.
  fakeModuleInstallClient.reset()

  // Do not set any installed modules in the test.

  // Verify the case where modules unavailable on device...
}

@Test
fun checkAvailability_failed() {
  // Reset any previously installed modules.
  fakeModuleInstallClient.reset()

  fakeModuleInstallClient.setModulesAvailabilityTask(Tasks.forException(RuntimeException()))

  // Verify the case where an RuntimeException happened when trying to get module's availability...
}

Java

@Test
public void checkAvailability_available() {
  // Reset any previously installed modules.
  fakeModuleInstallClient.reset();

  OptionalModuleApi optionalModuleApi = TfLite.getClient(context);
  fakeModuleInstallClient.setInstalledModules(api);

  // Verify the case where modules are already available...
}

@Test
public void checkAvailability_unavailable() {
  // Reset any previously installed modules.
  fakeModuleInstallClient.reset();

  // Do not set any installed modules in the test.

  // Verify the case where modules unavailable on device...
}

@Test
public void checkAvailability_failed() {
  fakeModuleInstallClient.setModulesAvailabilityTask(Tasks.forException(new RuntimeException()));

  // Verify the case where an RuntimeException happened when trying to get module's availability...
}

Ergebnis für eine verzögerte Installationsanfrage simulieren

Kotlin

@Test
fun deferredInstall_success() {
  fakeModuleInstallClient.setDeferredInstallTask(Tasks.forResult(null))

  // Verify the case where the deferred install request has been sent successfully...
}

@Test
fun deferredInstall_failed() {
  fakeModuleInstallClient.setDeferredInstallTask(Tasks.forException(RuntimeException()))

  // Verify the case where an RuntimeException happened when trying to send the deferred install request...
}

Java

@Test
public void deferredInstall_success() {
  fakeModuleInstallClient.setDeferredInstallTask(Tasks.forResult(null));

  // Verify the case where the deferred install request has been sent successfully...
}

@Test
public void deferredInstall_failed() {
  fakeModuleInstallClient.setDeferredInstallTask(Tasks.forException(new RuntimeException()));

  // Verify the case where an RuntimeException happened when trying to send the deferred install request...
}

Ergebnis für eine dringende Installationsanfrage simulieren

Kotlin

@Test
fun installModules_alreadyExist() {
  // Reset any previously installed modules.
  fakeModuleInstallClient.reset();

  OptionalModuleApi optionalModuleApi = TfLite.getClient(context);
  fakeModuleInstallClient.setInstalledModules(api);

  // Verify the case where the modules already exist when sending the install request...
}

@Test
fun installModules_withoutListener() {
  // Reset any previously installed modules.
  fakeModuleInstallClient.reset();

  // Verify the case where the urgent install request has been sent successfully...
}

@Test
fun installModules_withListener() {
  // Reset any previously installed modules.
  fakeModuleInstallClient.reset();

  // Generates a ModuleInstallResponse and set it as the result for installModules().
  val moduleInstallResponse = FakeModuleInstallUtil.generateModuleInstallResponse()
  fakeModuleInstallClient.setInstallModulesTask(Tasks.forResult(moduleInstallResponse))

  // Verify the case where the urgent install request has been sent successfully...

  // Generates some fake ModuleInstallStatusUpdate and send it to listener.
  val update = FakeModuleInstallUtil.createModuleInstallStatusUpdate(
    moduleInstallResponse.sessionId, STATE_COMPLETED)
  fakeModuleInstallClient.sendInstallUpdates(listOf(update))

  // Verify the corresponding updates are handled correctly...
}

@Test
fun installModules_failed() {
  fakeModuleInstallClient.setInstallModulesTask(Tasks.forException(RuntimeException()))

  // Verify the case where an RuntimeException happened when trying to send the urgent install request...
}

Java

@Test
public void installModules_alreadyExist() {
  // Reset any previously installed modules.
  fakeModuleInstallClient.reset();

  OptionalModuleApi optionalModuleApi = TfLite.getClient(context);
  fakeModuleInstallClient.setInstalledModules(api);

  // Verify the case where the modules already exist when sending the install request...
}

@Test
public void installModules_withoutListener() {
  // Reset any previously installed modules.
  fakeModuleInstallClient.reset();

  // Verify the case where the urgent install request has been sent successfully...
}

@Test
public void installModules_withListener() {
  // Reset any previously installed modules.
  fakeModuleInstallClient.reset();

  // Generates a ModuleInstallResponse and set it as the result for installModules().
  ModuleInstallResponse moduleInstallResponse =
      FakeModuleInstallUtil.generateModuleInstallResponse();
  fakeModuleInstallClient.setInstallModulesTask(Tasks.forResult(moduleInstallResponse));

  // Verify the case where the urgent install request has been sent successfully...

  // Generates some fake ModuleInstallStatusUpdate and send it to listener.
  ModuleInstallStatusUpdate update = FakeModuleInstallUtil.createModuleInstallStatusUpdate(
      moduleInstallResponse.getSessionId(), STATE_COMPLETED);
  fakeModuleInstallClient.sendInstallUpdates(ImmutableList.of(update));

  // Verify the corresponding updates are handled correctly...
}

@Test
public void installModules_failed() {
  fakeModuleInstallClient.setInstallModulesTask(Tasks.forException(new RuntimeException()));

  // Verify the case where an RuntimeException happened when trying to send the urgent install request...
}

API-Verfügbarkeit mit ModuleInstallClient sicherstellen

Hinweis

Voraussetzungen für Apps

Eigene App konfigurieren

Modulverfügbarkeit prüfen

Kotlin

Java

Kotlin

Java

Anfrage für verzögerte Installation senden

Kotlin

Java

Kotlin

Java

Dringende Anfrage zur Modulinstallation senden

Kotlin

Java

Kotlin

Java

Kotlin

Java

Kotlin

Java

Lokale Tests mit FakeModuleInstallClient

Voraussetzungen für Apps

Im Test ModuleInstallClient durch FakeModuleInstallClient ersetzen

Kotlin

Java

Kotlin

Java

Kotlin

Java

Modulverfügbarkeit simulieren

Kotlin

Java

Ergebnis für eine verzögerte Installationsanfrage simulieren

Kotlin

Java

Ergebnis für eine dringende Installationsanfrage simulieren

Kotlin

Java

Lokale Tests mit `FakeModuleInstallClient`

Im Test `ModuleInstallClient` durch `FakeModuleInstallClient` ersetzen