go的websocket实现原理与用法详解
本文实例讲述了go的websocket实现原理与用法。分享给大家供大家参考，具体如下：
websocket分为握手和数据传输阶段，即进行了http握手 + 双工的tcp连接
rfc协议文档在：
握手阶段
握手阶段就是普通的http
客户端发送消息：
get /chat http/1.1 host: server.example.com upgrade: websocket connection: upgrade sec-websocket-key: dghlihnhbxbszsbub25jzq== origin: http://example.com sec-websocket-version: 13
服务端返回消息：
http/1.1 101 switching protocols upgrade: websocket connection: upgrade sec-websocket-accept: s3pplmbitxaq9kygzzhzrbk+xoo=
这里的sec-websocket-accept的计算方法是：
base64(hsa1(sec-websocket-key + 258eafa5-e914-47da-95ca-c5ab0dc85b11))
如果这个sec-websocket-accept计算错误浏览器会提示：
sec-websocket-accept dismatch
如果返回成功，websocket就会回调onopen事件
数据传输
websocket的数据传输使用的协议是：
参数的具体说明在这：
fin：1位，用来表明这是一个消息的最后的消息片断，当然第一个消息片断也可能是最后的一个消息片断；
rsv1, rsv2, rsv3: 分别都是1位，如果双方之间没有约定自定义协议，那么这几位的值都必须为0,否则必须断掉websocket连接；
opcode:4位操作码，定义有效负载数据，如果收到了一个未知的操作码，连接也必须断掉，以下是定义的操作码：
* %x0 表示连续消息片断
* %x1 表示文本消息片断
* %x2 表未二进制消息片断
* %x3-7 为将来的非控制消息片断保留的操作码
* %x8 表示连接关闭
* %x9 表示心跳检查的ping
* %xa 表示心跳检查的pong
* %xb-f 为将来的控制消息片断的保留操作码
mask:1位，定义传输的数据是否有加掩码,如果设置为1,掩码键必须放在masking-key区域，客户端发送给服务端的所有消息，此位的值都是1；
payload length: 传输数据的长度，以字节的形式表示：7位、7+16位、或者7+64位。如果这个值以字节表示是0-125这个范围，那这个值就表示传输数据的长度；如果这个值是126，则随后的两个字节表示的是一个16进制无符号数，用来表示传输数据的长度；如果这个值是127,则随后的是8个字节表示的一个64位无符合数，这个数用来表示传输数据的长度。多字节长度的数量是以网络字节的顺序表示。负载数据的长度为扩展数据及应用数据之和，扩展数据的长度可能为0,因而此时负载数据的长度就为应用数据的长度。
masking-key:0或4个字节，客户端发送给服务端的数据，都是通过内嵌的一个32位值作为掩码的；掩码键只有在掩码位设置为1的时候存在。
payload data: (x+y)位，负载数据为扩展数据及应用数据长度之和。
extension data:x位，如果客户端与服务端之间没有特殊约定，那么扩展数据的长度始终为0，任何的扩展都必须指定扩展数据的长度，或者长度的计算方式，以及在握手时如何确定正确的握手方式。如果存在扩展数据，则扩展数据就会包括在负载数据的长度之内。
application data:y位，任意的应用数据，放在扩展数据之后，应用数据的长度=负载数据的长度-扩展数据的长度。
实例
具体使用go的实现例子：
客户端：
html：
<html>
<head>
<script type="text/javascript" src="./jquery.min.js"></script>
</head>
<body>
<input type="button" id="connect" value="websocket connect" />
<input type="button" id="send" value="websocket send" />
<input type="button" id="close" value="websocket close" />
</body>
<script type="text/javascript" src="./websocket.js"></script>
</html>
js：
var socket;
$("#connect").click(function(event){
socket = new websocket("ws://127.0.0.1:8000");
socket.onopen = function(){
alert("socket has been opened");
}
socket.onmessage = function(msg){
alert(msg.data);
}
socket.onclose = function() {
alert("socket has been closed");
}
});
$("#send").click(function(event){
socket.send("send from client");
});
$("#close").click(function(event){
socket.close();
})
服务端：
import(
"net"
"log"
"strings"
"crypto/sha1"
"io"
"encoding/base64"
"errors"
)
func main() {
ln, err := net.listen("tcp", ":8000")
if err != nil {
log.panic(err)
}
for {
conn, err := ln.accept()
if err != nil {
log.println("accept err:", err)
}
for {
handleconnection(conn)
}
}
}
func handleconnection(conn net.conn) {
content := make([]byte, 1024)
_, err := conn.read(content)
log.println(string(content))
if err != nil {
log.println(err)
}
ishttp := false
// 先暂时这么判断
if string(content[0:3]) == "get" {
ishttp = true;
}
log.println("ishttp:", ishttp)
if ishttp {
headers := parsehandshake(string(content))
log.println("headers", headers)
secwebsocketkey := headers["sec-websocket-key"]
// note：这里省略其他的验证
guid := "258eafa5-e914-47da-95ca-c5ab0dc85b11"
// 计算sec-websocket-accept
h := sha1.new()
log.println("accept raw:", secwebsocketkey + guid)
io.writestring(h, secwebsocketkey + guid)
accept := make([]byte, 28)
base64.stdencoding.encode(accept, h.sum(nil))
log.println(string(accept))
response := "http/1.1 101 switching protocols\r\n"
response = response + "sec-websocket-accept: " + string(accept) + "\r\n"
response = response + "connection: upgrade\r\n"
response = response + "upgrade: websocket\r\n\r\n"
log.println("response:", response)
if lenth, err := conn.write([]byte(response)); err != nil {
log.println(err)
} else {
log.println("send len:", lenth)
}
wssocket := newwssocket(conn)
for {
data, err := wssocket.readiframe()
if err != nil {
log.println("readiframe err:" , err)
}
log.println("read data:", string(data))
err = wssocket.sendiframe([]byte("good"))
if err != nil {
log.println("sendiframe err:" , err)
}
log.println("send data")
}
} else {
log.println(string(content))
// 直接读取
}
}
type wssocket struct {
maskingkey []byte
conn net.conn
}
func newwssocket(conn net.conn) *wssocket {
return &wssocket{conn: conn}
}
func (this *wssocket)sendiframe(data []byte) error {
// 这里只处理data长度<125的
if len(data) >= 125 {
return errors.new("send iframe data error")
}
lenth := len(data)
maskeddata := make([]byte, lenth)
for i := 0; i < lenth; i++ {
if this.maskingkey != nil {
maskeddata[i] = data[i] ^ this.maskingkey[i % 4]
} else {
maskeddata[i] = data[i]
}
}
this.conn.write([]byte{0x81})
var paylenbyte byte
if this.maskingkey != nil && len(this.maskingkey) != 4 {
paylenbyte = byte(0x80) | byte(lenth)
this.conn.write([]byte{paylenbyte})
this.conn.write(this.maskingkey)
} else {
paylenbyte = byte(0x00) | byte(lenth)
this.conn.write([]byte{paylenbyte})
}
this.conn.write(data)
return nil
}
func (this *wssocket)readiframe() (data []byte, err error){
err = nil
//第一个字节：fin + rsv1-3 + opcode
opcodebyte := make([]byte, 1)
this.conn.read(opcodebyte)
fin := opcodebyte[0] >> 7
rsv1 := opcodebyte[0] >> 6 & 1
rsv2 := opcodebyte[0] >> 5 & 1
rsv3 := opcodebyte[0] >> 4 & 1
opcode := opcodebyte[0] & 15
log.println(rsv1,rsv2,rsv3,opcode)
payloadlenbyte := make([]byte, 1)
this.conn.read(payloadlenbyte)
payloadlen := int(payloadlenbyte[0] & 0x7f)
mask := payloadlenbyte[0] >> 7
if payloadlen == 127 {
extendedbyte := make([]byte, 8)
this.conn.read(extendedbyte)
}
maskingbyte := make([]byte, 4)
if mask == 1 {
this.conn.read(maskingbyte)
this.maskingkey = maskingbyte
}
payloaddatabyte := make([]byte, payloadlen)
this.conn.read(payloaddatabyte)
log.println("data:", payloaddatabyte)
databyte := make([]byte, payloadlen)
for i := 0; i < payloadlen; i++ {
if mask == 1 {
databyte[i] = payloaddatabyte[i] ^ maskingbyte[i % 4]
} else {
databyte[i] = payloaddatabyte[i]
}
}
if fin == 1 {
data = databyte
return
}
nextdata, err := this.readiframe()
if err != nil {
return
}
data = append(data, nextdata…)
return
}
func parsehandshake(content string) map[string]string {
headers := make(map[string]string, 10)
lines := strings.split(content, "\r\n")
for _,line := range lines {
if len(line) >= 0 {
words := strings.split(line, ":")
if len(words) == 2 {
headers[strings.trim(words[0]," ")] = strings.trim(words[1], " ")
}
}
}
return headers
}
后话
ps：后来发现官方也有实现了websocket，只是它不是在pkg下，而是在net的branch下
强烈建议使用官方的websocket，不要自己写
当然如果自己实现了一遍协议，看官方的包自然会更清晰了。
希望本文所述对大家go语言程序设计有所帮助。