文档

创建 H5 离线包

更新时间:

在创建 H5 离线包资源时,您需要填写基本信息和配置信息。

前置任务

您已经在配置管理页面,完成 H5 离线包相关配置。详细信息,参见 配置离线包

关于此任务

您可以选择单个创建 H5 离线包,也可以选择以批量导入 H5 离线包文件的方式一次创建多个离线包。

在首次上传一个 H5App 的离线包时,您必须选择离线包的类型。一旦选择完成不可更改,每个 H5App 有且只有一个离线包类型。

操作步骤

创建单个离线包

进入 mPaaS 控制台,完成以下步骤:

  1. 点击左侧导航栏的 实时发布 > 离线包管理

  2. 在打开的离线包管理页面,点击 新建 H5App。(如果您已创建 H5App,可忽略此步。)

  3. 新建 H5App 窗口,填写 H5App ID H5App 名称,点击 确定。(如果您已创建 H5App,可忽略此步。)

    重要
    • H5App ID 为 8 位数字。

    • 20000196、66666692、68687029、68687209 是 SDK 内置的离线包 ID,H5App ID 建议不要使用,否则会发生冲突。

    • H5App ID 建议不要使用以 666666 或者 20000 开头的数字。

  4. 在 H5App 列表中,选择 H5App,然后点击离线包列表的右上方的 添加离线包 按钮,创建离线包。

  5. 基本信息 栏,完成以下配置:

    • 资源包类型:选择 全局资源包普通资源包

      说明

      若使用全局资源包需要在全局资源包中将二级目录名称修改为 mcube-prod.mpaascloud.com,否则将无法使用实时发布对接的加速能力。

    • 离线包版本号:填写离线包的版本号,例如 1.0.0.1。

    • 文件:上传离线包资源文件,文件格式为 .zip

    • 客户端生效范围:选择 App 对应的客户端类型,并设置版本范围。只有在此版本范围内的客户端,才能够得到推送的新版本离线包。

      说明
      • 至少选择一个客户端类型。若同时选择 Android 及 iOS,客户端最高版本策略需保持一致,即两个客户端均采用系统默认,或者均输入自定义值。

      • 最高版本为系统默认时表示支持后续所有新版本,建议采用系统默认,以免在客户端升级后版本高于填写的最高版本而使得离线包不生效。

      • iOS 客户端版本需低于客户端工程的 info.plist 文件中的 Product Version 字段。

  6. 配置信息 栏,完成以下配置:

    • 主入口 URL:选填,离线包的首页。

      说明

      需要填写完整的路径名,如:/www/index.html,其中,/www 为您自定义的二级目录的名称。

    • 虚拟域名:自动显示配置离线包时填写的虚拟域名。

    • 扩展信息:选填,填写页面加载参数,格式为 KV,用逗号(,)分隔多个 KV。

      mPaaS 支持配置 H5 离线包的请求时间间隔,可单个配置或全局配置。

      • 单个配置:即只对当前离线包配置。可在 扩展信息 中填入 {"asyncReqRate":"1800"} 来设置请求时间间隔。其中 1800 代表间隔时长,单位为秒,设置范围为 0 ~ 86400 秒(即 0 ~ 24 小时,0 代表无请求间隔限制)。

      • 全局配置:全局配置需在客户端代码中进行配置,请参见 接入 Android接入 iOS

    • 下载时机:选择用户下载该离线包的时机。

      • 若选择 仅 Wi-Fi,则只有在 Wi-Fi 网络时会在后台自动下载离线包。

      • 若选择 所有网络都下载,则在非 Wi-Fi 网络时会消耗用户流量自动下载,慎用。

    • 安装时机:选择用户安装该离线包的时机。

      • 若选择 不预加载,则只有进入离线包或小程序页面时才安装。

      • 若选择 预加载,则离线包或小程序下载完成后自动安装。

  7. 勾选 已确认以上信息准确,点击 提交,完成离线包创建。

批量导入离线包

如果需要创建多个离线包,为避免多个离线包配置时信息配置出错,提升发布效率,可选择以批量导入的方式进行创建。

  • 导入后,若离线包所属的 App 在系统中不存在,将默认创建一个 H5App。

  • 导入后,若离线包所属的 App 在系统中已存在,配置完成后,离线包将添加至该 H5App。

进入 mPaaS 控制台,完成以下步骤:

  1. 从左侧导航栏进入 实时发布 > 离线包管理 页面,点击 批量导入 H5 离线包

  2. 批量导入 H5 离线包 窗口中,根据提示上传 H5 离线包文件(.zip)。

    说明
    • 批量导入的离线包文件大小不能超过 300 MB,且离线包个数不能超过 100。

    • 每个离线包资源文件需以离线包 ID 命名。离线包 ID 为 8 位数字。

  3. 导入结果页以列表的形式显示成功加载的离线包,在导入结果页面,点击 操作 列的 编辑 按钮,编辑离线包的基本信息。具体配置项解释,请参考 创建单个离线包

    导入结果页面,离线包版本号默认遵循以下规则,您可以进行编辑。

    • 若离线包所属的 App 在系统中不存在,导入离线包的版本号默认为 0.0.0.1。

    • 若离线包所属的 App 在系统中已存在,导入离线包的版本号默认为最高版本的基础上 +1。

  4. 编辑完成所有离线包后,勾选 以上信息提交后不再支持修改,点击 提交。系统会对提交的离线包信息进行校验。若校验不通过,页面会出现错误提示;若校验通过,则 H5 离线包管理页面会展示相应的 H5 离线包信息,即表示离线包创建成功。

后续步骤

发布离线包

  • 本页导读 (0)
文档反馈