Support dynamic delivery solution in SDK

IAPMiniProgram SDK designs a unified module dynamic delivery solution that allows the super app to download and install the required modules per your requirements to run your applications.

For example, in order to enhance the performance and rendering capability of mini programs, MYWeb module/dynamic feature is supported, the Google map SDK dynamic integration is supported, and so on.

Prerequisite

Make sure that the following dynamic module names are used correctly according to the different features:

Step 1. Create the dynamic module

1. In your project, click Create new module > Dynamic Feature to start creating a new module. (see the following figure).
2. Choose the Base Application Module properly.
3. Fill in the module name correctly according to the different features.

• For MYWeb feature
  
• For Google Maps SDK integration
  
• For Video component integration
  
  
  
• For Multi-media component integration
  

3. Fill in the Module title according to the different features.

• For MYWeb feature, by default, "MyWeb Dynamic Feature" is used .
• For Google Maps SDK integration, you can directly choose the "Map Dynamic Feature".
  
• For Video component integration, you can directly choose the "Video Dynamic Feature".
  
• For Multi-media component integration, you can directly choose the "Media Dynamic Feature".
  

4. Note: In the Install-time inclusion drop-down list, choose (on-deman only).
5. Click Finish to finish creating the module.

Step 2. Confirm the correctness of the AndroidManifest file

The default configurations in the AndroidManifest file are generated by the system. You need to check and confirm the correctness of the file.

Note: change the dist:titleaccording to the different features.

Code sample:

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
  xmlns:dist="http://schemas.android.com/apk/distribution">

  <dist:module
    dist:instant="false"
    dist:title="@string/title_mywebdynamicfeature">
    <dist:delivery>
      <dist:on-demand />
    </dist:delivery>
    <dist:fusing dist:include="true" />
  </dist:module>
</manifest>

Step 3. Confirm the dynamic repository is imported into the main module

1. In the build.gradle file of the project app, the system generates the following code by default according to the different features. This is because that you choose the Base Application Module in the previous Step 1.

• For MYWeb feature

android {
    dynamicFeatures = [':mywebdynamicfeature']
}

• For Google Maps SDK integration

android {
    dynamicFeatures = [':mapdynamicfeature']
}

• For Video component integration

android {
    dynamicFeatures = [':videodynamicfeature']
}

• For Multi-media component integration

android {
    dynamicFeatures = [':mediadynamicfeature']
}

2. In order to make the dynamic module take effects, must add the following codes in the build.gradle file：

android {
    packagingOptions {
        jniLibs {
            useLegacyPackaging true
        }
    }
}

3. In the AndroidManifest.xml file of the project app, add the following code according to the different features.

• For MYWeb feature

<meta-data
  android:name="com.alibaba.griver.dynamic.modules"
  android:value="mywebdynamicfeature" />

• For Google Maps SDK integration

<meta-data
  android:name="com.alibaba.griver.dynamic.modules"
  android:value="mapdynamicfeature" />

• For Video component integration

<meta-data
  android:name="com.alibaba.griver.dynamic.modules"
  android:value="videodynamicfeature" />

• For Multi-media component integration

<meta-data
  android:name="com.alibaba.griver.dynamic.modules"
  android:value="mediadynamicfeature" />

Step 4. Import the dependency to support the dynamic feature

Import the dependency in the following files:

1. In the build.gradle file of the project app, add the following codes to import the iapminiprogram-dynamic-feature dependency.
   Note: Check the latest iapminiprogram_version version in the Android Release Notes.

dependencies {
    implementation "com.alipay.plus.android:iapminiprogram-dynamic-feature:${iapminiprogram_version}"
}

2. In the build.gradle file of the dynamic module, add the following codes according to the different features.

• For MYWeb feature, import the iapminiprogram-myweb dependency.

dependencies {
    implementation "com.alipay.plus.android:iapminiprogram-myweb:${iapminiprogram_version}"
}

• For Google Maps SDK integration, import the iapminiprogram-gmultimap dependency.

dependencies {
    implementation "com.alipay.plus.android:iapminiprogram-gmultimap:${iapminiprogram_version}"
}

• For video component integration, import the iapminiprogram-video dependency.

dependencies {
    implementation "com.alipay.plus.android:iapminiprogram-video:${iapminiprogram_version}"
}

• For Multi-media component integration, import the iapminiprogram-media dependency.

dependencies {
    implementation "com.alipay.plus.android:iapminiprogram-media:${iapminiprogram_version}"
}

Step 5. Configure to use the SplitCompat tool

In order to use the SplitCompat tool, need to finish the following configurations:

1. In the build.gradle file of the project app, add the following codes to import dependencies accordingly:

// In your app’s build.gradle file:
...
dependencies {
    // This dependency is downloaded from the Google’s Maven repository.
    // So, make sure you also include that repository in your project's build.gradle file.
    implementation 'com.google.android.play:feature-delivery:2.1.0'

    // For Kotlin users, also add the Kotlin extensions library for Play Feature Delivery:
    implementation 'com.google.android.play:feature-delivery-ktx:2.1.0'
    ...
}

2. Turn on the SplitCompat in your application based on the following different cases.

public class MyApplication extends Application {
    @Override
    protected void attachBaseContext(Context base) {
        super.attachBaseContext(base);
        SplitCompat.install(this);
    }
}

public class MyApplication extends SplitCompatApplication {
    ...
}

Step 6. (Optional, for MYWeb only) Optimize the MyWeb dynamic download experience

If you want to optimize the MYWeb dynamic download experience, for example whether a custom dialog box is displayed to explain the reason for downloading, knowing the download status, and so on, to achieve these experiences, use the GriverDynamicFeatureExtension interface.