XuqmGroup-Web/docs-site/docs/harmony/setup.md
2026-07-27 09:58:25 +08:00

1.8 KiB

HarmonyOS 安装配置

包名@xuqm/harmony-sdk · 版本0.1.0 · 语言ArkTS


ohpm 安装

在 HarmonyOS 项目的 oh-package.json5 中添加:

{
  "dependencies": {
    "@xuqm/harmony-sdk": "^0.1.0"
  }
}

然后执行:

ohpm install

发布仓库:https://ohpm.openharmony.cn/ohpm/


最低 API 版本

  • API 12+HarmonyOS 4.0+
  • DevEco Studio 4.0 Release 或更高版本

权限配置

module.json5 中声明所需权限:

{
  "module": {
    "requestPermissions": [
      {
        "name": "ohos.permission.INTERNET"
      },
      {
        "name": "ohos.permission.GET_NETWORK_INFO"
      }
    ]
  }
}

如需使用相机、相册、麦克风等功能,额外添加:

{
  "module": {
    "requestPermissions": [
      {
        "name": "ohos.permission.CAMERA"
      },
      {
        "name": "ohos.permission.READ_MEDIA"
      },
      {
        "name": "ohos.permission.WRITE_MEDIA"
      },
      {
        "name": "ohos.permission.MICROPHONE"
      }
    ]
  }
}

配置文件

从平台控制台下载应用的 .xuqmconfig 配置文件(例如 识校宝.xuqmconfig),放置到 src/main/resources/rawfile/config/ 目录,随 HAP 一起打包。SDK 启动时会自动扫描该目录并读取配置,无需手动指定路径。

文件名不限,只要扩展名为 .xuqmconfig 即可。


初始化

import { XuqmSDK } from '@xuqm/harmony-sdk'
import common from '@ohos.app.ability.common'

// 在 EntryAbility.onCreate 或页面初始化时
const context = getContext(this) as common.UIAbilityContext
await XuqmSDK.init(context, {
  appKey: 'your_app_key',
})

登录

const session = await XuqmSDK.login('user_001', 'your_user_sig_jwt')

下一步