Эта страница переведена с помощью Cloud Translation API.

Управление доступностью модулей сервисов Google Play по запросу

Как описано в статье «Обзор сервисов Google Play» , SDK, работающие на базе сервисов Google Play, поддерживаются встроенными сервисами на сертифицированных Google устройствах Android. Для экономии места и памяти на всех устройствах некоторые сервисы предоставляются в виде модулей, которые устанавливаются по запросу, когда вашему приложению требуется соответствующая функциональность. Например, ML Kit предоставляет такую возможность при использовании моделей в сервисах Google Play.

В большинстве случаев SDK сервисов Google Play автоматически загружает и устанавливает необходимые модули, когда ваше приложение использует API, который их требует. Однако вам может потребоваться больший контроль над этим процессом, например, если вы хотите улучшить пользовательский опыт, установив модуль заранее.

API ModuleInstallClient предоставляет вам следующие возможности:

Проверьте, установлены ли модули уже на устройстве.
Запрос на установку модулей.
Следите за ходом установки.
Обработка ошибок в процессе установки.

В этом руководстве показано, как использовать ModuleInstallClient для управления модулями в вашем приложении. Обратите внимание, что в приведенных ниже фрагментах кода в качестве примера используется TensorFlow Lite SDK ( play-services-tflite-java ), но эти шаги применимы для любой библиотеки, интегрированной с OptionalModuleApi .

Прежде чем начать

Для подготовки приложения выполните действия, описанные в следующих разделах.

Предварительные требования к приложению

Убедитесь, что в файле сборки вашего приложения используются следующие значения:

minSdkVersion : 23 или выше.

Настройте свое приложение

В файле settings.gradle верхнего уровня укажите репозиторий Maven от Google и центральный репозиторий Maven в блоке dependencyResolutionManagement :
```
dependencyResolutionManagement {
    repositories {
        google()
        mavenCentral()
    }
}
```
В файл сборки Gradle вашего модуля (обычно app/build.gradle ) добавьте зависимости Google Play Services для play-services-base и play-services-tflite-java :
```
dependencies {
  implementation 'com.google.android.gms:play-services-base:18.10.0'
  implementation 'com.google.android.gms:play-services-tflite-java:16.4.0'
}
```

Проверьте наличие доступных модулей.

Перед установкой модуля можно проверить, установлен ли он уже на устройстве. Это поможет избежать ненужных запросов на установку.

Получите экземпляр ModuleInstallClient :

Котлин

val moduleInstallClient = ModuleInstall.getClient(context)

Java

ModuleInstallClient moduleInstallClient = ModuleInstall.getClient(context);

Проверьте доступность модуля, используя его OptionalModuleApi . Этот API предоставляется SDK сервисов Google Play, который вы используете.

Котлин

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

Запросить отложенную установку

Если модуль вам не нужен немедленно, вы можете запросить отложенную установку. Это позволит сервисам Google Play установить модуль в фоновом режиме, например, когда устройство находится в режиме ожидания и подключено к Wi-Fi.

Получите экземпляр ModuleInstallClient :

Котлин

val moduleInstallClient = ModuleInstall.getClient(context)

Java

ModuleInstallClient moduleInstallClient = ModuleInstall.getClient(context);

Отправьте отложенный запрос:

Котлин

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

Java

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

Запросить срочную установку модуля

Если вашему приложению модуль нужен немедленно, вы можете запросить срочную установку. Это позволит установить модуль как можно быстрее, даже если для этого потребуется использование мобильного трафика.

Получите экземпляр ModuleInstallClient :

Котлин

val moduleInstallClient = ModuleInstall.getClient(context)

Java

ModuleInstallClient moduleInstallClient = ModuleInstall.getClient(context);

(Необязательно) Создайте объект InstallStatusListener для отслеживания хода установки.

Если вы хотите отображать ход загрузки в пользовательском интерфейсе вашего приложения (например, с помощью индикатора выполнения), вы можете создать InstallStatusListener для получения обновлений.

Котлин

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

