全部产品
云市场
云游戏

使用 mPaaS 插件

更新时间:2020-09-09 17:51:11

mPaaS 插件通过图形化界面,帮助您快速地接入 mPaaS 并便捷地使用 mPaaS 的功能。mPaaS 插件的功能主要包括 原生 AAR 接入、mPaaS Inside 接入、组件化接入、基础工具、帮助、和 构建。

  • 原生 AAR 接入mPaaS Inside 接入组件化接入 三个功能分别提供了接入面板,在接入面板中的接入向导会协助您将 mPaaS 以不同的接入方式接入到您的工程中。在完成接入后,您还可以在接入面板进行 基线升级、组件管理。
  • 基础工具 中,mPaaS 提供了 热修复、生成加密图片(专有云配置文件)、生成 UC Key 签名信息、和 生成 UC Key 签名信息 的功能,方便快速完成使用 mPaaS 功能前的信息准备。
  • 帮助 中,mPaaS 提供了 日志诊断工具、常见问题、和 查看文档 功能,方便在使用 mPaaS 过程中遇到问题时快速获得支持。
  • 构建,完成接入 mPaaS 后构建工程。

添加配置文件

接入过程的主要工作是将配置文件添加到工程中,mPaaS 插件支持 手动导入自动拉取 两种方式添加配置文件。手动导入需要在控制台下载配置文件后,再通过 mPaaS 插件手动添加到工程里。自动拉取方式则是使用账号 Access Key 信息登录 mPaaS 插件,mPaaS 插件能够从控制台自动拉取到配置文件并添加到工程中。

手动导入

手动上传方式支持蚂蚁金融云用户、阿里云用户、专有云用户。

前提条件

  • 已创建了蚂蚁或阿里云账号并开通了 mPaaS 服务。
  • 已在 mPaaS 控制台创建应用。更多关于创建应用的信息,请参见 在控制台创建 mPaaS 应用
  • 已有一个Android 开发工程。

操作步骤

  1. 在 Android Studio 中打开已有工程,点击 mPaaS > 原生 AAR 接入mPaaS Inside 接入、或 组件化接入。在弹出的接入面板中,点击导入 App 配置下的 开始导入
  2. 选择 我已经从控制台上下载配置文件(Ant-mPaaS-xxxx.config),准备导入到工程,点击 Next
  3. 选择配置文件后,点击 Finish,即完成了配置文件的导入。导入成功后,将会收到导入配置文件成功的提示信息。

自动拉取

自动拉取方式目前只支持阿里云用户。

前提条件

  • 已创建阿里云账号并开通了 mPaaS 服务。更多关于创建阿里云账号的信息,请参见 注册阿里云账号
  • 如果您是阿里云用户,已经为当前账号创建了AccessKey。更多关于创建 AccessKey 的信息,请参见获取账号的 AK 信息
  • 已在 mPaaS 控制台创建应用。更多关于创建应用的信息,请参见 在控制台创建 mPaaS 应用
  • 已有一个原生 Android 开发工程。

操作步骤

  1. 在 Android Studio 中打开已有工程,点击 mPaaS > 原生 AAR 接入mPaaS Inside 接入、或 组件化接入。点击 开始导入
  2. 选择 我尚未下载配置文件,点击 Next
  3. 选择 我是阿里云用户,使用阿里云控制台创建 mPaaS App,点击 Next
  4. 填入已经获取的 Access Key 信息,点击 Next
  5. 选择您在控制台创建的 mPaaS App 和 mPaaS 工作空间。
  6. 点击 Finish 后,会弹出登录成功提醒。
  7. 再次点击 开始导入
  8. 选择 我尚未下载配置文件,点击 Next
  9. 选择 我是阿里云用户,使用阿里云控制台创建 mPaaS App,点击 Next
  10. 选择您的 Key Store,点击 Finish。如果您还没有获得 Key Store,还可以点击 Create new… 进行创建。
  11. 此时,会弹出 下载 Config 文件成功 的提醒,说明 mPaaS 插件已自动拉取到了配置文件,您无需再手动导入。

AAR 接入

操作步骤

  1. 在 Android Studio 中打开已有工程,点击 mPaaS > 原生 AAR 接入
  2. 导入 App 配置。
    在接入面板中,点击 开始导入,根据您的需要,选择 手动导入 或者 自动拉取 方式完成配置文件的添加。

后续步骤

  1. 接入/升级基线
  2. 配置/更新组件

mPaaS Inside 接入

