全部产品

接入流程

更新时间:2020-11-26 11:37:02

接入流程简介

如果采用 组件化接入方式,您需要完成以下通用步骤以完成接入流程:

  1. 配置开发环境
  2. 在控制台创建应用
  3. 客户端创建新工程
  4. 管理组件依赖
  5. 构建

客户端创建新工程

关于此任务

本文将以 Windows 开发环境为例,引导您在本地创建一个全新 App,并编译打包,最终获得可运行的 .apk 包。

前置条件

您首先需要:

  1. 配置开发环境
  2. 在控制台创建应用

创建 Portal 工程

如果您需要组件化方案,可以使用 Portal Bundle 方式,您首先需要创建一个 Portal 工程。

Portal 一般不包含业务代码,仅仅用于将各 Bundle 合并成一个可运行的 .apk 包。因此在创建 Portal 时,默认会创建一个后缀名为 Launcher 的 Bundle 工程。

具体创建步骤如下:

  1. 启动 Android Studio 后,在欢迎页面点击 Start a new mPaaS project

  2. Create New mPaaS Project 窗口中,选择 mPaaS Portal。点击 Next

  3. 填写 项目名称,在 控制台配置文件(JSON)路径选择 中选择从控制台 代码管理 > 代码配置 中下载到的 .config 配置文件,mPaaS 插件会根据选择的配置文件自动解析填写 Package Name 。点击 Next

  4. 选择 mPaaS SDK 版本,并勾选您需要的模块依赖。点击 Next 按钮。

    重要
    • 请按需勾选模块依赖。具体依赖信息,请参考各组件的接入文档。
    • 您也可以只选择框架必选依赖。在完成应用创建之后,再参考各组件的接入文档,使用 mPaaS 插件 > 组件管理 功能添加所需依赖。

  5. 确认默认创建的 Bundle 工程的信息。点击 Finish 按钮。

至此,您已完成 Portal 工程的创建,并同时获得一个默认创建的 Bundle 工程。

创建新的 Bundle 工程

mPaaS 框架支持多 Bundle,您可以为您的工程添加多个 Bundle 工程。

  1. 点击 File > New > Start a New mPaaS Project 菜单。

  2. Create New mPaaS Project 窗口中,选择 mPaaS Portal。点击 Next

  3. 填写 项目名称,在 控制台配置文件(JSON)路径选择 中选择从控制台 代码管理 > 代码配置 中下载到的 .config 配置文件,mPaaS 插件会根据选择的配置文件自动解析填写 Package Name 。点击 Next

  4. 选择 mPaaS SDK 版本,并勾选您需要的模块依赖。点击 Next 按钮。

  5. 确认默认创建的 Bundle 工程的信息。点击 Finish 按钮。

至此,您已完成 Bundle 工程的创建。关于 Bundle 开发的更多信息,请参见 Bundle 工程

后续步骤

您可以参考各组件的接入文档,接入并使用 mPaaS 组件

相关链接

组件化接入方式 > 简介:介绍 Portal 和 Bundle 工程的代码结构编译打包结果以及与原生工程的区别

管理组件依赖

说明:为了更便捷地升级 mPaaS SDK 基线和管理组件依赖,您需要先升级 Android Studio mPaaS 插件至最新版本。关于更新 mPaaS 插件的更多信息,请参见 更新 mPaaS 插件

管理组件依赖

为了使用 mPaaS 组件,您需要分别在 Portal 和 Bundle 工程中添加对应组件的依赖:

  • 在 Portal 工程中添加,将确保相应依赖在打包时打入您的 APK 。
  • 在 Bundle 工程中添加,将确保您能在 Bundle 工程中调用对应组件的 API 。
  • 对于单 Portal 工程模式,您只需在 Portal 工程中添加。
  • 如果您在创建 mPaaS 工程时已选择过需要使用的组件,您仍可以按照下文步骤增删组件。

操作步骤

在 Android Studio 中选择 mPaaS > 组件化接入,在弹出的接入面板中,点击 配置/更新组件 下的 开始配置

  1. 在弹出的组件管理窗口中,点击按钮安装需要的组件。
    • 对于未安装的组件,相应的按钮会显示“未安装”。点击该按钮会安装该组件。
    • 对于已经安装的组件,按钮会显示“已安装”。此时再点击该按钮将会卸载该组件。

