Unleashing the Power of the Android SDK with Dynamic Feature Modules

In the ever-evolving landscape of Android development, two pivotal factors are reshaping the way we approach app creation and delivery. Firstly, Google Play Store now sets a threshold—150 MB—as the maximum size for app uploads (per architecture). This directive not only encourages efficient app design but also underscores the significance of size-conscious development.

Adding to this paradigm shift is Android’s recommendation to utilize dynamic modules for larger applications. By adopting the app bundle format, you can tap into Play Feature Delivery, enabling the inclusion of feature modules that enhance your app based on conditions you define, like OnDemand download of modules later from Play Store.

Moreover, we've cracked the code to seamlessly integrate the Webex SDK into dynamic modules. This breakthrough not only reduces app(.apk) size but also empowers you to leverage the dynamic compatibility of WebexSDK.

Let us begin the process 🚀📱.

Prerequisites

To embark on this dynamic journey, make sure you have the following prerequisites in place:

• Android Studio setup:
  • Download Android Studio from here
  • Set up the environment for Android Studio.
• Knowledge of integrating with a Webex SDK. If you need guidance, refer to the following references:
  • Requirements & Feature List
  • Guides
  • API Reference

Now that you are all set, let us dive into the exciting world of Android’s Play Feature Delivery, with WebexSDK.

Step 1: Creating a Dynamic Feature Module

To kick off your dynamic adventure, follow these steps:

1. In Android Studio, select File > New > New Module from the menu bar.

2. In the "Create New Module" dialog, choose Dynamic Feature Module and click Next.

   

3. Select the base module from the dropdown menu.

4. Provide a name and package name for your dynamic module and click Next.

   

5. Give your module a catchy title. It's a good idea to use the same name you used when creating the module.

6. Select "on-Demand only" as the Install time inclusion.

7. If you want this module to be available to devices running Android 4.4 (API level 20) and lower, check the Fusing box. This will include the module in multi-APKs.

8. Click Finish to complete the setup. Now sit back and wait for Android Studio to finish the sync.

A sample dynamic feature module for the reference

Step 2: Configuring the Webex Android SDK in the Dynamic Feature Module

Configuring the Webex Android SDK within your dynamic feature module is a crucial step that ensures seamless integration of collaboration capabilities. This configuration bridges the gap between your base and dynamic modules, enabling them to work harmoniously.

Dynamic Feature Module: build.gradle

Let us make sure the IDE has applied the configuration correctly. Open the dynamic feature module's build.gradle file and ensure the following:

• The com.android.dynamic-feature plugin is added.
• Remove unnecessary configurations such as signing configurations, minifyEnabled, versionCode, versionName, and app’s meta-data.
• Add the WebexSDK dependency for the dynamic module: implementation 'com.ciscowebex:webexsdk-wxc:3.9.2'

Dynamic feature module: AndroidManifest.xml

Define on-demand module attributes with split name, title, and on-demand availability in AndroidManifest.xml

• Use dist:module for packaging and distribution settings.
• Specify dist:OnDemand: for on-demand download.
• Use dist:fusing to include the module in lower Android versions.
• Set android:hasCode to false if no DEX files to avoid runtime errors.

Base module: build.gradle

• Verify IDE applied configuration with android.dynamicFeatures = [":dynamicfeature"].
• For reusable dependencies use the API keyword, while defining dependencies.
• Add play core library for dynamic feature support.
• Set applicationId, minSdk, targetSdk, versionCode, and versionName.

Full configs for gradle files can be seen here.

Now let us visualize the Collaboration of base and dynamic modules with dependency! 🧐😎.

Base module: AndroidManifest.xml

To enable WebexSDK to collect logs in the SD card at the directory: /sdcard/Android/data/<app-id>/cache/logs, the base module should define a file provider for the SDK in its manifest. It is important to note that, as per the bundling rules, dynamic module providers are not visible to the base module during compilation time.

Request an OnDemand Module

When your app needs to use a feature module, it can request one while it’s in the foreground through the SplitInstallManager class. When making a request, your app needs to specify the name of the module as defined by the split element in the target module’s manifest. When you create a feature module using Android Studio, the build system uses the Module name you have provided, to inject this property into the module’s manifest at compile time.

Handle dynamic module download states

Now we need to manage the installation request and monitor the status of the dynamic module download using the SplitInstallStateUpdatedListener.

SplitInstallStateUpdatedListener listener = state -> 
{
  if (state.status() == SplitInstallSessionStatus.FAILED 
    && state.errorCode() == SplitInstallErrorCode.SERVICE_DIES) {
    // Retry the request.
    return;
  }
  switch (state.status()) {
    case SplitInstallSessionStatus.DOWNLOADING:
      // Update progress bar.
      break;
    case SplitInstallSessionStatus.INSTALLED:
      //Module is downloaded successfully
      break;
  }
};
…
…

// Registers the listener.
installManager.registerListener(listener);
installManager.startInstall(request)

For error details, refer here.

Managing dynamic feature modules:

Cancel a module installation request before installation with:
splitInstallManager.cancelInstall(sessionId).

Check currently installed dynamic feature modules on the device with:
Set<String>installedModules = splitInstallManager.getInstalledModules().

Uninstall modules using:
splitInstallManager.deferredUninstall(Arrays.asList("moduleName")).

Launching the Webex Module after Successful Installation:

• LoginActivity - In the dynamic module, create a LoginActivity which acts as the gateway to the dynamic module and Webex SDK.
• SplitCompat.install(context) is to be defined for all the activity components of dynamic module.
• After a successful dynamic module installation, call launchActivity() with the class name from the base module.

🚨 Important Notes: Android Dynamic Module Integration 🚨

When it comes to Android Dynamic Module integration, we must address a significant challenge: the base module's inability to directly utilize code from the dynamic module. Fear not, we have some smart solutions to conquer this hurdle:

• Communication through Interfaces: Create interfaces in the base module that the dynamic module can implement. This clever approach enables smooth communication and code usage between the two modules.
• Reflection Magic: Embrace the power of reflection! Utilize it to access the dynamic module's code indirectly from the base module. Although it comes with a performance cost, it gets the job done.
• Shared Libraries: Unite code forces! Extract common code into shared libraries that both the base and dynamic modules can depend on. This fosters code reuse and simplifies inter-module communication.

By implementing these genius solutions, you'll master the art of seamless integration and collaboration between the base and dynamic modules.

Conclusion

In the realm of Android app development, Google Play's 150 MB cap pushes efficient design. Dynamic modules enrich larger apps, while our Webex SDK integration optimizes size and enhances capabilities. Achieve a balance of efficiency and collaboration, empowering your app's success.

Happy coding and keep building amazing apps! 🤩💻📲