@ionic-native/app-version

本项目基于 @ionic-native/[email protected] 开发。

简介

一个用于读取用版本信息的插件，支持从目标构建设置中读取应用的版本号、应用名称、包名和构建标识符等信息。兼容Android、iOS和OpenHarmony平台，为跨平台应用开发提供统一的版本信息获取能力。本文档主要说明在OpenHarmony系统中的应用。

在移动应用开发中，版本信息展示是常见的功能需求，常用于关于页面版本号显示、版本检查更新等场景。@ionic-native/app-version插件通过封装原生平台API，为开发者提供了统一的跨平台接口，无需深入原生开发即可获取应用的版本相关信息。

支持平台

• OpenHarmony：5.0+

下载安装

通过命令行或手动引入即可快速安装插件，支持从npm仓库获取。

命令行安装（推荐）

安装hionic CLI：

npm install -g hionic

以下两种方式中任选其一即可，无需重复操作：

npm安装：

# 安装插件
npm install @ionic-native/app-version

# 同步插件
hionic sync

hionic CLI安装：

hionic plugin add @ionic-native/app-version

手动引入安装

1.添加插件配置

根据plugin.xml的config-json项，找到entry模块中config.xml文件，并根据param标签添加配置

<feature name="AppVersion">
  <param name="harmony-package" value="AppVersion" />
</feature>

2.修改 CMake 配置

根据plugin.xml的CMakeLists项，找到cordova模块，路径为target字段的文件CMakeLists.txt，添加add_library

add_library(cordova SHARED
  // ...
  AppVersion/AppVersion.cpp
  // ...
)

3.复制源码文件

根据plugin.xml的source-file项，将src字段的路径代码复制到cordova模块中target-dir字段的目录中：

将源码中src/main/cpp/AppVersion目录下的AppVersion.h、AppVersion.cpp文件引入到cordova模块中src/main/cpp/AppVersion目录下。

将源码中src/main/ets/components/AppVersion目录下的AppVersion.ets文件引入到cordova模块中src/main/ets/components/AppVersion目录下。

4.添加 ArkTS 配置

在cordova模块的build-profile.json5文件中，buildOption/arkOptions/runtimeOnly/sources配置项数组中加入步骤3中拷贝的ets文件路径:

"buildOption":{
  "arkOptions": {
    "runtimeOnly": {
      "sources": [
        // ...
        "./src/main/ets/components/AppVersion/AppVersion.ets"
        // ...
      ]
    }
  }
}

卸载

# hionic CLI卸载
hionic plugin remove @ionic-native/app-version

约束与限制

兼容性

在以下版本中已测试通过：

1. SDK: 5.0.5(17); IDE: DevEco Studio: 6.0.0; ROM: 5.1.0.150;

权限要求

不涉及

使用示例

示例1：获取应用信息

实现获取应用名称、包名、版本号和构建标识符的功能。

import { AppVersion } from "@ionic-native/app-version";

// 获取应用名称
const appName = await AppVersion.getAppName();
console.log('获取应用名称:', appName)

// 获取应用包名
const packageName = await AppVersion.getPackageName();
console.log('获取应用包名:', packageName)

// 获取版本号
const versionNumber = await AppVersion.getVersionNumber();
console.log('获取版本', versionNumber)

// 获取构建标识符
const versionCode = await AppVersion.getVersionCode();
console.log('获取构建标识符', versionCode)

使用说明

插件在全局对象 AppVersion 下暴露所有功能接口，使用前需确保设备就绪事件（deviceready）已触发。

1. 获取应用名称

返回应用的显示名称，例如："My Awesome App"。

方法签名

AppVersion.getAppName()

2. 获取应用包名

返回应用的包名，例如："com.example.myawesomeapp"。

方法签名

AppVersion.getPackageName()

3. 获取版本号

返回应用的版本号，例如："1.2.3"。

方法签名

AppVersion.getVersionNumber()

4. 获取构建标识符

返回应用的构建标识，如版本"1.2.3"生成10203

方法签名

AppVersion.getVersionCode()

目录结构

|---- 目录
|     |---- src/main  # 插件的实现代码
|           |---- cpp  # C++ 代码
|           |---- ets  # ArkTS 代码
|     |---- www    # Web 侧代码
|     |---- README.md          # 说明文档
|     |---- package.json       # 配置文件
|     |---- plugin.xml         # 插件配置文件

贡献代码

使用过程中发现任何问题都可以提 Issue，当然，也非常欢迎发 PR 共建。

许可证

本插件基于 Apache License 2.0 开源，详见 LICENSE 文件。