本项目地址:gof 一个支持百万连接的websocket框架
本文提及的内容包含在:conn.go
在上一章节中,我们进行了websocket的连接,在连接建立之后,我们就可以通过websocket来进行消息的收发了。
我们已经知道了websocket的消息是通过消息帧来进行传输的,今天主要就消息帧的格式来进行详细说明。
一、客户端发送消息
在websocket测试的过程中,我一直都是使用easyswoole提供的websocket测试工具来进行的。
首先在服务端定义端口为8801,ip为 0.0.0.0,使其可以接收任意IP发送的消息。
// test/main.go
func main(){
serve := gof.InitServer("0.0.0.0", 8801, Ws{}, nil)
serve.Run()
}
然后我们点击客户端的连接,可以看到已经连接到了我们自定义的websocket服务。
si1.png
然后我们在服务端 conn.go Read()方法中加入如下代码:
func (c *Conn) Read() {
buf := c.s.readBufPool.Get().([]byte)
defer func() {
buf = make([]byte, c.s.readBufferSize)
c.s.readBufPool.Put(buf)
}()
nbytes, _ := syscall.Read(c.fd, buf)
if nbytes > 0 {
fmt.Printf("%b\n",buf) //在这里打印一下buf的内容,以二进制方式显示
//......
}
}
之后,我们在下面的“发送到服务端的内容”文本框中输入:12345,然后点击发送到服务端的按钮。
二、服务端读取消息
可以看到,在服务端的控制台中,输出了我们接收到的内容,值为:
[10000001 10000101 10000111 11111101 1101110 11001100 10110110 11001111 1011101 11111000 10110010 0 0 0 0 ...]
这里打印的是一个1024位的byte切片,因为我们预先定义的切片大小为1024。为了方便展示,我们省略掉一部分0值。
然后我们对比以下websocket的消息帧,来完成消息的读取。
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-------+-+-------------+-------------------------------+
|F|R|R|R| opcode|M| Payload len | Extended payload length |
|I|S|S|S| (4) |A| (7) | (16/64) |
|N|V|V|V| |S| | (if payload len==126/127) |
| |1|2|3| |K| | |
+-+-+-+-+-------+-+-------------+ - - - - - - - - - - - - - - - +
| Extended payload length continued, if payload len == 127 |
+ - - - - - - - - - - - - - - - +-------------------------------+
| |Masking-key, if MASK set to 1 |
+-------------------------------+-------------------------------+
| Masking-key (continued) | Payload Data |
+-------------------------------- - - - - - - - - - - - - - - - +
: Payload Data continued ... :
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
| Payload Data continued ... |
+---------------------------------------------------------------+
我们先看1、2字节,分别为:
10000001 10000101
第1位为fin码,值为1,代表该消息是最后一个切片。
第2、3、4位是RSV扩展码,因为我们没有定义任何扩展,因此该码都是0
第5、6、7、8位是opcode, 值为1,因此该消息是一个文本消息。
第9位是mask掩码,在websocket的官方文档中明确规定,必须启用掩码,否则应该将消息丢弃。所以其值为1。
从第10位到第16位,是数据的长度,这里是二进制的101,转为十进制是5,因此是5位。
既然启用了掩码,并且消息的长度小于126,那么消息的3、4、5、6字节就是掩码位。
四位掩码分别为:
10000111 11111101 1101110 11001100
剩下的5位,就是我们的数据位。
分别为:
10110110 11001111 1011101 11111000 10110010
websocket对于掩码的处理是做了按位异或运算。处理的顺序为:
数据字节1^掩码字节1
数据字节2^掩码字节2
数据字节3^掩码字节3
数据字节4^掩码字节4
数据字节5^掩码字节1
......(以此类推)
我们在进行处理的时候,就需要按照该规则再进行一次异或运算处理,就可以解析出对应的数据。
例如:
10110110 ^ 10000111 = 00110001
//我们可以看到,该码值是十进制的49,转为char类型的值为1。
因此我们可以根据该规则来进行代码的编写。
三、服务端读取消息的代码
1 读取消息类型、掩码和数据长度
在本项目中,直接默认了fin码的值为1,因为分多片传输的消息,笔者还没有完全领会。
所以,首先我们取到对应的消息
buf := c.s.readBufPool.Get().([]byte)
defer func() {
buf = make([]byte, c.s.readBufferSize)
c.s.readBufPool.Put(buf)
}()
nbytes, _ := syscall.Read(c.fd, buf)
if nbytes > 0 {
fmt.Printf("%b\n",buf)
//...
}
}
然后,判断消息的类型:
//查询消息类型
msgtype := int((buf[0] << 4) >> 4)
通过将二进制位移的方式,我们可以将左侧的内容都变成0,从而只取最右侧的四个字节
10000001 << 4 之后变成 00010000
00010000 >> 4 之后变成 00000001
从而我们获取的opcode码为1,即文本消息
掩码在第9位,也就是第二个字节的第一位
//查询掩码
mask := buf[1] >> 7
if mask != 1 { //如果没有掩码,就直接将数据抛弃掉
return
}
然后,我们需要读取数据长度,为了方便计算,我们将所有的数据长度都用int64表示。代码为:
//查询数据的长度,至于为什么要转int64,我们下面会标明。
datalen := int64((buf[1] << 1) >> 1) //挤掉第二个字节的第一位,然后再偏移回去
我们首先默认数据长度是小于126的,那么掩码应该从第三个字节开始,在切片中表示就是buf[2]
maskStart := 2
websocket的数据长度表示为:
如果数据长度小于126,那么第2个字节的后7位就是长度值,即int8类型;
如果 126 < 数据长度 < 65535 ,那么第二个字节的后7位值为126,并且,第3、4个字节表示的是数据的真实长度,即 int16 类型;
如果 数据长度> 65535,那么第二个字节的后7位值为127,并且,使用第3-10个字节表示数据的真实长度,即 int64 类型;
因为长度并不是固定的,我们的掩码位置会随着数据长度所占用的字节量向后偏移
为了方便处理,我们将所有的长度值都转换为int64类型。
代码如下:
//如果data长度小于125,就直接取字节长度
if datalen == 126 { //如果data长度等于126,就往后增加两个字节长度
datalen = int64(binary.BigEndian.Uint16(buf[2:3]))
maskStart = 4
} else if datalen == 127 {
datalen = int64(binary.BigEndian.Uint64(buf[2:9]))
maskStart = 10
}
这样我们就计算出了数据的真实长度,并且找到了掩码的开始位置。
掩码用4个字节,是固定的,所以我们取掩码的方式为:
//4位的掩码
maskSlice := c.s.bytePool.Get().([]byte)
maskSlice = buf[maskStart : maskStart+4]
之后我们开始取数据,按照我们之前的设想,代码可以编写如下:
datastart := int64(maskStart + 4) //数据总是在掩码之后
maskIndex := 0
content := c.s.bytePool.Get().([]byte)
for i := datastart; i < datalen+datastart; i++ {
content = append(content, buf[i]^maskSlice[maskIndex])
if maskIndex == 3 {
maskIndex = 0
} else {
maskIndex++
}
}
//...
至此,整个取数据的过程完成。
网友评论