XuqmGroup fb82e4b8b6 docs(sdk): 添加 Android SDK 文档和 API 设计规范

- 新增 Android SDK 使用文档，包含模块结构、集成方式和快速开始指南
- 添加 SDK API 重设计规范，统一初始化和登录接口设计
- 补充安全设计规范，完善 UserSig 鉴权和敏感数据处理方案
- 创建平台 REST API 规范，定义服务端到服务端的调用接口
- 添加离线推送架构设计，集成各大厂商推送服务与 IM 联动方案

2026-04-29 15:46:40 +08:00

3.3 KiB

原始文件 永久链接 Blame 文件历史

HarmonyOS SDK 概览

包名：@xuqm/harmony-sdk · 版本：0.1.0 · 支持：HarmonyOS NEXT（API 12+）、ArkTS

功能模块

模块	功能
`XuqmSDK`	全局初始化
`ImSDK`	单聊、群聊、消息收发
`UpdateSDK`	App 版本检查、RN Bundle 热更新

安装

在 oh-package.json5 中添加：

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

配置私有仓库（.ohpmrc）：

registry=https://nexus.xuqinmin.com/repository/ohpm-hosted/

执行安装：

ohpm install

快速接入

1. 初始化（EntryAbility.onCreate）

import { XuqmSDK } from '@xuqm/harmony-sdk'

export default class EntryAbility extends UIAbility {
  onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
    XuqmSDK.init({
      appKey:     'your_app_key',
      debug:      true,
    })
  }
}

2. IM 登录

import { ImSDK } from '@xuqm/harmony-sdk'

await ImSDK.login('user_001', '张三')

3. 监听消息

ImSDK.addListener({
  onConnected():         void { console.log('WS connected') },
  onDisconnected(reason: string | null): void { },
  onMessage(msg: ImMessage):  void { /* 处理消息 */ },
  onError(err: string):       void { },
})

4. 发送消息

// 文本消息
const sent = await ImSDK.sendMessage({
  toId:     'user_002',
  chatType: 'SINGLE',
  msgType:  'TEXT',
  content:  'Hello from HarmonyOS!',
})

// 图片消息
const sent = await ImSDK.sendMessage({
  toId: 'user_002', chatType: 'SINGLE',
  msgType: 'IMAGE',
  content: JSON.stringify({ url: 'https://cdn.example.com/img.jpg', width: 800, height: 600 }),
})

5. 撤回消息

const revoked = await ImSDK.revokeMessage(msg.id)

6. 群聊

const group = await ImSDK.createGroup('鸿蒙群', ['user_001', 'user_002'])
ImSDK.subscribeGroup(group.id)
const sent = await ImSDK.sendMessage({ toId: group.id, chatType: 'GROUP', msgType: 'TEXT', content: '大家好' })

7. 检查更新

import { UpdateSDK } from '@xuqm/harmony-sdk'

const appInfo = await UpdateSDK.checkAppUpdate(1)
if (appInfo?.marketUrl) {
  await UpdateSDK.openAppMarket(getContext(this), appInfo.marketUrl)
}

const bundle = await UpdateSDK.checkRNUpdate('home', '1.0.0')
if (bundle) {
  const content = await UpdateSDK.downloadBundle(bundle.downloadUrl)
  // 缓存至本地，由 BundleRuntime 加载
}

Harmony 的整包更新只提供应用市场跳转，不提供本地安装包下载。

ArkUI 示例

@Component
struct ChatView {
  @State messages: ImMessage[] = []

  aboutToAppear() {
    ImSDK.addListener({
      onMessage: (msg) => { this.messages = [...this.messages, msg] },
      onConnected: () => {},
      onDisconnected: () => {},
      onError: () => {},
    })
  }

  build() {
    Column() {
      List() {
        ForEach(this.messages, (msg: ImMessage) => {
          ListItem() {
            Text(`${msg.fromUserId}: ${msg.content}`)
              .fontSize(16)
              .padding(8)
          }
        })
      }
    }
  }
}

权限配置

在 module.json5 中添加必要权限：

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

3.3 KiB 原始文件 永久链接 Blame 文件历史 Unescape Escape