Настройте объект ModuleInstallRequest и добавьте в запрос OptionalModuleApi :

Котлин

val optionalModuleApi = TfLite.getClient(context)
val moduleInstallRequest =
  ModuleInstallRequest.newBuilder()
    .addApi(optionalModuleApi)
    // Add more APIs if you would like to request multiple 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 modules
        //.addApi(...)
        // Set the listener if you need to monitor the download progress
        //.setListener(listener)
        .build();

Отправьте запрос на установку:

Котлин

moduleInstallClient
  .installModules(moduleInstallRequest)
  .addOnSuccessListener {
    if (it.areModulesAlreadyInstalled()) {
      // Modules are already installed when the request is sent.
    }
    // The install request has been sent successfully. This does not mean
    // the installation is completed. To monitor the install status, set an
    // InstallStatusListener to the ModuleInstallRequest.
  }
  .addOnFailureListener {
    // Handle failure…
  }

Java

moduleInstallClient.installModules(moduleInstallRequest)
    .addOnSuccessListener(
        response -> {
          if (response.areModulesAlreadyInstalled()) {
            // Modules are already installed when the request is sent.
          }
          // The install request has been sent successfully. This does not
          // mean the installation is completed. To monitor the install
          // status, set an InstallStatusListener to the
          // ModuleInstallRequest.
        })
    .addOnFailureListener(
        e -> {
          // Handle failure...
        });

Протестируйте свое приложение с помощью `FakeModuleInstallClient`

SDK сервисов Google Play предоставляют FakeModuleInstallClient , позволяющий имитировать результаты работы API установки модулей в тестах с использованием внедрения зависимостей. Это помогает тестировать поведение вашего приложения в различных сценариях без необходимости развертывания его на реальном устройстве.

Предварительные требования к приложению

Настройте ваше приложение для использования фреймворка внедрения зависимостей Hilt .

Замените `ModuleInstallClient` на `FakeModuleInstallClient` в тесте.

Чтобы использовать FakeModuleInstallClient в тестах, необходимо заменить привязку ModuleInstallClient на реализацию фиктивного модуля.

Добавить зависимость:
В файл сборки Gradle вашего модуля (обычно app/build.gradle ) добавьте зависимость сервисов Google Play для play-services-base-testing в ваши тесты.
```
  dependencies {
    // other dependencies...

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

Создайте модуль Hilt, который будет предоставлять ModuleInstallClient :

Котлин

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

Внедрите модуль ModuleInstallClient в активность:

Котлин

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

  ...
}

Java

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

  ...
}

Замените привязку в тесте:

Котлин

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

  ...
}

Смоделируйте различные сценарии.

С помощью FakeModuleInstallClient можно имитировать различные сценарии, например:

Модули уже установлены.
Модули на устройстве недоступны.
Процесс установки завершился неудачей.
Запрос на отложенную установку либо успешно выполнен, либо завершился с ошибкой.
Запрос на срочную установку либо успешно выполнен, либо не выполнен.

Котлин

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

Смоделируйте результат для запроса на отложенную установку.

Котлин

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

Смоделируйте результат для срочного запроса на установку.

Котлин

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

Прежде чем начать

Предварительные требования к приложению

Настройте свое приложение

Проверьте наличие доступных модулей.

Котлин

Java

Котлин

Java

Запросить отложенную установку

Котлин

Java

Котлин

Java

Запросить срочную установку модуля

Котлин

Java

Котлин

Java

Котлин

Java

Котлин

Java

Протестируйте свое приложение с помощью FakeModuleInstallClient

Предварительные требования к приложению

Замените ModuleInstallClient на FakeModuleInstallClient в тесте.

Котлин

Java

Котлин

Java

Котлин

Java

Смоделируйте различные сценарии.

Котлин

Java

Смоделируйте результат для запроса на отложенную установку.

Котлин

Java

Смоделируйте результат для срочного запроса на установку.

Котлин

Java

Протестируйте свое приложение с помощью `FakeModuleInstallClient`

Замените `ModuleInstallClient` на `FakeModuleInstallClient` в тесте.