操作步骤

  1. 在 Android Studio 中打开已有工程,点击 mPaaS > mPaaS Inside 接入
  2. 导入 App 配置。
    在接入面板中,点击 开始导入,根据您的需要,选择 手动导入 或者 自动拉取 方式完成配置文件的添加。
  3. 转换工程。如果您的工程是原生 Android 工程,还需要对工程进行转换。
    1. 在接入面板中,点击 安装 mPaaS Inside
    2. 到 mPaaS 官网注册账号,并创建应用。创建完成后下载配置文件。然后点击 Next
      如您在获取配置文件时已完成上述步骤,可直接点击 Next。
    3. 在转换窗口中,选择添加过的配置文件,点击 Finish

迁移成功后,Android Studio会 弹出如下提示。

后续步骤

  1. 接入/升级基线
  2. 配置/更新组件

组件化接入

操作步骤

  1. 在 Android Studio 中打开已有工程,点击 mPaaS > mPaaS Inside 接入
  2. 导入 App 配置。
    在接入面板中,点击 开始导入,根据您的需要,选择 手动导入 或者 自动拉取 方式完成配置文件的添加。
  3. 转换工程。如果您的工程是原生 Android 工程,还需要对工程进行转换。
    在接入面板中,点击 安装 mPaaS Portal。在安装 mPaaS Portal 窗口中,分别选择原始工程的位置和配置文件,点击 OK

后续步骤

  1. 接入/升级基线
  2. 配置/更新组件

接入/升级基线

升级到常规基线

操作步骤

  1. 点击 mPaaS > 原生 AAR 接入mPaaS Inside 接入、或 组件化接入,在弹出的接入面板中,点击接入/升级基线下的 开始配置
  2. 选择需要升级的基线版本,点击 OK

    升级成功后,您将看到如下提示。

后续步骤

点击接入面板中的升级基线,在选择基线窗口中将会看到您的基线版本号。

升级到自定义基线

通常情况下,我们提供的基线是面向所有客户的,如 10.1.32、10.1.60、10.1.68。当您需要定制一些 mPaaS 的功能时,您可以向和您对接的人员提出需求,我们会按照您的需求为您定制基线。在交付的时候,mPaaS 的工作人员会向您提供定制基线的 ID,您只需要在 mPaaS 插件中填写该 ID,即可获得此定制基线。

前提条件

确认您的 Android Studio mPaaS 版本为 V2.19111217 或以上。您可以参考 更新 mPaaS 插件 以了解当前的 mPaaS 插件版本和如何升级 mPaaS 插件。

操作步骤

  1. 删除您 Android Studio 工程里已经存在的 mpaas_package.json 文件。
  2. 点击 mPaaS > 原生 AAR 接入mPaaS Inside 接入、或 组件化接入,在弹出的接入面板中,点击接入/升级基线下的 开始配置
  3. 在基线升级对话框中勾选 自定义基线 并输入您得到的定制基线 ID。
  4. 点击 OK,即完成自定义基线的引入。

配置/更新组件

mPaaS组件管理(AAR)

前提条件

您已完成基线升级。

操作步骤

  1. 点击 mPaaS > 原生 AAR 接入,在弹出的接入面板中,点击配置/更新组件下的 开始配置
  2. 在弹出的管理窗口中,点击 mPaaS 组件管理,选择要进行管理的 module,勾选要添加的组件,点击 OK。如果您的工程中有多个 module,您可以在选择不同的 module 后,分别为其添加组件。
  3. 组件添加完成后,点击 OK

组件管理

操作步骤

  1. 点击 mPaaS > mPaaS Inside 接入、或 组件化接入,在弹出的接入面板中,点击配置/更新组件下的 开始配置
  2. 在弹出的组件管理窗口中,点击按钮安装需要的组件。

基础工具

基础工具中包含 热修复生成加密图片(专有云配置文件)生成控制台用签名 APK生成 UC Key 签名信息 等功能。

热修复

使用热修复能力前,首先要让 App 具备热修复的能力。更多详情,请参见 热修复管理:接入 Android——热修复

生成热修复补丁

