【OpenHarmony】 鸿蒙网络请求库之@xmpp/client

简介

@xmpp/client 是一个用于构建基于XMPP（可扩展通讯和即时消息传递协议）的客户端的 库。XMPP是一种开放标准的通信协议，通常用于实现即时通讯和在线实时交流。本库基于 xmpp.js 原库0.13.1版本进行适配，使其可以运行在 OpenHarmony，并沿用其部分现有用法和特性。

已支持功能

• xmpp与服务端建立连接
• xmpp与服务端重连
• xmpp与服务器断连
• xmpp与服务端进行通讯
• xmpp监听登录状态回调
• xmpp监听错误回调
• xmpp监听当前状态回调

下载安装

1. 安装命令如下：

 ohpm install @xmpp/client

需要权限

ohos.permission.INTERNET
ohos.permission.GET_NETWORK_INFO

接口和属性列表

接口列表

接口	参数	功能
let xmpp=client(options:Options)	Options：连接配置项	配置连接参数
xmpp.on('error',(err)=>{})	'error':string	监听错误信息回调
xmpp.on('online',async(address)=>{})	'online':string	监听在线信息回调
xmpp.on('status',（status，value）=>{})	'status':string	监听状态，回调给出当前状态
xmpp.on('stanza',(stanza)=>{})	'stanza':string	监听消息以及其他操作
xmpp.start()	无	开始连接
xmpp.send(xml({}))	xml:xml实例	以xml格式的方式发送消息
xmpp.stop()	无	断开连接

使用示例

因为xmpp是基于XMPP协议的通信库，所以应连接基于XMPP协议的服务器，本地测试选用的是openfire作为xmpp测试服务端，需要测试通讯功需要用到Spark(Spark 是一个开源的、跨平台的即时通讯客户端，基于 XMPP 协议，提供了丰富的即时通讯功能和易用的用户界面)。

配置openfire

（1）访问Openfire官网：https://www.igniterealtime.org/projects/openfire/，选择合适的操作系统进行下载。

（2）选择服务器设置（选默认.注意数据库如果没有配置外部数据库，则选嵌入式数据库）。

（6）登录到：Openfire 管理界面。

（7）用amdin账户登录，选择服务器设置，可以查看此服务器的名称、主机名。

（8）选择用户/用户群->新建用户->输入用户信息。

使用spark

（1）下载地址：Ignite Realtime: Spark IM Client 下载合适操作系统软件。

（2）使用刚在openfire中的新建的用户进行登录

import {client, xml, Options } from '@xmpp/client';

@Entry
@Component
struct Index {
  @State status: string = "offline";
  @State message: string = 'Hello World';
  @State sendMessage: string = ""
  @State contact: string = ""
  private options: Options = {
    service: 'xmpp://xx.xx.xx.xx:xxxx/', //xx.xx.xx.xx(服务器地址) xxxx 服务端口
    domain: 'xx.xx.xx.xx',               //服务器名称(xx.xx.xx.xx)
    resource: 'xx.xx.xx.xx',             //主机名(默认为服务器地址)
    username: "xxx",					 //openfire注册用户的用户名
    password: "xxx"				         //openfire注册的用户密码
  }
  private xmpp = client(this.options); //创建xmpp实例

  private xmpp = client(this.options); //连接服务

  private onError = (err: Error) => {
    console.info('xmpp-❌', JSON.stringify(err.message));
  }
  private onOffline = () => {
    console.info('xmpp--', 'offline');
  }
  private onStanza = (stanza: ESObject) => {
    this.contact = stanza.attrs.from
    if (stanza.is('presence') && stanza.attrs.type === 'subscribe') {
      this.contact = stanza.attrs.from
      this.xmpp.send(xml('presence', { to: stanza.attrs.from, type: 'subscribed' }));
    }
    if (stanza.is('message') && stanza.attrs.from !== this.xmpp.jid) {
      stanza.children.forEach((child: ESObject) => {
        if (child.name === 'body') {
          console.log("xmpp---message" + child.text())
          this.message = child.text()
        }
      });
    }
  }
  private onStatus = (status: string, value: string) => {
    this.status = status
    console.info("xmpp-response --" + "status--" + status + "---value---" + value)
  }
  private onLine = async (address: ESObject) => {
    console.log('🗸', 'online as', address);
    const presence = xml(
      'presence',
      {},
      xml('show', {}, 'chat'),
      xml('status', {}, 'presence!')
    );
    this.xmpp.send(presence);
  }

