ModuleInstallClient के साथ API की उपलब्धता को पक्का करना

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

ज़्यादातर मामलों में, SDK टूल के AndroidManifest.xml में डिपेंडेंसी के आधार पर, किसी सेवा (या "मॉड्यूल") को डाउनलोड और इंस्टॉल करने के साथ-साथ, उसे किसी ऐप्लिकेशन के साथ इंस्टॉल किया जाता है. ज़्यादा कंट्रोल के लिए, मॉड्यूल इंस्टॉल करने के एपीआई से साफ़ तौर पर, मॉड्यूल की उपलब्धता देखने, मॉड्यूल इंस्टॉल करने के अनुरोध, अनुरोध की स्थिति को मॉनिटर करने, और गड़बड़ियों को हैंडल करने की सुविधा मिलती है.

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

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

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

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

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

  • 19 या इससे ज़्यादा के minSdkVersion

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

  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 सेवाओं की डिपेंडेंसी जोड़ें:

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

मॉड्यूल की उपलब्धता जाँचें

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

    Kotlin

    val moduleInstallClient = ModuleInstall.getClient(context)
    

    Java

    ModuleInstallClient moduleInstallClient = ModuleInstall.getClient(context);
    
  2. 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…
            });
    

स्थगित इंस्टॉल अनुरोध भेजें

  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 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();
    
  4. इंस्टॉल करने का अनुरोध भेजें:

    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 के साथ स्थानीय टेस्टिंग

'Google Play सेवाएं' SDK टूल, FakeModuleInstallClient की मदद से इंडिपेंडेंट इंजेक्शन का इस्तेमाल करके, जांच में मॉड्यूल इंस्टॉल एपीआई के नतीजों को सिम्युलेट करने की अनुमति देते हैं.

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

हिट पर निर्भर करने वाले फ़्रेमवर्क का फ़्रेमवर्क इस्तेमाल करने के लिए, अपना ऐप्लिकेशन कॉन्फ़िगर करें.

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

  1. निर्भरता जोड़ें:

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

      dependencies {
        // other dependencies...
    
        testImplementation 'com.google.android.gms:play-services-base-testing:16.0.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;
    
      ...
    }
    

मॉड्यूल उपलब्धता सिम्युलेट करें

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