管理中心
我的

鸿蒙网络编程系列1-UDP通讯示例

浏览3219发布于2024-04-06 11:12未知归属地
本文章最后由 长弓三石 于 2024-10-18 00:56 编辑

1. UDP简介

UDP协议是传输层协议的一种,它不需要建立连接,是不可靠、无序的,相对于TCP协议报文更简单,在特定场景下有更高的数据传输效率,在现代的网络通讯中有广泛的应用,以最新的HTTP/3为例,它是基于QUIC(Quick UDP Internet Connections)协议的,从协议名字就不难看出,这个基础协议也是UDP的,现在就扔掉对UDP的偏见,深入、彻底的了解UDP,从而更好地掌握鸿蒙网络编程。

2. UDP通讯的常用方法

鸿蒙封装的UDP操作类位于模块socket中,使用如下的方式导入:

import socket from '@ohos.net.socket';

        socket模块包括了众多的UDP操作方法,就本文而言,重点需要掌握的是如下四个:

1)constructUDPSocketInstance(): UDPSocket

创建一个UDPSocket对象,在使用UDPSocket的方法以前需要创建该对象。

2)bind(address: NetAddress): Promise<void>

绑定IP地址和端口,端口可以指定或由系统随机分配,可以使用0.0.0.0表示本机IP地址;使用Promise方式作为异步方法。

3)send(options: UDPSendOptions): Promise<void>

通过UDPSocket连接发送数据,因为UDP是无连接的,给定IP地址和端口即可发送数据,不用考虑对方是否真的存在;使用Promise方式作为异步方法。

4)on(type: 'message', callback: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>): void

订阅UDPSocket连接的接收消息事件,当套接字接收到消息时触发该事件,其中message表示接收到的消息,remoteInfo是发送方信息;使用callback方式作为异步方法。

除了这些方法,为了得到系统IP地址,还使用了wifiManager模块的getIpInfo方法,该方法并不是UDP通讯必须的,就不详细介绍了。

3. UDP通讯示例

为演示UDP通讯的方式,本示例实现了一个使用UDP协议发送、接收消息的功能,运行后的界面如下所示:

cke_203578.png

下面详细介绍创建该应用的步骤。

步骤1:创建Empty Ability项目。

步骤2:在module.json5配置文件加上对权限的声明:

"requestPermissions": [

      {

        "name": "ohos.permission.INTERNET"

      },

      {

        "name": "ohos.permission.GET_WIFI_INFO"

      }

    ]

这里分别添加了访问互联网和访问WIFI信息的权限。

步骤3:在Index.ets文件里添加如下的代码:

收起
自动换行
深色代码主题
复制
import socket from '@ohos.net.socket';
import wifiManager from '@ohos.wifiManager';
import systemDateTime from '@ohos.systemDateTime';
import util from '@ohos.util';

//执行UDP通讯的对象
let udpSocket = socket.constructUDPSocketInstance();

//说明:本地的IP地址不是必须知道的,绑定时绑定到IP:0.0.0.0即可,显示本地IP地址的目的是方便对方发送信息过来
//本地IP的数值形式
let ipNum = wifiManager.getIpInfo().ipAddress
//本地IP的字符串形式
let localIp = (ipNum >>> 24) + '.' + (ipNum >> 16 & 0xFF) + '.' + (ipNum >> 8 & 0xFF) + '.' + (ipNum & 0xFF);

@Entry
@Component
struct Index {
  //连接、通讯历史记录
  @State msgHistory: string = ''
  //要发送的信息
  @State sendMsg: string = ''
  //本地端口
  @State localPort: number = 9990
  //目的IP地址
  @State targetIp: string = "0.0.0.0"
  //目的端口
  @State targetPort: number = 9990
  scroller: Scroller = new Scroller()

