Google Play services के ऑन-डिमांड मॉड्यूल की उपलब्धता मैनेज करना

Google Play services की खास जानकारी लेख में बताए गए तरीके के मुताबिक, Google Play services की मदद से काम करने वाले SDK टूल, Google से सर्टिफ़ाइड Android डिवाइसों पर मौजूद सेवाओं के ज़रिए काम करते हैं. डिवाइसों के पूरे फ़्लीट में स्टोरेज और मेमोरी बचाने के लिए, कुछ सेवाएं मॉड्यूल के तौर पर उपलब्ध कराई जाती हैं. ये मॉड्यूल, आपके ऐप्लिकेशन को ज़रूरी फ़ंक्शनैलिटी की ज़रूरत पड़ने पर ही इंस्टॉल किए जाते हैं. उदाहरण के लिए, ML Kit, Google Play services में मॉडल इस्तेमाल करते समय यह विकल्प उपलब्ध कराता है.

ज़्यादातर मामलों में, Google Play services SDK, ज़रूरी मॉड्यूल को अपने-आप डाउनलोड और इंस्टॉल कर लेता है. ऐसा तब होता है, जब आपका ऐप्लिकेशन किसी ऐसे एपीआई का इस्तेमाल करता है जिसके लिए इन मॉड्यूल की ज़रूरत होती है. हालांकि, हो सकता है कि आपको इस प्रोसेस पर ज़्यादा कंट्रोल चाहिए. जैसे, अगर आपको मॉड्यूल को पहले से इंस्टॉल करके, उपयोगकर्ता अनुभव को बेहतर बनाना है.

ModuleInstallClient एपीआई की मदद से, ये काम किए जा सकते हैं:

  • यह देखना कि मॉड्यूल, डिवाइस पर पहले से इंस्टॉल हैं या नहीं.
  • मॉड्यूल इंस्टॉल करने का अनुरोध करना.
  • इंस्टॉल करने की प्रोसेस की प्रोग्रेस को मॉनिटर करना.
  • इंस्टॉल करने की प्रोसेस के दौरान होने वाली गड़बड़ियों को ठीक करना.

इस गाइड में, अपने ऐप्लिकेशन में मॉड्यूल मैनेज करने के लिए, ModuleInstallClient का इस्तेमाल करने का तरीका बताया गया है. ध्यान दें कि यहां दिए गए कोड स्निपेट में, TensorFlow Lite SDK (play-services-tflite-java) को एक उदाहरण के तौर पर इस्तेमाल किया गया है. हालांकि, ये चरण, OptionalModuleApi के साथ इंटिग्रेट की गई किसी भी लाइब्रेरी पर लागू होते हैं.

शुरू करने से पहले

अपने ऐप्लिकेशन को तैयार करने के लिए, यहां दिए गए सेक्शन में बताए गए चरण पूरे करें.

ऐप्लिकेशन से जुड़ी ज़रूरी शर्तें

पक्का करें कि आपके ऐप्लिकेशन की बिल्ड फ़ाइल में ये वैल्यू इस्तेमाल की गई हों:

  • minSdkVersion की वैल्यू 23 या इससे ज़्यादा हो

अपने ऐप्लिकेशन को कॉन्फ़िगर करना

  1. अपनी टॉप-लेवल settings.gradle फ़ाइल में, Google की Maven रिपॉज़िटरी और Maven की सेंट्रल रिपॉज़िटरी को dependencyResolutionManagement ब्लॉक में शामिल करें:

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

  2. अपने मॉड्यूल की Gradle बिल्ड फ़ाइल (आम तौर पर इसे app/build.gradle कहा जाता है) में, play-services-base और play-services-tflite-java के लिए Google Play services की डिपेंडेंसी जोड़ें:

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

यह देखना कि मॉड्यूल उपलब्ध हैं या नहीं

किसी मॉड्यूल को इंस्टॉल करने से पहले, यह देखा जा सकता है कि वह डिवाइस पर पहले से इंस्टॉल है या नहीं. इससे, इंस्टॉल करने के ऐसे अनुरोधों से बचा जा सकता है जिनकी ज़रूरत नहीं है.

  1. ModuleInstallClient का इंस्टेंस पाएं:

    Kotlin

    val moduleInstallClient = ModuleInstall.getClient(context)

    Java

    ModuleInstallClient moduleInstallClient = ModuleInstall.getClient(context);

  2. किसी मॉड्यूल के OptionalModuleApi का इस्तेमाल करके, उसकी उपलब्धता देखें. यह एपीआई, Google Play services SDK की मदद से उपलब्ध कराया जाता है. इसका इस्तेमाल किया जा रहा है.

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

