Trang này được dịch bởi Cloud Translation API.

Đảm bảo API có sẵn bằng ModuleInstallClient

Như mô tả trong bài viết Tổng quan về Dịch vụ Google Play, các SDK do Dịch vụ Google Play cung cấp được hỗ trợ bởi các dịch vụ trên thiết bị trên thiết bị Android được Google chứng nhận. Để tiết kiệm bộ nhớ và dung lượng lưu trữ trên toàn bộ thiết bị, một số dịch vụ được cài đặt theo yêu cầu khi rõ ràng một thiết bị cụ thể cần chức năng liên quan. Ví dụ: Bộ công cụ học máy cung cấp tuỳ chọn này khi sử dụng các mô hình trong Dịch vụ Google Play.

Trường hợp phổ biến nhất là tải xuống và cài đặt một dịch vụ (hoặc "mô-đun") song song với một ứng dụng yêu cầu dịch vụ đó, dựa trên phần phụ thuộc trong AndroidManifest.xml của SDK. Để có thêm quyền kiểm soát, API cài đặt mô-đun cung cấp khả năng kiểm tra rõ ràng tình trạng sẵn có của mô-đun, yêu cầu cài đặt mô-đun, theo dõi trạng thái yêu cầu và xử lý lỗi.

Hãy làm theo các bước dưới đây để đảm bảo API có sẵn với ModuleInstallClient. Xin lưu ý rằng các đoạn mã bên dưới sử dụng SDK TensorFlow Lite (play-services-tflite-java) làm thư viện mẫu, nhưng các bước này áp dụng cho mọi thư viện được tích hợp với OptionalModuleApi. Hướng dẫn này sẽ được cập nhật thêm thông tin khi có nhiều SDK hỗ trợ hơn.

Trước khi bắt đầu

Để chuẩn bị cho ứng dụng của bạn, hãy hoàn tất các bước trong những phần sau.

Điều kiện tiên quyết đối với ứng dụng

Đảm bảo rằng tệp bản dựng của ứng dụng sử dụng các giá trị sau:

Một minSdkVersion từ 19 trở lên

Định cấu hình ứng dụng

Trong tệp settings.gradle cấp cao nhất, hãy thêm kho lưu trữ Maven của Google và kho lưu trữ trung tâm Maven vào khối dependencyResolutionManagement:
```
dependencyResolutionManagement {
    repositories {
        google()
        mavenCentral()
    }
}
```
Trong tệp bản dựng Gradle của mô-đun (thường là app/build.gradle), hãy thêm các phần phụ thuộc Dịch vụ Google Play cho play-services-base và 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.4.0'
}
```

Kiểm tra tình trạng có sẵn của mô-đun

Tạo một thực thể của ModuleInstallClient:

Kotlin

val moduleInstallClient = ModuleInstall.getClient(context)

Java

ModuleInstallClient moduleInstallClient = ModuleInstall.getClient(context);

Kiểm tra xem có mô-đun tuỳ chọn hay không bằng cách sử dụng OptionalModuleApi của mô-đun đó:

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

Gửi yêu cầu cài đặt bị trì hoãn

Tạo một thực thể của ModuleInstallClient:

Kotlin

val moduleInstallClient = ModuleInstall.getClient(context)

Java

ModuleInstallClient moduleInstallClient = ModuleInstall.getClient(context);

Gửi yêu cầu bị trì hoãn:

Kotlin

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

Java

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

Gửi yêu cầu cài đặt mô-đun khẩn cấp

Tạo một thực thể của ModuleInstallClient:

Kotlin

val moduleInstallClient = ModuleInstall.getClient(context)

Java

ModuleInstallClient moduleInstallClient = ModuleInstall.getClient(context);

(Không bắt buộc) Tạo InstallStatusListener để xử lý các bản cập nhật trạng thái cài đặt.

Nếu muốn theo dõi tiến trình tải xuống trong một giao diện người dùng tuỳ chỉnh (ví dụ: thanh tiến trình), bạn có thể tạo InstallStatusListener để nhận thông tin cập nhật về trạng thái cài đặt.

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

Định cấu hình ModuleInstallRequest và thêm OptionalModuleApi vào yêu cầu:

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

Gửi yêu cầu cài đặt:

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

Kiểm thử cục bộ bằng `FakeModuleInstallClient`

SDK Dịch vụ Google Play cung cấp FakeModuleInstallClient để cho phép bạn mô phỏng kết quả của các API cài đặt mô-đun trong kiểm thử bằng cách chèn phần phụ thuộc.

Điều kiện tiên quyết đối với ứng dụng

Định cấu hình ứng dụng để sử dụng khung chèn phần phụ thuộc Hilt.

Thay thế `ModuleInstallClient` bằng `FakeModuleInstallClient` trong kiểm thử

Thêm phần phụ thuộc:

Trong tệp bản dựng Gradle của mô-đun (thường là app/build.gradle), hãy thêm các phần phụ thuộc Dịch vụ Google Play cho play-services-base-testing trong kiểm thử.
```
  dependencies {
    // other dependencies...

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

Tạo mô-đun Hilt để cung cấp ModuleInstallClient:

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

Chèn ModuleInstallClient vào hoạt động:

Kotlin

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

  ...
}

Java

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

  ...
}

Thay thế liên kết trong kiểm thử:

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;

  ...
}

Mô phỏng tình trạng sẵn có của mô-đun

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

Mô phỏng kết quả cho yêu cầu cài đặt bị trì hoãn

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

Mô phỏng kết quả cho yêu cầu cài đặt khẩn cấp

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

Đảm bảo API có sẵn bằng ModuleInstallClient

Trước khi bắt đầu

Điều kiện tiên quyết đối với ứng dụng

Định cấu hình ứng dụng

Kiểm tra tình trạng có sẵn của mô-đun

Kotlin

Java

Kotlin

Java

Gửi yêu cầu cài đặt bị trì hoãn

Kotlin

Java

Kotlin

Java

Gửi yêu cầu cài đặt mô-đun khẩn cấp

Kotlin

Java

Kotlin

Java

Kotlin

Java

Kotlin

Java

Kiểm thử cục bộ bằng FakeModuleInstallClient

Điều kiện tiên quyết đối với ứng dụng

Thay thế ModuleInstallClient bằng FakeModuleInstallClient trong kiểm thử

Kotlin

Java

Kotlin

Java

Kotlin

Java

Mô phỏng tình trạng sẵn có của mô-đun

Kotlin

Java

Mô phỏng kết quả cho yêu cầu cài đặt bị trì hoãn

Kotlin

Java

Mô phỏng kết quả cho yêu cầu cài đặt khẩn cấp

Kotlin

Java

Kiểm thử cục bộ bằng `FakeModuleInstallClient`

Thay thế `ModuleInstallClient` bằng `FakeModuleInstallClient` trong kiểm thử