  build() {
    Row() {
      Column() {
        Text("UDP通讯示例")
          .fontSize(14)
          .fontWeight(FontWeight.Bold)
          .width('100%')
          .textAlign(TextAlign.Center)
          .padding(10)

        Flex({ justifyContent: FlexAlign.Start, alignItems: ItemAlign.Center }) {
          Text("本地IP和端口:")
            .width(110)
            .fontSize(14)
            .flexGrow(0)
          Text(localIp)
            .width(80)
            .fontSize(14)
            .flexGrow(0)
          TextInput({ text: this.localPort.toString() })
            .type(InputType.Number)
            .onChange((value) => {
              this.localPort = parseInt(value)
            })
            .width(100)
            .flexGrow(3)

          Button("绑定")
            .onClick(() => {
              this.bind2Port()
            })
            .width(80)
            .fontSize(14)
            .flexGrow(0)

        }.width('100%')
        .padding(10)

        Flex({ justifyContent: FlexAlign.Start, alignItems: ItemAlign.Center }) {
          Text("对端IP和端口:")
            .fontSize(14)
            .width(110)
            .flexGrow(1)

          TextInput({ text: this.targetIp })
            .onChange((value) => {
              this.targetIp = value
            })
            .width(100)
            .flexGrow(4)

          Text(":")
            .width(5)
            .flexGrow(0)

          TextInput({ text: this.targetPort.toString() })
            .type(InputType.Number)
            .onChange((value) => {
              this.targetPort = parseInt(value)
            })
            .flexGrow(2)
            .width(60)
        }
        .width('100%')
        .padding(10)

        Flex({ justifyContent: FlexAlign.Start, alignItems: ItemAlign.Center }) {

          TextInput({ placeholder: "输入要发送的消息" }).onChange((value) => {
            this.sendMsg = value
          })
            .width(200)
            .flexGrow(1)

          Button("发送")
            .width(80)
            .flexGrow(0)
            .onClick(() => {
              this.sendMsg2Target()
            })
        }
        .width('100%')
        .padding(10)

        Scroll(this.scroller) {
          Text(this.msgHistory)
            .textAlign(TextAlign.Start)
            .padding(10)
            .width('100%')
            .backgroundColor(0xeeeeee)
        }
        .align(Alignment.Top)
        .backgroundColor(0xeeeeee)
        .height(300)
        .flexGrow(1)
        .scrollable(ScrollDirection.Vertical)
        .scrollBar(BarState.On)
        .scrollBarWidth(20)
      }
      .width('100%')
      .justifyContent(FlexAlign.Start)
      .height('100%')
    }
    .height('100%')
  }

  //发送消息到目的ip和端口
  sendMsg2Target() {
    //目的ip和端口
    let remoteAddress = { address: this.targetIp, port: this.targetPort, family: 1 }
    udpSocket.send({ data: this.sendMsg, address: remoteAddress })
      .then(async () => {
        this.msgHistory += "我:" + this.sendMsg + await getCurrentTimeString() + "\r\n"
      })
      .catch((e) => {
        this.msgHistory += '发送失败' + e.message + "\r\n";
      })
  }

  //绑定本地端口
  async bind2Port() {
    //本地地址
    let localAddress = { address: "0.0.0.0", port: this.localPort, family: 1 }

    await udpSocket.bind(localAddress)
      .then(() => {
        this.msgHistory = 'bind success' + "\r\n";
      })
      .catch((e) => {
        this.msgHistory = 'bind fail' + e.message + "\r\n";
      })

    //收到消息时的处理
    udpSocket.on("message", async (value) => {
      let msg = buf2String(value.message)
      let remoteIP = value.remoteInfo.address
      let remotePort = value.remoteInfo.port.toString()
      //对端ip地址和端口的字符串形式
      let remoteAddr = "[" + remoteIP + ":" + remotePort + "]:"
      let time = await getCurrentTimeString()
      this.msgHistory += remoteAddr + msg + time + "\r\n"
      this.scroller.scrollEdge(Edge.Bottom)
    })
  }
}

//同步获取当前时间的字符串形式
async function getCurrentTimeString() {
  let time = ""
  await  systemDateTime.getDate().then(
    (date) => {
      time = date.getHours().toString() + ":" + date.getMinutes().toString()
      + ":" + date.getSeconds().toString()
    }
  )
  return "[" + time + "]"
}

