অন-ডিমান্ড Google Play পরিষেবা মডিউলগুলির জন্য উপলব্ধতা পরিচালনা করুন৷

"গুগল প্লে সার্ভিসেসের ওভারভিউ " নিবন্ধে বর্ণিত হিসাবে, গুগল প্লে সার্ভিসেস দ্বারা চালিত SDK গুলি গুগল-প্রত্যয়িত অ্যান্ড্রয়েড ডিভাইসগুলিতে অন-ডিভাইস পরিষেবা দ্বারা সমর্থিত। ডিভাইসের পুরো বহরে স্টোরেজ এবং মেমোরি সংরক্ষণের জন্য, কিছু পরিষেবা মডিউল হিসাবে সরবরাহ করা হয় যা আপনার অ্যাপের প্রাসঙ্গিক কার্যকারিতার প্রয়োজন হলে চাহিদা অনুসারে ইনস্টল করা হয়। উদাহরণস্বরূপ, গুগল প্লে সার্ভিসেসগুলিতে মডেল ব্যবহার করার সময় ML Kit এই বিকল্পটি প্রদান করে

বেশিরভাগ ক্ষেত্রে, যখন আপনার অ্যাপ এমন একটি API ব্যবহার করে যার জন্য সেগুলি প্রয়োজন হয়, তখন Google Play পরিষেবা SDK স্বয়ংক্রিয়ভাবে প্রয়োজনীয় মডিউলগুলি ডাউনলোড এবং ইনস্টল করে। তবে, আপনি প্রক্রিয়াটির উপর আরও নিয়ন্ত্রণ রাখতে চাইতে পারেন, যেমন যখন আপনি আগে থেকে মডিউলটি ইনস্টল করে ব্যবহারকারীর অভিজ্ঞতা উন্নত করতে চান।

ModuleInstallClient API আপনাকে নিম্নলিখিতগুলি করার ক্ষমতা দেয়:

  • ডিভাইসে মডিউলগুলি ইতিমধ্যেই ইনস্টল করা আছে কিনা তা পরীক্ষা করুন।
  • মডিউলগুলি ইনস্টল করার অনুরোধ।
  • ইনস্টলেশনের অগ্রগতি পর্যবেক্ষণ করুন।
  • ইনস্টলেশন প্রক্রিয়ার সময় ত্রুটিগুলি পরিচালনা করুন।

এই নির্দেশিকাটি আপনাকে দেখাবে কিভাবে আপনার অ্যাপে মডিউল পরিচালনা করার জন্য ModuleInstallClient ব্যবহার করবেন। মনে রাখবেন যে নিম্নলিখিত কোড স্নিপেটগুলি TensorFlow Lite SDK ( play-services-tflite-java ) উদাহরণ হিসেবে ব্যবহার করে, তবে এই পদক্ষেপগুলি OptionalModuleApi এর সাথে ইন্টিগ্রেটেড যেকোনো লাইব্রেরির জন্য প্রযোজ্য।

শুরু করার আগে

আপনার অ্যাপ প্রস্তুত করতে, নিম্নলিখিত বিভাগগুলির ধাপগুলি সম্পূর্ণ করুন।

অ্যাপের পূর্বশর্ত

আপনার অ্যাপের বিল্ড ফাইলে নিম্নলিখিত মানগুলি ব্যবহার করা হয়েছে কিনা তা নিশ্চিত করুন:

  • 23 বা তার বেশি ভার্সনের একটি minSdkVersion

আপনার অ্যাপ কনফিগার করুন

  1. আপনার টপ-লেভেল settings.gradle ফাইলে, dependencyResolutionManagement ব্লকের মধ্যে Google এর Maven রিপোজিটরি এবং Maven সেন্ট্রাল রিপোজিটরি অন্তর্ভুক্ত করুন:

    dependencyResolutionManagement {
        repositories {
            google()
            mavenCentral()
        }
    }
    
  2. আপনার মডিউলের গ্রেডল বিল্ড ফাইলে (সাধারণত app/build.gradle ), play-services-base এবং play-services-tflite-java এর জন্য Google Play পরিষেবা নির্ভরতা যোগ করুন:

    dependencies {
      implementation 'com.google.android.gms:play-services-base:18.10.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 পরিষেবা 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 তৈরি করুন।

    আপনি যদি আপনার অ্যাপের UI তে ডাউনলোডের অগ্রগতি প্রদর্শন করতে চান (উদাহরণস্বরূপ, একটি অগ্রগতি বার সহ), তাহলে আপডেটগুলি পাওয়ার জন্য আপনি একটি 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 দিয়ে আপনার অ্যাপটি পরীক্ষা করুন

Google Play পরিষেবা SDK গুলি FakeModuleInstallClient প্রদান করে যা আপনাকে নির্ভরতা ইনজেকশন ব্যবহার করে পরীক্ষায় মডিউল ইনস্টল API গুলির ফলাফল অনুকরণ করতে দেয়। এটি আপনাকে বাস্তব ডিভাইসে এটি স্থাপন না করেই বিভিন্ন পরিস্থিতিতে আপনার অ্যাপের আচরণ পরীক্ষা করতে সহায়তা করে।

অ্যাপের পূর্বশর্ত

হিল্ট ডিপেন্ডেন্সি ইনজেকশন ফ্রেমওয়ার্ক ব্যবহার করার জন্য আপনার অ্যাপটি কনফিগার করুন।

পরীক্ষায় ModuleInstallClient FakeModuleInstallClient দিয়ে প্রতিস্থাপন করুন।

আপনার পরীক্ষাগুলিতে FakeModuleInstallClient ব্যবহার করতে, আপনাকে ModuleInstallClient বাইন্ডিংটি fake বাস্তবায়ন দিয়ে প্রতিস্থাপন করতে হবে।

  1. নির্ভরতা যোগ করুন:

    আপনার মডিউলের Gradle বিল্ড ফাইলে (সাধারণত app/build.gradle ), আপনার পরীক্ষায় play-services-base-testing এর জন্য Google Play পরিষেবা নির্ভরতা যোগ করুন।

      dependencies {
        // other dependencies...
    
        testImplementation 'com.google.android.gms:play-services-base-testing:16.2.0'
      }
    
  2. ModuleInstallClient প্রদানের জন্য একটি Hilt মডিউল তৈরি করুন:

    কোটলিন

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

বিভিন্ন পরিস্থিতি অনুকরণ করুন

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