تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

ضمان توفُّر واجهة برمجة التطبيقات باستخدام ModuleInstallClient

كما هو موضّح في نظرة عامة على خدمات Google Play مقالة "حِزم تطوير البرامج (SDK)" التي تدعمها "خدمات Google Play" مستنِدة إلى الخدمات المتوفّرة على الجهاز على أجهزة Android المعتمَدة من Google للحفاظ على سعة التخزين والذاكرة عبر مجموعة كاملة من الأجهزة، يتم تثبيت بعض الخدمات عند الطلب عندما يكون واضحًا أنّ جهازًا معيّنًا يتطلّب الوظيفة ذات الصلة على سبيل المثال: توفّر حزمة تعلّم الآلة هذا الخيار. عند استخدام النماذج في "خدمات Google Play"

والحالة الأكثر شيوعًا هي تنزيل خدمة (أو "وحدة") مثبتًا بالتوازي مع تطبيق يتطلب ذلك، بناءً على التبعية في AndroidManifest.xml من حزمة تطوير البرامج (SDK) لمزيد من التحكم، تقوم الوحدة بتثبيت واجهات برمجة التطبيقات توفير إمكانية التحقق الصريح من توفر الوحدات، ووحدة الطلب التثبيت ومراقبة حالة الطلب والتعامل مع الأخطاء.

اتّبِع الخطوات أدناه لضمان توفُّر واجهة برمجة التطبيقات في ModuleInstallClient. لاحظ أن مقتطفات الرمز أدناه تستخدم حزمة تطوير البرامج TensorFlow Lite (play-services-tflite-java) كمثال على المكتبة، لكن هذه الخطوات ينطبق على أي مكتبة متكاملة مع OptionalModuleApi. هذا النمط الدليل بإضافة معلومات إضافية مع دعم المزيد من حِزم SDK.

قبل البدء

لإعداد تطبيقك، أكمِل الخطوات الواردة في الأقسام التالية.

المتطلّبات الأساسية للتطبيق

يُرجى التأكُّد من أنّ ملف الإصدار لتطبيقك يستخدم القيم التالية:

minSdkVersion بقيمة 19 أو أعلى

إعداد تطبيقك

في ملف settings.gradle ذي المستوى الأعلى، أضِف مستودع Maven من Google مستودع Maven المركزي ضمن حظر dependencyResolutionManagement:
```
dependencyResolutionManagement {
    repositories {
        google()
        mavenCentral()
    }
}
```
في ملف تصميم Gradle للوحدة، (عادةً ما يكون app/build.gradle)، أضف العنصر اعتماديات "خدمات Google Play" للحساب play-services-base 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'
}
```

التحقّق من توفّر الوحدة

الحصول على نسخة افتراضية من ModuleInstallClient:

Kotlin

val moduleInstallClient = ModuleInstall.getClient(context)

Java

ModuleInstallClient moduleInstallClient = ModuleInstall.getClient(context);

يمكنك التحقّق من مدى توفّر وحدة اختيارية باستخدام 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…
        });

إرسال طلب تثبيت مؤجَّل

الحصول على نسخة افتراضية من ModuleInstallClient:

Kotlin

val moduleInstallClient = ModuleInstall.getClient(context)

Java

ModuleInstallClient moduleInstallClient = ModuleInstall.getClient(context);

إرسال الطلب المؤجَّل:

Kotlin

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

Java

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

إرسال طلب لتثبيت الوحدة بشكل عاجل

الحصول على نسخة افتراضية من ModuleInstallClient:

Kotlin

val moduleInstallClient = ModuleInstall.getClient(context)

Java

ModuleInstallClient moduleInstallClient = ModuleInstall.getClient(context);

(اختياري) أنشئ InstallStatusListener لمعالجة حالة التثبيت التحديثات.

إذا أردت مراقبة تقدم التنزيل في واجهة مستخدم مخصصة ( شريط تقدّم مثلاً)، فيمكنك إنشاء InstallStatusListener تلقي تحديثات حالة التثبيت.

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

ضبط ModuleInstallRequest وإضافة OptionalModuleApi إلى الطلب:

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

إرسال طلب التثبيت:

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

الاختبار المحلي مع `FakeModuleInstallClient`

توفّر حِزم تطوير البرامج (SDK) الخاصة "بخدمات Google Play" حزمة "FakeModuleInstallClient" للسماح لك بما يلي: محاكاة نتائج واجهات برمجة تطبيقات تثبيت الوحدة في الاختبارات باستخدام التبعية حُقن.

المتطلّبات الأساسية للتطبيق

ضبط التطبيق لاستخدامه إطار عمل حقن التبعية:

استبدال "`ModuleInstallClient`" بـ "`FakeModuleInstallClient`" أثناء الاختبار

إضافة التبعية:

في ملف تصميم Gradle للوحدة، (عادةً ما يكون app/build.gradle)، أضف العنصر اعتماديات "خدمات Google Play" لـ "play-services-base-testing" في الاختبار.
```
  dependencies {
    // other dependencies...

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

أنشِئ وحدة Hilt لتوفير 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);
  }
}

إدخال "ModuleInstallClient" في النشاط:

Kotlin

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

  ...
}

Java

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

  ...
}

استبدال عملية الربط في الاختبار:

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;

  ...
}

محاكاة توفُّر الوحدات

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

محاكاة نتيجة طلب تثبيت مؤجل

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

محاكاة نتيجة طلب تثبيت عاجل

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

ضمان توفُّر واجهة برمجة التطبيقات باستخدام ModuleInstallClient

قبل البدء

المتطلّبات الأساسية للتطبيق

إعداد تطبيقك

التحقّق من توفّر الوحدة

Kotlin

Java

Kotlin

Java

إرسال طلب تثبيت مؤجَّل

Kotlin

Java

Kotlin

Java

إرسال طلب لتثبيت الوحدة بشكل عاجل

Kotlin

Java

Kotlin

Java

Kotlin

Java

Kotlin

Java

الاختبار المحلي مع FakeModuleInstallClient

المتطلّبات الأساسية للتطبيق

استبدال "ModuleInstallClient" بـ "FakeModuleInstallClient" أثناء الاختبار

Kotlin

Java

Kotlin

Java

Kotlin

Java

محاكاة توفُّر الوحدات

Kotlin

Java

محاكاة نتيجة طلب تثبيت مؤجل

Kotlin

Java

محاكاة نتيجة طلب تثبيت عاجل

Kotlin

Java

الاختبار المحلي مع `FakeModuleInstallClient`

استبدال "`ModuleInstallClient`" بـ "`FakeModuleInstallClient`" أثناء الاختبار