//ArrayBuffer转utf8字符串
function buf2String(buf: ArrayBuffer) {
  let msgArray = new Uint8Array(buf);
  let textDecoder = util.TextDecoder.create("utf-8");
  return textDecoder.decodeWithStream(msgArray)
}

步骤4:编译运行。如果通过模拟器来部署运行,需要使用远程模拟器

cke_315118.png

使用本地模拟器可能会有网络问题。

另外,使用模拟器的时候要确保打开WIFI,可以通过设置->WLAN页面开启。

步骤5:配置本地端口和对端IP地址和端口,然后单击绑定按钮绑定到本地指定的端口,再单击发送按钮发送消息。可以根据实际需要配置,如果没有对端的UDP应用,把本应用作为对端也可以,也就是相当于自己给自己发送消息,最后自己再接收,如图所示:

cke_416491.png

​这样就完成了一个简单的UDP消息发送应用。

(本文作者原创,除非明确授权禁止转载)

本文源码地址:

https://gitee.com/zl3624/harmonyos_network_samples/tree/master/code/udp/UdpDemo

本系列源码地址:

https://gitee.com/zl3624/harmonyos_network_samples

收藏
4
回复
22
分享
全部评论
authorIcon
白白
发送消息之后怎么持续监听收到的消息啊,就是发送消息之后只收听不回复
回复于2024-11-29 09:55湖北
authorIcon
BenYu
学习,感觉要学的东西很多啊
回复于2024-10-01 01:02北京
authorIcon
134******70
同一个实例支持绑定两个不同的端口吗,还是需要new两个实例
1
回复于2024-08-16 06:42河南
authorIcon
长弓三石
一个socket只能绑定一个,多个端口需要多个实例
回复于2024-08-16 07:22江苏
authorIcon
134******70
接受消息的时候为什么会偶尔接受不到,一会能一会不能的
3
回复于2024-08-16 01:34河南
authorIcon
长弓三石
回复134******70
心跳机制解决不了可靠性问题。 发送的时候可以要求对方回复确认,如果给定时间没有收到确认,就重发,当时,实际实现起来还是很复杂的。
回复于2024-08-16 02:34江苏
authorIcon
134******70
回复长弓三石
您好,可以再加个心跳机制吗,客户端发送
回复于2024-08-16 02:18河南
authorIcon
长弓三石
UDP是不可靠的传输,不保证一定收到,可以通过别的机制比如发送确认来实现可靠传输
回复于2024-08-16 01:47江苏
authorIcon
156******85
感谢知识的分享,对一些对网络知识模糊的地方有很大帮助。特别是重点设置本机ip或者设置为空('0.0.0.0')。官方平台文档还不如不写 '192.168.xx.xx',对客户端来说设置'0.0.0.0'就可以,也比这个有指导性(Server端由于一台机器多个ip的可能,需要特别指定)。 另外,请问下代码自动连接至指定的ssid热点,看到api暴露出来的接口仅有wifiManager.addCandidateConfig(config),实际测试连接开放的无密码ssid时,参数设置如下 let config: wifiManager.WifiDeviceConfig = { // ssid为实际需要连接的热点ssid ssid: wifiSsid, preSharedKey: '', securityType: wifiManager.WifiSecurityType.WIFI_SEC_TYPE_OPEN } 返回错误 BussinessError 801: Capability not supported. 尝试调整securityType为其他值也没有作用,都是会触发error. 你对自动连接指定热点有经验实际跑通过吗?
1
回复于2024-08-15 12:18北京
authorIcon
长弓三石
这一块没在真机使用过
回复于2024-08-15 22:43江苏
authorIcon
156******85
udpSocket的ip地址不能这样写来测试,发送端和接收端一样的ip地址和端口号,无法确定是否是自己发送的包被环路自己接收了。 实际局域网场景下,本机和对端热点直接AP连接时,如果对端固定ip地址比如设置 192.168.10.1,端口号为6001, 按照官方的api示例。需要先创建 udpSocket,然后bind(address),这里必须设置192.168.10.255才能bind成功.(使用192.168.10.1会出错报可不用地址),然后通过当前连接的netHandle来bind(socket), 后续测试send发包时,形成了环路,自己发送的包被自己接收到,但无法接收对方发送的包。 请问有什么解决办法吗?关键问题在哪里? android平台也是这个思路,只是最开始创建socket时不需要直接bind(address),通过network.bind(socket)来实现的直接连接。
6
回复于2024-08-15 08:27北京
authorIcon
180******06
回复长弓三石
大佬你好,请教一下,我的业务需求是连接一个路由器,发255.255.255.255的广播包,路由器会回复一个报文,然后做一下操作。我也参考了您的代码,现在的问题是收不到内容, 只会收到一个自己发出的一串字符串。。之前安卓和iOS或者flutter,都实现了,广播真的用不了吗。组播不支持255.255.255.255的地址,这个咋解决?
回复于2024-09-29 02:13浙江
authorIcon
156******85
回复长弓三石
非常感谢你的帮助,使用真机,和我们的Ap设备实际连接,发送和接收udp包正常了。这里关键点有两个: 1.socket.bind(ipAddress)文档中强调的必须是本机ip(socket标准,惭愧被android平台实际不主动调用bind(),直接通过network.bind(socket)所误导~~) 2.netHandle.bindSocket(socket),这个操作在wifi稳定不断开情况下实际不影响,api设计可能考虑wifi自动触发切换情况下包仍然发出和接收,限制socket的真正物理网络通路。
回复于2024-08-15 12:02北京
authorIcon
长弓三石
回复156******85
你可以参考一下第二篇文章:鸿蒙网络编程系列2-UDP回声服务器的实现,看看是否有帮助。https://developer.huawei.com/consumer/cn/blog/topic/03147948124638011
回复于2024-08-15 11:09江苏
展开剩余3条评论
authorIcon
feng
学习
回复于2024-07-31 01:16广东
authorIcon
阿灿_1
编译报错
1
回复于2024-07-30 08:06江西
authorIcon
长弓三石
把代码: let remoteAddress = { address: this.targetIp, port: this.targetPort, family: 1 } 改成: let remoteAddress:socket.NetAddress = { address: this.targetIp, port: this.targetPort, family: 1 } 把 .catch((e) => { 改成 .catch((e:BusinessError) => { 然后在就可以在DevEco Studio NEXT Developer Beta版本编译通过了
回复于2024-07-30 08:24未知归属地
authorIcon
185******91
学习
回复于2024-06-28 13:16未知归属地
authorIcon
wakaka
感谢分享!
回复于2024-06-05 09:08四川
写评论
  • 为了保障您的信息安全,请勿上传您的敏感个人信息(如您的密码等信息)和您的敏感资产信息(如关键源代码、签名私钥、调试安装包、业务日志等信息),且您需自行承担由此产生的信息泄露等安全风险。
  • 如您发布的内容为转载内容,请注明内容来源。
发表
我要写文章
相关文章
Flutter 鸿蒙 ColorFiltered 颜色滤镜:一键灰度/复古/变色
浏览6.5W+
Flutter 显隐控制选哪个?Opacity/Visibility/Offstage 我踩过的坑
浏览6.4W+
Flutter 鸿蒙 share_plus 分享功能:ShareKit 桥接实战
浏览6.3W+
Flutter 鸿蒙 path_provider 文件路径:App 各目录在哪
浏览6.3W+
Flutter 鸿蒙 connectivity_plus 网络状态:检测与监听
浏览6.3W+
Flutter 鸿蒙 ScrollController 滚动控制:监听与编程控制
浏览6.3W+
Flutter 鸿蒙 url_launcher 外部链接:MethodChannel 桥接实战
浏览6.3W+
Flutter 鸿蒙 FittedBox 缩放适配:7 种 BoxFit 模式详解
浏览6.2W+
了解社区公约,与您携手共创和谐专业的开发者社区。