در دسترس بودن ماژول‌های خدمات Google Play درخواستی را مدیریت کنید

همانطور که در مقاله مروری بر خدمات Google Play توضیح داده شد، SDK های ارائه شده توسط سرویس های Google Play توسط سرویس های روی دستگاه در دستگاه های Android دارای گواهی Google پشتیبانی می شوند. برای حفظ فضای ذخیره‌سازی و حافظه در کل ناوگان دستگاه‌ها، برخی از خدمات به‌عنوان ماژول‌هایی ارائه می‌شوند که در صورت نیاز زمانی که برنامه شما به عملکرد مربوطه نیاز دارد، نصب می‌شوند. به عنوان مثال، ML Kit این گزینه را هنگام استفاده از مدل ها در سرویس های Google Play فراهم می کند .

در بیشتر موارد، زمانی که برنامه شما از یک API استفاده می‌کند، SDK خدمات Google Play ماژول‌های لازم را به‌طور خودکار دانلود و نصب می‌کند. با این حال، ممکن است بخواهید کنترل بیشتری بر فرآیند داشته باشید، مانند زمانی که می خواهید با نصب ماژول از قبل، تجربه کاربری را بهبود ببخشید.

ModuleInstallClient API این توانایی را به شما می دهد:

• بررسی کنید که آیا ماژول ها قبلاً روی دستگاه نصب شده اند یا خیر.
• درخواست نصب ماژول ها
• نظارت بر پیشرفت نصب
• رسیدگی به خطاها در طول فرآیند نصب

این راهنما به شما نشان می دهد که چگونه از ModuleInstallClient برای مدیریت ماژول ها در برنامه خود استفاده کنید. توجه داشته باشید که تکه‌های کد زیر از TensorFlow Lite SDK ( play-services-tflite-java ) به عنوان مثال استفاده می‌کنند، اما این مراحل برای هر کتابخانه‌ای که با OptionalModuleApi یکپارچه شده است، قابل اجرا است.

قبل از شروع

برای آماده سازی اپلیکیشن خود، مراحل زیر را انجام دهید.

پیش نیازهای اپلیکیشن

مطمئن شوید که فایل ساخت برنامه شما از مقادیر زیر استفاده می کند:

• minSdkVersion 23 یا بالاتر

برنامه خود را پیکربندی کنید

1. در فایل settings.gradle سطح بالای خود، مخزن Maven Google و مخزن مرکزی Maven را در بلوک dependencyResolutionManagement قرار دهید:

   dependencyResolutionManagement {
       repositories {
           google()
           mavenCentral()
       }
   }
   

2. در فایل ساخت Gradle ماژول خود (معمولا app/build.gradle )، وابستگی‌های خدمات Google Play را برای play-services-base و play-services-tflite-java اضافه کنید:

   dependencies {
     implementation 'com.google.android.gms:play-services-base:18.7.0'
     implementation 'com.google.android.gms:play-services-tflite-java:16.4.0'
   }
   

بررسی کنید که آیا ماژول ها در دسترس هستند

قبل از اینکه بخواهید یک ماژول را نصب کنید، می توانید بررسی کنید که آیا قبلاً روی دستگاه نصب شده است یا خیر. این به شما کمک می کند از درخواست های نصب غیر ضروری جلوگیری کنید.

1. یک نمونه از ModuleInstallClient دریافت کنید:

   کاتلین

   val moduleInstallClient = ModuleInstall.getClient(context)

   جاوا

   ModuleInstallClient moduleInstallClient = ModuleInstall.getClient(context);

2. در دسترس بودن یک ماژول را با استفاده از OptionalModuleApi آن بررسی کنید. این API توسط Google Play Services SDK ارائه شده است که شما از آن استفاده می کنید.

   کاتلین

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

   جاوا

   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 متصل است.

1. یک نمونه از ModuleInstallClient دریافت کنید:

   کاتلین

   val moduleInstallClient = ModuleInstall.getClient(context)

   جاوا

   ModuleInstallClient moduleInstallClient = ModuleInstall.getClient(context);

2. ارسال درخواست معوق:

   کاتلین

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

   جاوا

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

درخواست نصب فوری ماژول

اگر برنامه شما فوراً به ماژول نیاز دارد، می‌توانید درخواست نصب فوری کنید. با این کار سعی می کنید ماژول را در سریع ترین زمان ممکن نصب کنید، حتی اگر به معنای استفاده از داده های تلفن همراه باشد.

1. یک نمونه از ModuleInstallClient دریافت کنید:

   کاتلین

   val moduleInstallClient = ModuleInstall.getClient(context)

   جاوا

   ModuleInstallClient moduleInstallClient = ModuleInstall.getClient(context);

2. (اختیاری) برای نظارت بر پیشرفت نصب، یک 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()

   جاوا

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

3. 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()

   جاوا

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

4. ارسال درخواست نصب:

   کاتلین

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

   جاوا

   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 را با پیاده سازی جعلی جایگزین کنید.

1. افزودن وابستگی:

   در فایل ساخت 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'
     }
   

2. یک ماژول Hilt برای ارائه ModuleInstallClient ایجاد کنید:

   کاتلین

   @Module
   @InstallIn(ActivityComponent::class)
   object ModuleInstallModule {
   
     @Provides
     fun provideModuleInstallClient(
       @ActivityContext context: Context
     ): ModuleInstallClient = ModuleInstall.getClient(context)
   }

   جاوا

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

3. ModuleInstallClient در اکتیویتی تزریق کنید:

   کاتلین

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

   جاوا

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

4. اتصال در تست را جایگزین کنید:

   کاتلین

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

   جاوا

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

   توجه: این قطعه یک مثال اساسی از استفاده از @BindValue برای اتصال فیلد ModuleInstallClient به FakeModuleInstallClient در آزمایش شما در نمودار وابستگی Hilt را نشان می‌دهد. همچنین می‌توانید راهنمای تست Hilt را دنبال کنید تا ماژول تست خود را بسازید و صحافی را در آنجا جایگزین کنید.

شبیه سازی سناریوهای مختلف

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

جاوا

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

جاوا

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

جاوا

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