使用 mPaaS 插件的 生成热修复补丁,通过以下步骤生成热修复包:

  1. 针对不同的 mPaaS 集成方式,选择对应的包,通过 mPaaS 插件的 生成热修复补丁 生成热修复包。
    • 如果是 原生 AAR 工程mPaaS Inside 工程,需要准备有 bug 的线上 .apk 包和修复后的 .apk 包。mPaaS 插件会根据代码的不同,生成热修复包。
      提示:
      • New bundle 栏,填写修复后的 apk 包的本地地址。
      • Old bundle 栏, 填写有 bug 的 apk 包的本地地址。
      • 白名单 一栏输入白名单。
    • 如果是 组件化(Portal&Bundle)工程,需要准备 正在使用的有 bug 的 bundle 包修复后的 bundle 包
      提示:
      • bundle 的输出路径为 bundle 的主 module 目录下的 build/intermediates/bundle/xxxx-raw.jar。如果是 release 包则没有 -raw
      • New bundle:选择修复 bug 的包路径。
      • Old bundle:选择有 bug 的包路径。
      • 白名单:选择用于指定修复的类的 .txt 格式的配置文件。该配置文件的编写规则见 白名单配置文件编写规则。 使用原生 AAR 工程和 mPaaS Inside 工程时强烈推荐使用该功能。
      • Patch file dir:输出的 patch 包路径。
      • 是否使用 dexPatch:选择是否使用 dexPatch 热修复方式。mPaaS 插件的 生成热修复补丁 功能支持 Andfix 和 dexPatch 两种热修复方式。不论使用哪种热修复方案,在发版本前都需要进行验证,查看热修复包是否能生效。
        • 不勾选时,会生成 Andfix 热修复包。Andfix 热修复包能够立即生效,不需要重启应用;但因机型问题,修复的场景限制较多。
        • 勾选时,会生成 dexPatch 热修复包。dexPatch 热修复包不能立即生效,需要杀掉进程后才能生效;但其能够修复的场景比 Andfix 热修复包多,且机型适配问题少。
  2. 输入签名信息生成热修复包。
    注意:生成热修复包所需要的签名文件必须和运行的 .apk 的签名文件保持一致,并且签名文件和生成图片选择的 .apk 的签名文件也要保持一致。生成的图片需要放在 Portal 工程的 res/drawable 文件夹下面,命名为 yw_1222.jpg
白名单配置文件编写规则

打热修复包时用于指定修复的类的配置文件为 .txt 格式,该配置文件应包含并按顺序包含以下信息:

  1. 需要 Patch 的类。以 L 开头,后跟以混淆后真实类名。如果多个类,每行只可写一个。
    示例:Lxxx.xxx.clazzX
  2. 设置 Patch 类型。为 dexpatch。
    示例:PatchType: dexpatch
  3. 设置是否是静态 Bundle。默认为 false,如果是静态链接的 Bundle,需要显式设置为 true
    示例:HostDex: true

您可查看 白名单配置文件编写示例 以帮助编写配置文件。

合并补丁

一个 Android App 版本最多只能有一个热修复包在运行。如果客户端某版本有两个 bug,那需要先在本地使用 合并补丁 功能将修正两个 bug 的热修复包合成一个热修复包。例如,针对某一个版本的 App 已经发过热修复包 A, 之后在这个版本上又发现了另外一个问题,这时可在本地生成另外一个热修复包 B,然后合并 A 与 B 两个热修复包,最后下发到客户端。

说明:本节仅针对使用组件化(Portal&Bundle)工程的用户,使用原生 AAR 工程和 mPaaS Inside 工程的用户可以在原先修复的基础上,相对于最原始未修复的包再打出一个补丁发布。
操作步骤
  1. 填写热修复包文件夹地址。
    • Merge dir:选择合并的 hotpatch 包目录。文件夹下面是所有的需要合并的包,包名需要以 .jar 或者 .apk 结尾。
    • Patch file dir:选择合并之后输出的热修复包目录。
  2. 配置签名信息。

合并完成后,将会收到合并成功的提醒。

生成加密图片(专有云配置文件)

为了安全,mPaaS 某些组件(如热修复)访问网络时需要对内容进行加密。具有特殊名称 yw_1222.jpg 的图片为加解密提供密钥信息。mPaaS 组件自动使用该图片进行加解密,无需额外操作。生成并使用加密图片 yw_1222.jpg 的详情如下。

准备

加密图片与 APK 的签名文件有绑定关系。因此,需要准备 Portal 工程签名之后的 APK。具体的签名步骤,请参考 Android 官方网站: 对应用进行签名

说明
  • 此处的 APK 应和 发布版本 的 APK 使用相同的签名文件。
  • 生成的加密图片只能用在该 APK 工程中。

生成

您可以通过 mPaaS 插件 生成加密图片。

  1. 在 Android Studio 中,点击 mPaaS > 基础工具 > 生成加密图片(专有云配置文件)
  2. Release Apk, 选择 Portal 工程签名之后的 apk 文件, RSA 会自动填充。
  3. mPaaS Config File, 选择 Portal 工程的 .config 文件, workSpaceIdappIdpackageName 会自动填充。如果没有,可以根据工程的 .config 文件中的配置填写到对应输入框中。
  4. 填写 appsecret
    注意:作为服务端管理人员,您可以从控制台中查询 appid 所对应的 appsecret
  5. jpg Version 栏,填写对应的无线保镖图片版本号。
    说明:查看 Portal 工程主 module 下 build.gradle 文件中 securityguard 版本,低于 5.4 的填 4(例如基线中给出的 securityguard-build:5.1.38.180402194514),其余填 5
  6. outPath, 选择无线保镖图片 yw_1222.jpg 的输出路径,即加密图片生成的本地路径。
  7. 点击 OK 生成加密图片。

