গুগল প্লে সার্ভিসেস-এর ওভারভিউ আর্টিকেলে যেমন বর্ণনা করা হয়েছে, গুগল প্লে সার্ভিসেস দ্বারা চালিত এসডিকে-গুলো গুগল-সার্টিফাইড অ্যান্ড্রয়েড ডিভাইসগুলোর অন-ডিভাইস সার্ভিস দ্বারা সমর্থিত। সমস্ত ডিভাইস জুড়ে স্টোরেজ এবং মেমরি সাশ্রয় করার জন্য, কিছু সার্ভিস মডিউল হিসেবে সরবরাহ করা হয়, যা আপনার অ্যাপের প্রাসঙ্গিক কার্যকারিতার প্রয়োজন হলে অন-ডিমান্ড ইনস্টল করা হয়। উদাহরণস্বরূপ, গুগল প্লে সার্ভিসেস-এ মডেল ব্যবহার করার সময় এমএল কিট এই বিকল্পটি প্রদান করে ।
বেশিরভাগ ক্ষেত্রে, আপনার অ্যাপ যখন প্রয়োজনীয় কোনো এপিআই (API) ব্যবহার করে, তখন গুগল প্লে সার্ভিসেস এসডিকে (Google Play services SDK) স্বয়ংক্রিয়ভাবে প্রয়োজনীয় মডিউলগুলো ডাউনলোড ও ইনস্টল করে দেয়। তবে, আপনি এই প্রক্রিয়াটির উপর আরও বেশি নিয়ন্ত্রণ রাখতে চাইতে পারেন, যেমন—ব্যবহারকারীর অভিজ্ঞতা উন্নত করার জন্য মডিউলটি আগে থেকেই ইনস্টল করে রাখা।
ModuleInstallClient API আপনাকে নিম্নলিখিত ক্ষমতা প্রদান করে:
- ডিভাইসটিতে মডিউলগুলো আগে থেকেই ইনস্টল করা আছে কিনা তা পরীক্ষা করুন।
- মডিউলগুলো ইনস্টল করার অনুরোধ।
- ইনস্টলেশনের অগ্রগতি পর্যবেক্ষণ করুন।
- ইনস্টলেশন প্রক্রিয়া চলাকালীন ত্রুটিগুলি সামাল দিন।
এই নির্দেশিকাটি আপনাকে দেখাবে কিভাবে আপনার অ্যাপে মডিউল পরিচালনা করতে ModuleInstallClient ব্যবহার করতে হয়। উল্লেখ্য যে, নিম্নলিখিত কোড স্নিপেটগুলিতে উদাহরণ হিসেবে TensorFlow Lite SDK ( play-services-tflite-java ) ব্যবহার করা হয়েছে, কিন্তু এই ধাপগুলো OptionalModuleApi সাথে ইন্টিগ্রেটেড যেকোনো লাইব্রেরির জন্যই প্রযোজ্য।
শুরু করার আগে
আপনার অ্যাপটি প্রস্তুত করতে, নিচের বিভাগগুলিতে দেওয়া ধাপগুলি সম্পূর্ণ করুন।
অ্যাপের পূর্বশর্ত
নিশ্চিত করুন যে আপনার অ্যাপের বিল্ড ফাইলে নিম্নলিখিত মানগুলি ব্যবহৃত হয়েছে:
-
minSdkVersion23বা তার বেশি
আপনার অ্যাপ কনফিগার করুন
আপনার শীর্ষ-স্তরের
settings.gradleফাইলে,dependencyResolutionManagementব্লকের মধ্যে Google-এর Maven রিপোজিটরি এবং Maven সেন্ট্রাল রিপোজিটরি অন্তর্ভুক্ত করুন:dependencyResolutionManagement { repositories { google() mavenCentral() } }আপনার মডিউলের গ্রেডল বিল্ড ফাইলে (সাধারণত
app/build.gradle),play-services-baseএবংplay-services-tflite-javaএর জন্য গুগল প্লে সার্ভিসেস ডিপেন্ডেন্সিগুলো যোগ করুন:dependencies { implementation 'com.google.android.gms:play-services-base:18.10.0' implementation 'com.google.android.gms:play-services-tflite-java:16.4.0' }
মডিউলগুলো উপলব্ধ আছে কিনা যাচাই করুন
কোনো মডিউল ইনস্টল করার চেষ্টা করার আগে, আপনি যাচাই করে নিতে পারেন যে সেটি ডিভাইসে আগে থেকেই ইনস্টল করা আছে কি না। এর ফলে আপনি অপ্রয়োজনীয় ইনস্টলেশনের অনুরোধ এড়াতে পারবেন।
ModuleInstallClientএর একটি ইনস্ট্যান্স নিন:কোটলিন
val moduleInstallClient = ModuleInstall.getClient(context)
জাভা
ModuleInstallClient moduleInstallClient = ModuleInstall.getClient(context);
কোনো মডিউলের
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… });
বিলম্বিত ইনস্টলেশনের জন্য অনুরোধ করুন
আপনার যদি মডিউলটি এখনই প্রয়োজন না হয়, তবে আপনি একটি বিলম্বিত ইনস্টলের জন্য অনুরোধ করতে পারেন। এর ফলে গুগল প্লে সার্ভিসেস ব্যাকগ্রাউন্ডে মডিউলটি ইনস্টল করতে পারে, যা সম্ভবত ডিভাইসটি নিষ্ক্রিয় থাকা অবস্থায় এবং ওয়াই-ফাইয়ের সাথে সংযুক্ত থাকাকালীন সম্পন্ন হয়।
ModuleInstallClientএর একটি ইনস্ট্যান্স নিন:কোটলিন
val moduleInstallClient = ModuleInstall.getClient(context)
জাভা
ModuleInstallClient moduleInstallClient = ModuleInstall.getClient(context);
স্থগিত অনুরোধটি পাঠান:
কোটলিন
val optionalModuleApi = TfLite.getClient(context) moduleInstallClient.deferredInstall(optionalModuleApi)
জাভা
OptionalModuleApi optionalModuleApi = TfLite.getClient(context); moduleInstallClient.deferredInstall(optionalModuleApi);
জরুরি মডিউল ইনস্টলের জন্য অনুরোধ করুন
আপনার অ্যাপের যদি মডিউলটি অবিলম্বে প্রয়োজন হয়, তাহলে আপনি একটি জরুরি ইনস্টলের জন্য অনুরোধ করতে পারেন। এর ফলে মডিউলটি যত দ্রুত সম্ভব ইনস্টল করার চেষ্টা করা হবে, এমনকি এর জন্য মোবাইল ডেটা ব্যবহার করতে হলেও।
ModuleInstallClientএর একটি ইনস্ট্যান্স নিন:কোটলিন
val moduleInstallClient = ModuleInstall.getClient(context)
জাভা
ModuleInstallClient moduleInstallClient = ModuleInstall.getClient(context);
(ঐচ্ছিক) ইনস্টলেশনের অগ্রগতি নিরীক্ষণের জন্য একটি
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();
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();
ইনস্টল করার অনুরোধ পাঠান:
কোটলিন
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 দিয়ে আপনার অ্যাপটি পরীক্ষা করুন
গুগল প্লে সার্ভিসেস এসডিকে-গুলো FakeModuleInstallClient প্রদান করে, যা আপনাকে ডিপেন্ডেন্সি ইনজেকশন ব্যবহার করে টেস্টের সময় মডিউল ইনস্টল এপিআই-এর ফলাফল সিমুলেট করার সুযোগ দেয়। এটি আপনাকে কোনো বাস্তব ডিভাইসে আপনার অ্যাপ ডেপ্লয় না করেই বিভিন্ন পরিস্থিতিতে এর আচরণ পরীক্ষা করতে সাহায্য করে।
অ্যাপের পূর্বশর্ত
আপনার অ্যাপটিকে হিল্ট ডিপেন্ডেন্সি ইনজেকশন ফ্রেমওয়ার্ক ব্যবহার করার জন্য কনফিগার করুন।
টেস্টে ModuleInstallClient FakeModuleInstallClient দিয়ে প্রতিস্থাপন করুন
আপনার টেস্টে FakeModuleInstallClient ব্যবহার করতে হলে, আপনাকে ModuleInstallClient বাইন্ডিংটিকে ফেক ইমপ্লিমেন্টেশন দিয়ে প্রতিস্থাপন করতে হবে।
নির্ভরতা যোগ করুন:
আপনার মডিউলের গ্রেডল বিল্ড ফাইলে (সাধারণত
app/build.gradle), আপনার টেস্টের মধ্যেplay-services-base-testingএর জন্য গুগল প্লে সার্ভিসেস ডিপেন্ডেন্সিগুলো যোগ করুন।dependencies { // other dependencies... testImplementation 'com.google.android.gms:play-services-base-testing:16.2.0' }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); } }
অ্যাক্টিভিটিতে
ModuleInstallClientইনজেক্ট করুন:কোটলিন
@AndroidEntryPoint class MyActivity: AppCompatActivity() { @Inject lateinit var moduleInstallClient: ModuleInstallClient ... }
জাভা
@AndroidEntryPoint public class MyActivity extends AppCompatActivity { @Inject ModuleInstallClient moduleInstallClient; ... }
পরীক্ষায় বাইন্ডিংটি প্রতিস্থাপন করুন:
কোটলিন
@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... }