鸿蒙网络编程系列3-TCP客户端通讯示例
1. TCP简介
TCP协议是传输层最重要的协议，提供了可靠、有序的数据传输，是多个广泛使用的表示层协议的运行基础，相对于UDP来说，TCP需要经过三次握手后才能建立连接，建立连接后才能进行数据传输，所以效率差了一些，但是它的发送-确认机制决定了传输是可靠的，再加上滑动窗口机制的设计，也可以极大的提高传输效率。
2. TCP通讯的常用方法
鸿蒙封装的TCP操作类位于模块socket中，使用如下的方式导入：
import socket from '@ohos.net.socket';socket模块包括了众多的TCP操作方法，就本文而言，重点需要掌握的是如下五个：
1）constructTCPSocketInstance(): TCPSocket
创建一个TCPSocket对象,在使用TCPSocket的方法以前需要创建该对象。
2）bind(address: NetAddress): Promise<void>
绑定IP地址和端口，端口可以指定或由系统随机分配，可以使用0.0.0.0表示本机IP地址；使用Promise方式作为异步方法。
3）connect(options: TCPConnectOptions): Promise<void>
连接到指定的IP地址和端口，参数options包含了连接的地址address和连接超时时间timeout，其中address是必选的，timeout是可选的，使用promise方法作为异步方法。
4）send(options: TCPSendOptions): Promise<void>
通过TCPSocket连接发送数据，参数options包括要发送的数据data和字符编码encoding，其中data是必选的，encoding是可选的，默认使为utf-8编码，使用Promise方式作为异步方法。
5）on(type: 'message', callback: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>): void
订阅TCPSocket连接的接收消息事件，当套接字接收到消息时触发该事件，其中message表示接收到的消息，remoteInfo是发送方信息；使用callback方式作为异步方法。
3. TCP客户端通讯示例
为演示TCP通讯的方式，本示例实现了一个使用TCP协议发送、接收消息的功能，运行后的初始界面如下所示：
本示例的实现思路是这样的，首先把套接字绑定到本地的给定端口上，然后再连接到指定的服务端，最后发送消息给服务端，因为TCP是面向连接的协议，所以，本示例默认情况下连接和发送按钮都是不可用的，在绑定成功后才可以使用连接按钮，在成功连接带服务端后才可以使用发送按钮。
下面详细介绍创建该应用的步骤。
步骤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';
//执行TCP通讯的对象
let tcpSocket = socket.constructTCPSocketInstance();
//说明：本地的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 serverIp: string = "0.0.0.0"
//服务端端口
@State serverPort: number = 9999
//是否可以连接
@State canConnect: boolean = false
//是否可以发送消息
@State canSend: boolean = false
scroller: Scroller = new Scroller()
build() {
Row() {
Column() {
Text("TCP通讯示例")
.fontSize(14)
.fontWeight(FontWeight.Bold)
.width('100%')
.textAlign(TextAlign.Center)
.padding(10)
Flex({ justifyContent: FlexAlign.Start, alignItems: ItemAlign.Center }) {
Text("本地IP和端口：")
.width(100)
.fontSize(14)
.flexGrow(0)
Text(localIp)
.width(110)
.fontSize(12)
.flexGrow(0)
TextInput({ text: this.localPort.toString() })
.type(InputType.Number)
.onChange((value) => {
this.localPort = parseInt(value)
})
.width(50)
.fontSize(12)
.flexGrow(3)
Button("绑定")
.onClick(() => {
this.bind2Port()
})
.width(70)
.fontSize(14)
.flexGrow(0)
}.width('100%')
.padding(10)
Flex({ justifyContent: FlexAlign.Start, alignItems: ItemAlign.Center }) {
Text("服务端地址：")
.fontSize(14)
.width(90)
.flexGrow(1)
TextInput({ text: this.serverIp })
.onChange((value) => {
this.serverIp = value
})
.width(110)
.fontSize(12)
.flexGrow(4)
Text(":")
.width(5)
.flexGrow(0)
TextInput({ text: this.serverPort.toString() })
.type(InputType.Number)
.onChange((value) => {
this.serverPort = parseInt(value)
})
.fontSize(12)
.flexGrow(2)
.width(50)
Button("连接")
.onClick(() => {
this.connect2Server()
})
.enabled(this.canConnect)
.width(70)
.fontSize(14)
.flexGrow(0)
}
.width('100%')
.padding(10)
Flex({ justifyContent: FlexAlign.Start, alignItems: ItemAlign.Center }) {
TextInput({ placeholder: "输入要发送的消息" }).onChange((value) => {
this.sendMsg = value
})
.width(200)
.flexGrow(1)
Button("发送")
.enabled(this.canSend)
.width(70)
.fontSize(14)
.flexGrow(0)
.onClick(() => {
this.sendMsg2Server()
})
}
.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%')
}
//发送消息到服务端
sendMsg2Server() {
tcpSocket.send({ data: this.sendMsg + "\r\n" })
.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 tcpSocket.bind(localAddress)
.then(() => {
this.msgHistory = 'bind success' + "\r\n";
this.canConnect = true
})
.catch((e) => {
this.msgHistory = 'bind fail ' + e.message + "\r\n";
})
//收到消息时的处理
tcpSocket.on("message", async (value) => {
let msg = buf2String(value.message)
let time = await getCurrentTimeString()
this.msgHistory += "服务端:" + msg + time + "\r\n"
this.scroller.scrollEdge(Edge.Bottom)
})
}
//连接服务端
connect2Server() {
//本地地址
let serverAddress = { address: this.serverIp, port: this.serverPort, family: 1 }
tcpSocket.connect({ address: serverAddress })
.then(() => {
this.msgHistory = 'connect success ' + "\r\n";
this.canSend = true
})
.catch((e) => {
this.msgHistory = 'connect fail ' + e.message + "\r\n";
})
}
}
//同步获取当前时间的字符串形式
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：编译运行，可以使用模拟器或者真机。
步骤5：配置本地端口和服务端地址，这里为了模拟服务端，使用nc命令在服务器监听9999端口，命令如下：
nc -l -p 9999当然，读者也可以根据自己需要选择其他合适的TCP服务端。
连接上服务端后，客户端发送消息“服务端，你好啊！”
然后服务端回复：“客户端，你好！”，客户端截图如下所示：
服务端截图如下所示：
这样就完成了一个简单的TCP消息发送应用。
（本文作者原创，除非明确授权禁止转载）
其他鸿蒙网络编程文章：
- 点赞
- 收藏
- 关注作者
评论（0）