  aboutToAppear() {
    this.xmpp.on('error', this.onError);
    this.xmpp.on('offline',this.onOffline);
    this.xmpp.on('status', this.onStatus);
    this.xmpp.on('online', this.onLine);
    this.xmpp.on('stanza',this.onStanza);
  }

  aboutToDisappear(){
    this.xmpp.off('error',this.onError)
    this.xmpp.off('offline',this.onOffline)
    this.xmpp.off('status',this.onStatus)
    this.xmpp.off('online',this.onLine)
    this.xmpp.off('stanza',this.onStanza)
  }

  build() {
    Row() {
      Column() {
        Text("当前状态：" + this.status)
          .fontSize(30)
          .fontWeight(FontWeight.Bold)
        Text("收到消息：" + this.message)
          .fontSize(30)
          .fontWeight(FontWeight.Bold)
          .margin({ top: 30 })
        Button("连接").fontSize(30)
          .width("60%")
          .onClick(() => {
            this.xmpp.start();
          }).margin({ top: 30 })
        TextInput({ placeholder: "请输入消息" })
          .margin({ top: 30 })
          .fontSize(30)
          .width("60%")
          .height(100)
          .onChange((value: string) => {
            this.sendMessage = value;
          })


        Button("发送").fontSize(30)
          .width("60%")
          .onClick(() => {
            const message = xml("message", { type: "chat", to: this.contact }, xml("body", {}, this.sendMessage));
            this.xmpp.send(message)


          }).margin({ top: 30 })
      
        Button("断开").fontSize(30)
          .width("60%")
          .onClick(() => {
            try {
              this.xmpp.stop();
            } catch (e) {
              console.info("xmpp ---- error -" + e.toString())
            }
          }).margin({ top: 30 })
      }
      .width('100%')
    }
    .height('100%')
  }
}

DD一下：欢迎大家关注工粽号<程序猿百晓生>，可以了解到以下知识点。

`欢迎大家关注工粽号<程序猿百晓生>，可以了解到以下知识点。`
1.OpenHarmony开发基础
2.OpenHarmony北向开发环境搭建
3.鸿蒙南向开发环境的搭建
4.鸿蒙生态应用开发白皮书V2.0 & V3.0
5.鸿蒙开发面试真题（含参考答案） 
6.TypeScript入门学习手册
7.OpenHarmony 经典面试题(含参考答案)
8.OpenHarmony设备开发入门【最新版】
9.沉浸式剖析OpenHarmony源代码
10.系统定制指南
11.【OpenHarmony】Uboot 驱动加载流程
12.OpenHarmony构建系统--GN与子系统、部件、模块详解
13.ohos开机init启动流程
14.鸿蒙版性能优化指南
.......

使用说明

xmppAPI

通过配置client参数创建xmpp实例

xmpp=client(options)

 private options: Options = {
    service: 'xmpp://xx.xx.xx.xx:xxxx/', //xx.xx.xx.xx(服务器地址) xxxx 服务端口
    domain: 'xx.xx.xx.xx',               //服务器名称(xx.xx.xx.xx)
    resource: 'xx.xx.xx.xx',             //主机名(默认为服务器地址)
    username: "xxx",					 //openfire注册用户的用户名
    password: "xxx"				         //openfire注册的用户密码
  }
  private xmpp = client(this.options); //创建xmpp实例

监听错误回调

为方便起见，为所有支持的请求方法提供了别名。 异常监听

  private onError = (err: Error) => {
    console.info('xmpp-❌', JSON.stringify(err.message));
  }
  
  this.xmpp.on('error', this.onError);

状态监听

监听状态回调

 private onStatus = (status: string, value: string) => {
    this.status = status
    console.info("xmpp-response --" + "status--" + status + "---value---" + value)
  }
  this.xmpp.on('status', this.onStatus);

• message（消息）