使用

加密图片的使用步骤如下:

  1. 将加密图片 yw_1222.jpg 存放到 Portal 工程的 res/drawable 文件夹中。
  2. 如使用 ProGuard,需避免加密图片被混淆。
    1. 检查 build.gradle 中是否配置了如下内容:
      1. minifyEnabled true
      2. shrinkResources true
    2. 若有如上配置,为了避免加密图片被混淆,需要在 res/raw 下创建 keep.xml 文件。文件内容如下:
      1. <?xml version="1.0" encoding="utf-8"?>
      2. <resources xmlns:tools="http://schemas.android.com/tools"
      3. tools:keep="@drawable/yw_1222*" /><!--tools:discard="@layout/unused2"-->

生成控制台用签名 APK

在 mPaaS 控制台中获取配置文件时,需要上传签名后的 APK 文件(如下图所示)。但在未创建工程或未编译出签名后的 APK 时,获取配置文件的过程就会受阻而无法进行。为解决此问题,mPaaS 已将此过程简化为 Android Studio mPaaS 插件的 生成控制台用签名 APK 功能。该功能可在只需输入签名相关的参数的前提下,生成签名后的 APK。

生成

  1. 点击 mPaaS > 基础工具 > 生成控制台用签名 APK,进入 构造签名 APK 页面。

  2. 构造签名 APK 页面,填写相关配置信息。

  3. 点击 OK 即可生成签名后的 APK 文件。

  4. 点击 Reveal in Finder 即可找到上述步骤生成的 APK 文件,文件名为 mpaas-signed.apk。至此,签名后的 APK 生成成功。

    打开该 APK 文件查看,会发现该文件很小,且已经被签名。

生成 UC Key 签名信息

在 Android 应用中接入 UC SDK 能够有效解决各种厂商浏览器的兼容性问题。为添加 UC SDK,您需要先申请 UC SDK 的 key。该功能能够帮助您快速获得 key。

说明:
  • 该功能自 V2.20062211 版本起加入。更多信息,请参见 V2.20062211 发布说明
  • 该功能用于支持申请 UC SDK Key,下文 生成 介绍了申请 UC SDK Key 的全流程操作。

生成

  1. 在工程中,添加 UC内核(UCCORE) 依赖。
  2. 提供应用的 Android native package 名称(package name)。
  3. 点击 mPaaS > 基础工具 > 生成 UC Key 签名信息,进入 查询签名信息 页面。
  4. 查询签名信息 页面,填写相关配置信息。点击 Next
  5. 复制获得的 SHA1 信息。
  6. 登录控制台,进入 提交工单 页面,提供 Android native package nameSHA1 值 以获取 UC SDK 的 key。
    说明:创建工单时,选择 问题所属产品移动开发平台 mPaaS(在 更多产品与服务问题 > 开发者工具 菜单下),选择问题分类为 开发框架-开发框架-Android 开发框架接入。在填写工单信息时,除了必填的个人联系方式外,在 问题描述 中填写 申请 UC SDK 的 key,用于填写 Android native package name 和 SHA1 的值。
  7. 将获取的 Key 填入 Portal 项目的 AndroidManifest.xml 文件中:
    <meta-data android:name="UCSDKAppKey" android:value="您申请获得的 key"/>
    说明:UC SDK 的授权信息与 apk 的 包名 以及 签名 绑定。因此,如果 UCWebView 没有生效,检查签名和包名与申请时使用的信息是否一致。

帮助

日志诊断工具

  1. 点击 mPaaS > 帮助 > 日志诊断工具
  2. 将您需要分析的日志信息 copy 到输入框,点击 Next
  3. 等待分析结果。
  4. 查看分析结果。

    分析结果中主要包含定位原因解决方案,您可以根据具体的定位信息和解决方案来修改您的代码。

  5. 修改完成后点击 Finish 关闭弹窗。

常见问题

点击 mPaaS > 帮助 > 常见问题,即可跳转至 接入 Android 常见问题,查看接入过程中的常见问题。

查看文档

点击 mPaaS > 帮助 > 查看文档,即可跳转至 mPaaS 文档中心,查看各组件的使用文档。

构建

  1. 在 Android Studio 中选择 mPaaS > 构建。即可构造工程。