后续步骤

如果您此前未使用过 Android Studio mPaaS 插件管理组件依赖,是您首次使用 组件管理 功能添加完组件后,您还需要检查或修改以下配置。

  1. 检查 Portal/Bundle 工程根目录 build.gradle 文件,确保包含以下依赖且不低于以下版本:
    1. buildscript {
    2. ...
    3. dependencies {
    4. classpath 'com.android.boost.easyconfig:easyconfig:2.4.3'
    5. }
    6. }
  2. 检查 Portal 工程主 module 下的 build.gradle 文件,确保包含以下内容:
    1. apply plugin: 'com.alipay.portal'
    2. portal {
    3. allSlinks true
    4. mergeAssets true
    5. }
    6. apply plugin: 'com.alipay.apollo.baseline.update'
    7. mpaascomponents{
    8. excludeDependencies=[]
    9. }
  3. 删除旧依赖:
    重要:强烈建议您在删除以下内容前先进行备份。
    • 对于 Portal + Bundle 模式,您需要在 Portal 工程主 module 下的 build.gradle 文件中删除 dependencies 节点下 mPaaS 组件相关依赖(mpaas-baseresjar 除外)。
    • 对于单 Portal 工程模式,您需要在主 module 下的 build.gradle 文件中删除以下内容:
      1. apply from: rootProject.getRootDir().getAbsolutePath() + "/mpaas_bundles.gradle"
      2. apply from: rootProject.getRootDir().getAbsolutePath() + "/mpaas_apis.gradle"
      并删除工程根目录下的 mpaas_bundles.gradlempaas_apis.gradle 文件,但需要注意,删除 mpaas_apis.gradle 文件可能导致编译失败,您需要按照下文在子 module 中修改配置。
  4. 如果您需要在子 module 中调用 mPaaS 组件 API:
    • 对于 Portal + Bundle 模式的工程,您需要在 Bundle 工程子 module 下的 build.gradle 文件中添加:
      1. apply plugin: 'com.alipay.apollo.baseline.update'
    • 对于单 Portal 工程模式,您需要在子 module 下的 build.gradle 文件中删除:
      1. apply from: rootProject.getRootDir().getAbsolutePath() + "/mpaas_apis.gradle"
      并添加:
      1. apply plugin: 'com.alipay.apollo.baseline.update'
  5. 如果旧依赖中有为您定制的库,您还需要 添加定制依赖
  6. 如果由于库冲突导致编译失败,您可以 解决依赖冲突

升级基线

  1. 在 Android Studio 中点击 mPaaS >组件化接入,在弹出的接入面板中,点击 接入/升级基线 下的 开始配置
  2. 点击版本下拉框,选择一个新版本,然后点击 OK 按钮,即可升级基线。

升级单个组件

新版

  1. 在 Android Studio 中选择 mPaaS > 组件升级,您将看到组件列表。
  2. 查看组件状态,进行升级操作,若右上角有提示可更新,那么点击之后就能更新了。
    组件升级

旧版

  1. 在 Android Studio 中选择 mPaaS > 组件升级,您将看到组件列表。
  2. 查看组件状态,进行升级操作:
    • 若为 最新版,则说明该组件无需升级。
    • 否则说明该组件有新版本。您可以点击状态按钮,升级该组件。
      Components Update

添加定制依赖

  • 如果您首次使用 组件管理 管理组件但未升级 SDK,您只需将定制库写在 Portal 工程主 module 下 build.gradle 文件中的 dependencies 节点下,例如:
    1. bundle 'com.alipay.android.phone.mobilesdk:logging-build:2.0.2.180322162837@jar'
    2. manifest 'com.alipay.android.phone.mobilesdk:logging-build:2.0.2.180322162837:AndroidManifest@xml'
  • 如果您首次使用 组件管理 管理组件且升级了 SDK,或使用 基线升级 升级了 SDK,您的定制库可能需要基于新版本重新定制,请 提交工单 或联系 mPaaS 支持人员确认,重新定制或确认无需重新定制后,您可按照上文添加定制依赖。

构建

使用 Android Studio mPaaS 插件提供的 构建 功能编译工程。