• presence（在线状态）

   private onStanza = (stanza: ESObject) => {
    this.contact = stanza.attrs.from
    if (stanza.is('presence') && stanza.attrs.type === 'subscribe') {
      this.contact = stanza.attrs.from
      this.xmpp.send(xml('presence', { to: stanza.attrs.from, type: 'subscribed' }));
    }
    if (stanza.is('message') && stanza.attrs.from !== this.xmpp.jid) {
      stanza.children.forEach((child: ESObject) => {
        if (child.name === 'body') {
          console.log("xmpp---message" + child.text())
          this.message = child.text()
        }
      });
    }
  }
  this.xmpp.on('stanza',this.onStanza)
  

发送消息

xmpp.send(xml)

const message = xml("message", { type: "chat", to: "JID" }, xml("body", {}, this.sendMessage));
//此示例为 message：这条xml发送一条消息，类型chat是聊天，to后跟的参数为JID，"body"后为要发送的信息

错误码

• 错误常量

名称	参数类型	可读	可写	说明
Address already in use	number	是	否	地址已经被使用
Connection timed out	number	是	否	连接超时
Parameter error	number	是	否	参数错误
Permission denied	number	是	否	没有权限

DD一下：欢迎大家关注工粽号<程序猿百晓生>，可以了解到以下知识点。

`欢迎大家关注工粽号<程序猿百晓生>，可以了解到以下知识点。`
1.OpenHarmony开发基础
2.OpenHarmony北向开发环境搭建
3.鸿蒙南向开发环境的搭建
4.鸿蒙生态应用开发白皮书V2.0 & V3.0
5.鸿蒙开发面试真题（含参考答案） 
6.TypeScript入门学习手册
7.OpenHarmony 经典面试题(含参考答案)
8.OpenHarmony设备开发入门【最新版】
9.沉浸式剖析OpenHarmony源代码
10.系统定制指南
11.【OpenHarmony】Uboot 驱动加载流程
12.OpenHarmony构建系统--GN与子系统、部件、模块详解
13.ohos开机init启动流程
14.鸿蒙版性能优化指南
.......

目录结构

|---- @xmpp/client 
|     |---- entry  # 示例代码文件夹
|     |---- library_client  # XMPP客户端库文件夹
|     |---- library_client_core  # XMPP客户端核心功能实现
|     |---- library_connection  # 负责处理XMPP连接的子包
|     |---- library_connection_tcp  # 负责处理基于TCP协议的XMPP连接的子包
|     |---- library_iq  # 负责处理XMPP IQ(信息/查询)请求的子包
|     |---- library_middleware  # 负责处理中间件的子包
|     |---- library_reconnect  # 负责处理XMPP连接断线重连的子包
|     |---- library_resolve  # 用于解析XMPP地址的子包
|     |---- library_resource_binding  # xmpp.js库中负责处理XMPP资源绑定的子包
|     |---- library_sasl  # 负责处理XMPP SASL（Simple Authentication and Security Layer）身份验证的子包
|     |---- library_sasl_anonymous  # xmpp.js库中负责处理XMPP匿名身份验证的子包
|     |---- library_sasl_plain  # 用于XMPP（Extensible Messaging and Presence Protocol，可扩展消息和在线状态协议）的 SASL（Simple Authentication and Security Layer，简单身份验证和安全层）插件
|     |---- library_sasl_scram_sha_1  # SCRAM-SHA-1 认证机制的封装包
|     |---- library_session_establishment  # XMPP客户端开发中的核心部分
|     |---- library_stream_features  # 客户端和服务器之间建立连接时交换能力
|     |---- library_stream_management  # 封装处理 XMPP 流管理功能
|     |---- library_tcp  # 封装TCP 进行 XMPP 通信
|     |---- library_uri  # 封装处理 XMPP URI 的逻辑
|     |---- library_websocket  # 封装了 WebSocket 协议和 XMPP 协议的相关逻辑
|     |---- library_xml  # 处理 XMPP 协议中的 XML 数据
|     |---- library_ltx  # 快速XML构建器、解析器、序列化和操作库
|     |---- README.md  # 安装使用方法

约束与限制

在下述版本验证通过：

• DevEco Studio 版本： 5.0.3.200 OpenHarmony SDK:API12 (5.0.0.22-Canary2)