SDK 快速集成
Download
聚焦模式
字号
快速集成将指导客户端开发人员集成一个最小化功能的小程序 SDK，实现小程序的打开功能。
集成配置
1. 在 settings.gradle 中配置仓库地址
pluginManagement {repositories {maven {url 'https://maven-dev.tcmppcloud.com/fHKFBbEjd/repository/maven-public/'}}}dependencyResolutionManagement {repositories {maven {url 'https://maven-dev.tcmppcloud.com/fHKFBbEjd/repository/maven-public/'}}}
2. 在应用模块 build.gradle 中增加 kotlin 插件配置
plugins {id "org.jetbrains.kotlin.android"id "org.jetbrains.kotlin.kapt"}
3. 在应用模块 build.gradle 中配置 packagingOptions
android {defaultConfig {packagingOptions {pickFirst 'lib/arm64-v8a/libc++_shared.so'pickFirst 'lib/armeabi/libc++_shared.so'pickFirst 'lib/armeabi-v7a/libc++_shared.so'pickFirst 'lib/arm64-v8a/libwechatxlog.so'pickFirst 'lib/armeabi/libwechatxlog.so'pickFirst 'lib/armeabi-v7a/libwechatxlog.so'}}}
4. 配置小程序 SDK 的依赖
dependencies {implementation 'com.google.android.material:material:1.3.0-alpha03'implementation 'androidx.core:core-ktx:1.6.0'//gosnimplementation 'com.google.code.gson:gson:2.8.6'// ok-httpimplementation 'com.squareup.okhttp3:okhttp:3.12.13'// mini app start// 注解处理器(必须)// 核心库（必须）// 预置基础库（可选）// mini app end}
说明：
配置中的 {version} 需要替换为对应依赖的版本；版本信息请参见 Android SDK 更新动态。
如果开发者原来的工程中使用了 annotationProcessor 注解处理器，需要将所有 annotationProcessor 改为 kapt 注解处理器。
初始化配置
1. 控制台创建应用
小程序 SDK 初始化依赖于从小程序控制台获取的应用的加密密钥或配置文件, 如果您还未在控制台创建应用，可以参考下面流程创建。
1.1 登录小程序控制台进入应用管理页面
1.2 创建 superapp
1.3 填写 superapp 信息
必填信息：
Superapp 名称：支持中文、大小写英文字母、数字、空格和部分特殊符号（"+"、"="、","、"."、"@"、"-"、"_"），3-64个字符。
非必填信息：
Superapp 说明：此处可填写 superapp 的简介信息，主要用于团队内部查看。
Superapp icon：支持上传 jpg、png 格式的方形图片、分辨率为128*128，图片大小在 2M 以内，若不上传 logo 图片，则使用系统默认 icon 图片。
Scheme：只能包含小写字母和数字，不超过64个字符。设置 scheme 后，小程序（或小游戏）的二维码信息会包含 scheme，使用手机系统自带的扫码功能，可直接唤起 superapp 并打开小程序（或小游戏）。
1.4 添加应用包名
添加 Package name/Bundle ID 时，需要选择和填写的字段有：
类型：类型选择后不允许修改，非生产类型的包名仅用于 superapp 测试版本使用，每个月有使用设备数量限制（最多500）。
Package name/Bundle ID：只能包含小写字母（a-z）、数字（0-9）、点（.）和连字符（-），不超过 255 个字符。建议采用反向域名表示法，例如 com.example.myapp。
下载地址：只能包含大小写字母（a-z）、数字（0-9）、点（.）、连字符（-）和斜杠（/），不超过 2048 个字符。
2. 获取应用配置完成初始化
2.1 配置方式说明
添加 Package name/Bundle ID 后，superapp 需要从控制台获取 SDK 初始化配置。当前提供两种获取方式，二选一即可，可在配置获取方式区域查看说明：
配置方式 | 适用场景 | 安全性 | SDK 版本要求 | 绑定关系 |
方式一：使用加密密钥（Encryption key） | 新版 SDK，推荐用于生产环境 | 较高（密钥下发由后台控制） | ≥ 2.3.8 | 与 Package name/Bundle ID 1:1 绑定 |
方式二：下载配置文件（Config file） | 旧版 SDK 或离线场景 | 配置文件为明文存储，需要自行保护 | ≥ 2.2.15 | 与应用维度绑定 |
说明：
两种方式只需任选其一进行 SDK 初始化，不需要同时使用。
推荐优先采用方式一：使用加密密钥，安全性更高且与包名一一绑定，便于权限控制与审计。
若所使用的 SDK 版本低于 2.3.8，请使用方式二：下载配置文件。
2.2 方式一：使用加密密钥
2.2.1 生成加密密钥
1. 按照上文所述为应用配置生产和非生产的 Package name/Bundle ID，每个 Package name/Bundle ID 都可生成唯一的加密密钥，SDK 使用该密钥进行初始化，密钥与包名 1:1 绑定，相比明文配置文件具有更高的安全性，推荐用于生产环境。
2. 在对应包名所在行，找到加密密钥字段：
若状态为未生成，单击生成密钥，系统会为该包名生成唯一密钥，生成成功后会展示掩码（如
A7B9***********************6Q8R0）并提示密钥生成成功。每个 Package name/Bundle ID 仅对应一份加密密钥，重复点击不会生成新的密钥。
2.2.2 查看与复制密钥
1. 密钥生成后，在加密密钥字段会展示掩码字符串以及获取密钥。
2. 单击获取密钥，系统会弹出密钥详情弹窗，展示完整密钥内容。
3. 单击弹窗内的复制，将密钥复制到剪贴板，提示复制成功。
4. 将复制到的密钥保存到您的后台服务，由后台下发给客户端，客户端在 SDK 初始化时使用该密钥即可完成接入。
注意：
加密密钥与 Package name/Bundle ID 1:1 绑定，不同包名对应不同密钥，互不通用。
该方式需要 SDK 版本 ≥ 2.3.8，低版本 SDK 请改用「方式二：下载配置文件」。
请勿将密钥硬编码在客户端代码或公共仓库中，建议由您的业务后台保管，并在客户端运行时按需下发。
仅「应用管理员/应用高级开发者」拥有「生成密钥」权限；「应用开发者」可查看与复制已有密钥；其他角色仅可只读查看是否已生成。
如怀疑密钥泄露，请联系应用管理员处理（如重新生成或更换包名），并同步更新业务后台所保管的密钥。
2.2.3 使用加密密钥完成初始化代理配置
继承并实现 MiniConfigProxy 类；
MiniConfigProxy 的实现类，添加注解如下：
@ProxyService(proxy = MiniConfigProxy.class)
参考代码如下：
@ProxyService(proxy = MiniConfigProxy.class)public class MiniConfigProxyImpl extends MiniConfigProxy {/*** 获取 superapp 的 Application 实例* 注意：1. 小程序是多进程架构，请确保子进程也可以正常获取到 Application 实例。* 2. Application实例缓存建议在 Application.attachBaseContext 中进行，* 避免因为组件时序问题导致 SDK 获取到空的 Application 实例。* @return*/@Overridepublic Application getApp() {//必须使用 superapp 的 Application 实例return "your superapp Application";}/*** 创建初始化配置信息* @return*/@Overridepublic MiniInitConfig buildConfig() {MiniInitConfig.Builder builder = new MiniInitConfig.Builder();MiniInitConfig config = builder.appSecret("your encryption key").autoRequestPermission(true) // 配置小程序使用到需要权限的API时是否自动向用户申请对应的系统权限.debug(true) // 日志开关，默认关闭的.build();return config;}}
2.3 方式二：使用配置文件
2.3.1 下载配置文件
注意：
默认下载的配置文件的名称为：tcsas-android-configurations.json。
2.3.2 添加配置文件到项目
获取配置文件后，需要将
配置文件拷贝到 superapp 工程的 assets 路径中：
注意：
Superapp 包名必须与控制台应用包名保持一致，否则小程序 SDK 在运行时无法通过包名校验，导致 SDK 无法正常工作。
2.3.3 源码中增加小程序 SDK 的初始化配置
继承并实现 MiniConfigProxy 类；
MiniConfigProxy 的实现类，添加注解如下：
@ProxyService(proxy = MiniConfigProxy.class)
参考代码如下：
@ProxyService(proxy = MiniConfigProxy.class)public class MiniConfigProxyImpl extends MiniConfigProxy {/*** 获取 superapp 的 Application 实例* 注意：1. 小程序是多进程架构，请确保子进程也可以正常获取到 Application 实例。* 2. Application实例缓存建议在 Application.attachBaseContext 中进行，* 避免因为组件时序问题导致 SDK 获取到空的 Application 实例。* @return*/@Overridepublic Application getApp() {//必须使用 superapp 的 Application 实例return "your superapp Application";}/*** 创建初始化配置信息* @return*/@Overridepublic MiniInitConfig buildConfig() {MiniInitConfig.Builder builder = new MiniInitConfig.Builder();MiniInitConfig config = builder.configAssetName("tcsas-android-configurations.json") // assets中配置文件名称.autoRequestPermission(true) // 配置小程序使用到需要权限的API时是否自动向用户申请对应的系统权限.debug(true) // 日志开关，默认关闭的.build();return config;}}
注意：
1. MiniInitConfig 的 configAssetName 用于指定配置文件在源码工程中的路径和名称。
2. 由于 SDK 最早会在内部 ContentProvider 中获取 superapp 的 Application 实例，因此 Application 实例缓存建议在 Application.attachBaseContext 方法中进行，可以避免因为时序问题导致 SDK 获取到空的 Application 实例。
至此，小程序 SDK 的接入就完成了。下一步可通过小程序 SDK 提供的 API 实现小程序的打开和预览。
打开小程序
打开小程序可以参考如下的示例代码：
说明：
appid 为小程序 ID，需要在小程序开发人员处获取。
TmfMiniSDK.startMiniApp(activity, appId, new MiniStartOptions());
小程序数据按账号隔离存储
若您的 superapp 支持多用户登录，且需避免小程序沙盒数据在不同用户间交叉共享，您需要实现 IMiniAppProxy.getAccount() 方法来返回差异化用户 ID，以此实现小程序沙盒数据按账号维度的隔离存储。
文档反馈