इंस्टॉल करने की प्रोसेस को स्थगित करने का अनुरोध करना

अगर आपको मॉड्यूल की तुरंत ज़रूरत नहीं है, तो इंस्टॉल करने की प्रोसेस को स्थगित करने का अनुरोध किया जा सकता है. इससे, Google Play services को बैकग्राउंड में मॉड्यूल इंस्टॉल करने की अनुमति मिलती है. ऐसा तब हो सकता है, जब डिवाइस इस्तेमाल न किया जा रहा हो और वह वाई-फ़ाई से कनेक्ट हो.

  1. ModuleInstallClient का इंस्टेंस पाएं:

    Kotlin

    val moduleInstallClient = ModuleInstall.getClient(context)

    Java

    ModuleInstallClient moduleInstallClient = ModuleInstall.getClient(context);

  2. स्थगित करने का अनुरोध भेजें:

    Kotlin

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

    Java

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

मॉड्यूल को तुरंत इंस्टॉल करने का अनुरोध करना

अगर आपके ऐप्लिकेशन को मॉड्यूल की तुरंत ज़रूरत है, तो उसे तुरंत इंस्टॉल करने का अनुरोध किया जा सकता है. इससे, मॉड्यूल को जल्द से जल्द इंस्टॉल करने की कोशिश की जाएगी. भले ही, इसके लिए मोबाइल डेटा का इस्तेमाल करना पड़े.

  1. ModuleInstallClient का इंस्टेंस पाएं:

    Kotlin

    val moduleInstallClient = ModuleInstall.getClient(context)

    Java

    ModuleInstallClient moduleInstallClient = ModuleInstall.getClient(context);

  2. (ज़रूरी नहीं) इंस्टॉल करने की प्रोसेस की प्रोग्रेस को मॉनिटर करने के लिए, 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();

  3. ModuleInstallRequest को कॉन्फ़िगर करें और अनुरोध में OptionalModuleApi जोड़ें:

    Kotlin

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

  4. इंस्टॉल करने का अनुरोध भेजें:

    Kotlin

    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 की मदद से अपने ऐप्लिकेशन को टेस्ट करना

Google Play services SDK, FakeModuleInstallClient उपलब्ध कराते हैं. इसकी मदद से, डिपेंडेंसी इंजेक्शन का इस्तेमाल करके, टेस्ट में मॉड्यूल इंस्टॉल करने वाले एपीआई के नतीजों को सिम्युलेट किया जा सकता है. इससे, अपने ऐप्लिकेशन को असली डिवाइस पर डिप्लॉय किए बिना, अलग-अलग स्थितियों में उसके व्यवहार को टेस्ट किया जा सकता है.

ऐप्लिकेशन से जुड़ी ज़रूरी शर्तें

Hilt डिपेंडेंसी इंजेक्शन फ़्रेमवर्क का इस्तेमाल करने के लिए, अपने ऐप्लिकेशन को कॉन्फ़िगर करें.

टेस्ट में ModuleInstallClient को FakeModuleInstallClient से बदलना

अपने टेस्ट में FakeModuleInstallClient का इस्तेमाल करने के लिए, आपको ModuleInstallClient बाइंडिंग को फ़ेक इंप्लीमेंटेशन से बदलना होगा.

  1. डिपेंडेंसी जोड़ें:

    अपने मॉड्यूल की Gradle बिल्ड फ़ाइल (आम तौर पर इसे app/build.gradle कहा जाता है) में, अपने टेस्ट में play-services-base-testing के लिए Google Play services की डिपेंडेंसी जोड़ें.

      dependencies {
    // other dependencies...

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

  2. ModuleInstallClient उपलब्ध कराने के लिए, Hilt मॉड्यूल बनाएं:

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

  3. गतिविधि में ModuleInstallClient इंजेक्ट करें:

    Kotlin

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

  ...
}

    Java

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

  ...
}

  4. टेस्ट में बाइंडिंग बदलें:

    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;

  ...
}

अलग-अलग स्थितियों को सिम्युलेट करना

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