इस पेज का अनुवाद Cloud Translation API से किया गया है.

moduleInstallClient के साथ एपीआई की उपलब्धता पक्का करना

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

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

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

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

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

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

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

19 या उससे ज़्यादा का minSdkVersion

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

अपनी टॉप-लेवल settings.gradle फ़ाइल में, dependencyResolutionManagement ब्लॉक में Google की Maven रिपॉज़िटरी और Maven Central रिपॉज़िटरी शामिल करें:
```
dependencyResolutionManagement {
    repositories {
        google()
        mavenCentral()
    }
}
```
अपने मॉड्यूल की Gradle बिल्ड फ़ाइल (आम तौर पर app/build.gradle) में, play-services-base और play-services-tflite-java के लिए Google Play services की डिपेंडेंसी जोड़ें:
```
dependencies {
  implementation 'com.google.android.gms:play-services-base:18.5.0'
  implementation 'com.google.android.gms:play-services-tflite-java:16.4.0'
}
```

मॉड्यूल की उपलब्धता देखना

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

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

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

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

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

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

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

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

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

गतिविधि में 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; ... }
ध्यान दें: ऊपर दिया गया स्निपेट, @BindValue का इस्तेमाल करने का एक बुनियादी उदाहरण है. इससे, Hilt के डिपेंडेंसी ग्राफ़ में अपने टेस्ट में ModuleInstallClient फ़ील्ड को FakeModuleInstallClient से आसानी से बंधा जा सकता है. अपना टेस्ट मॉड्यूल बनाने और वहां बाइंडिंग बदलने के लिए, Hilt टेस्टिंग गाइड का पालन भी किया जा सकता है.

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

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` से बदलें