【HarmonyOS 5】应用更新功能详解

关键词：#HarmonyOS SDK应用服务、#Appgallery connect、#应用更新

在应用开发场景中，功能迭代与调整是常态。为确保用户使用体验不受影响，应用内更新弹窗提示是兼顾稳定性与迭代需求的优选方案。这类弹窗主要用于向用户推送新版本更新通知，而在引导用户完成更新操作的实现层面，HarmonyOS 提供了完善的应用市场能力支撑，例如本文所介绍的 updateManager（更新功能） ，当存在新版后会展示应用更新弹窗，点击立即更新则直接跳转至应用市场详情页面，可高效实现版本更新的全流程引导。

效果演示：

其他：

updateManager 不支持应用强制更新，当应用出现重大安全隐患后请及时进行应用下架或后端整改工作。
应用内不得自行开发拦截用户正常使用应用功能相关的更新弹窗，上架审核将被拒审，具体可参考应用审核指南：文档中心-应用功能

检测新版本

1.导入 updateManager 模块及相关公共模块。

python 复制代码

import { updateManager } from '@kit.StoreKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import type { common } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

2.调用 updateManager.checkAppUpdate 接口，传入上下文。

javascript 复制代码

/**
 * 检查应用是否存在新版本
 */
export function checkAppUpdate() {
  try {
    let context: common.UIAbilityContext = getContext() as common.UIAbilityContext;
    updateManager.checkAppUpdate(context)
      .then((checkResult: updateManager.CheckUpdateResult) => {
        // 应用存在新版本
        if (checkResult.updateAvailable == updateManager.UpdateAvailableCode.LATER_VERSION_EXIST) {
          // TODO：展示更新弹窗
        }
        // 应用不存在新版本 checkResult.updateAvailable == updateManager.UpdateAvailableCode.LATER_VERSION_NOT_EXIST
        SSLogger.info("Succeeded in checking Result updateAvailable:" + checkResult.updateAvailable);
      }).catch((error: BusinessError) => {
      SSLogger.info(`checkAppUpdate onError.code is ${error.code}, message is ${error.message}`);
    });
  } catch (error) {
    SSLogger.info(`checkAppUpdate onError.code is ${error.code}, message is ${error.message}`);
  }
}

checkResult.updateAvailable 返回值解释：

名称	值	说明
LATER_VERSION_NOT_EXIST	0	不存在新版本。
LATER_VERSION_EXIST	1	存在新版本。

展示更新弹窗

需要注意的是：在未调用 checkAppUpdate 接口的情况下，调用 showUpdateDialog 接口将会返回为 1 的状态码，更新弹窗将无法展示，s所以需要确保在 checkAppUpdate 接口调用后，且返回存在新版本状态后再调用 showUpdateDialog 接口。

1.导入 updateManager 模块及相关公共模块。

python 复制代码

import { updateManager } from '@kit.StoreKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import type { common } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

2.调用 updateManager.showUpdateDialog 接口，传入上下文。

javascript 复制代码

/**
 * 展示应用更新弹窗
 */
export function showUpdateDialog() {
  let context: common.UIAbilityContext = getContext() as common.UIAbilityContext;
  try {
    updateManager.showUpdateDialog(context)
      .then((resultCode: updateManager.ShowUpdateResultCode) => {
        // 应用更新弹窗展示成功 resultCode == updateManager.ShowUpdateResultCode.SHOW_DIALOG_SUCCESS
        // 应用更新弹窗展示失败 resultCode == updateManager.ShowUpdateResultCode.SHOW_DIALOG_FAILURE
        SSLogger.info("Succeeded in showing UpdateDialog resultCode:" + resultCode);
      })
      .catch((error: BusinessError) => {
        SSLogger.info(`showUpdateDialog onError.code is ${error.code}, message is ${error.message}`);
      });
  } catch (error) {
    SSLogger.info(`showUpdateDialog onError.code is ${error.code}, message is ${error.message}`);
  }
}

resultCode 返回值解释：

名称	值	说明
SHOW_DIALOG_SUCCESS	0	显示升级弹框成功。
SHOW_DIALOG_FAILURE	1	显示升级弹框失败。

弹窗更新描述配置

其中弹窗内更新详情文案由应用上架时所填写的内容。

在 AGC "可本地化基础信息"区域，配置应用介绍、一句话简介、新版本特性，其中新版本特性将在更新弹窗中展示。

参数	说明
应用介绍	必填。简单描述该应用的功能、产品定位等，8000字以内。
应用一句话简介（小编推荐）	必填。简单介绍该应用，应突出应用的主要特色，以帮助提升应用下载率。要求17字以内。
新版本特性	选填。描述新版本的特性，500字以内。新版本特性将在华为应用市场客户端更新页中展示，认真填写可增加应用的下载量。