go的websocket實(shí)現(xiàn)原理與用法詳解

更新時(shí)間：2016年07月26日 16:52:15 作者：軒脈刃

這篇文章主要介紹了go的websocket實(shí)現(xiàn)原理與用法,詳細(xì)分析了websocket的功能、原理及Go語言實(shí)現(xiàn)websocket的相關(guān)技巧,需要的朋友可以參考下

本文實(shí)例講述了go的websocket實(shí)現(xiàn)原理與用法。分享給大家供大家參考，具體如下：

websocket分為握手和數(shù)據(jù)傳輸階段，即進(jìn)行了HTTP握手 + 雙工的TCP連接

RFC協(xié)議文檔在：http://tools.ietf.org/html/rfc6455

握手階段

握手階段就是普通的HTTP

客戶端發(fā)送消息：

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

服務(wù)端返回消息：

HTTP/1.1 101 Switching Protocols
Upgrade: websocket
Connection: Upgrade
Sec-WebSocket-Accept: s3pPLMBiTxaQ9kYGzzhZRbK+xOo=

這里的Sec-WebSocket-Accept的計(jì)算方法是：

base64(hsa1(sec-websocket-key + 258EAFA5-E914-47DA-95CA-C5AB0DC85B11))

如果這個(gè)Sec-WebSocket-Accept計(jì)算錯(cuò)誤瀏覽器會(huì)提示：

Sec-WebSocket-Accept dismatch

如果返回成功，Websocket就會(huì)回調(diào)onopen事件

數(shù)據(jù)傳輸

websocket的數(shù)據(jù)傳輸使用的協(xié)議是：

參數(shù)的具體說明在這：

FIN：1位，用來表明這是一個(gè)消息的最后的消息片斷，當(dāng)然第一個(gè)消息片斷也可能是最后的一個(gè)消息片斷；

RSV1, RSV2, RSV3: 分別都是1位，如果雙方之間沒有約定自定義協(xié)議，那么這幾位的值都必須為0,否則必須斷掉WebSocket連接；

Opcode:4位操作碼，定義有效負(fù)載數(shù)據(jù)，如果收到了一個(gè)未知的操作碼，連接也必須斷掉，以下是定義的操作碼：
      * %x0 表示連續(xù)消息片斷
      * %x1 表示文本消息片斷
      * %x2 表未二進(jìn)制消息片斷
      * %x3-7 為將來的非控制消息片斷保留的操作碼
      * %x8 表示連接關(guān)閉
      * %x9 表示心跳檢查的ping
      * %xA 表示心跳檢查的pong
      * %xB-F 為將來的控制消息片斷的保留操作碼

Mask:1位，定義傳輸?shù)臄?shù)據(jù)是否有加掩碼,如果設(shè)置為1,掩碼鍵必須放在masking-key區(qū)域，客戶端發(fā)送給服務(wù)端的所有消息，此位的值都是1；

Payload length: 傳輸數(shù)據(jù)的長(zhǎng)度，以字節(jié)的形式表示：7位、7+16位、或者7+64位。如果這個(gè)值以字節(jié)表示是0-125這個(gè)范圍，那這個(gè)值就表示傳輸數(shù)據(jù)的長(zhǎng)度；如果這個(gè)值是126，則隨后的兩個(gè)字節(jié)表示的是一個(gè)16進(jìn)制無符號(hào)數(shù)，用來表示傳輸數(shù)據(jù)的長(zhǎng)度；如果這個(gè)值是127,則隨后的是8個(gè)字節(jié)表示的一個(gè)64位無符合數(shù)，這個(gè)數(shù)用來表示傳輸數(shù)據(jù)的長(zhǎng)度。多字節(jié)長(zhǎng)度的數(shù)量是以網(wǎng)絡(luò)字節(jié)的順序表示。負(fù)載數(shù)據(jù)的長(zhǎng)度為擴(kuò)展數(shù)據(jù)及應(yīng)用數(shù)據(jù)之和，擴(kuò)展數(shù)據(jù)的長(zhǎng)度可能為0,因而此時(shí)負(fù)載數(shù)據(jù)的長(zhǎng)度就為應(yīng)用數(shù)據(jù)的長(zhǎng)度。

Masking-key:0或4個(gè)字節(jié)，客戶端發(fā)送給服務(wù)端的數(shù)據(jù)，都是通過內(nèi)嵌的一個(gè)32位值作為掩碼的；掩碼鍵只有在掩碼位設(shè)置為1的時(shí)候存在。

Payload data: (x+y)位，負(fù)載數(shù)據(jù)為擴(kuò)展數(shù)據(jù)及應(yīng)用數(shù)據(jù)長(zhǎng)度之和。

Extension data:x位，如果客戶端與服務(wù)端之間沒有特殊約定，那么擴(kuò)展數(shù)據(jù)的長(zhǎng)度始終為0，任何的擴(kuò)展都必須指定擴(kuò)展數(shù)據(jù)的長(zhǎng)度，或者長(zhǎng)度的計(jì)算方式，以及在握手時(shí)如何確定正確的握手方式。如果存在擴(kuò)展數(shù)據(jù)，則擴(kuò)展數(shù)據(jù)就會(huì)包括在負(fù)載數(shù)據(jù)的長(zhǎng)度之內(nèi)。

Application data:y位，任意的應(yīng)用數(shù)據(jù)，放在擴(kuò)展數(shù)據(jù)之后，應(yīng)用數(shù)據(jù)的長(zhǎng)度=負(fù)載數(shù)據(jù)的長(zhǎng)度-擴(kuò)展數(shù)據(jù)的長(zhǎng)度。

實(shí)例

具體使用go的實(shí)現(xiàn)例子：

客戶端：

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();
})

服務(wù)端：

復(fù)制代碼代碼如下:

package main

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

    // 先暫時(shí)這么判斷

    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：這里省略其他的驗(yàn)證

        guid := "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"

        // 計(jì)算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長(zhǎng)度<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

    //第一個(gè)字節(jié)：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

}