通信框架 t-io 學習——websocket 部分源碼解析

前言

  前端時間看了看t-io的websocket部分源碼,因而抽時間看了看websocket的握手和他的通信機制。本篇只是簡單記錄一下websocket握手部分。前端

WebSocket握手

  好多人都用過websocket,不過有的都是在框架之上,只知道鏈接某個地址,而後調用js API就可使用websocket了。可是經過閱讀t-io的源碼才稍微有點明白,服務端到底作了什麼。將t-io的websocket demo運行起來以後,咱們看一下請求。java

  能夠看到,請求頭部分:git

  Connection:Upgrade 固定github

  Upgrade:websocket 固定web

  Host:爲websocket請求地址瀏覽器

  Sec-WebSocket-Version:13,websocket協議版本號websocket

  Sec-WebSocket-Key:發送給服務端須要校驗的key,是一個Base64 encode的值,這個是瀏覽器隨機生成的。那麼服務端若是響應的話,須要作以下操做:將 Key 追加固定字符串 :「258EAFA5-E914-47DA-95CA-C5AB0DC85B11」,而後進行SHA-1加密,在轉化爲base64.框架

  服務端響應以下:socket

  Status Code:101 Switching Protocols編碼

  sec-websocket-accept:爲上文中轉化爲base64的串。

  upgrade:升級爲websocket協議

  握手成功,能夠進行通信。

握手源碼

  代碼來源:tio/websocket/server/WsServerAioHandler.java

public static HttpResponse updateWebSocketProtocol(HttpRequest request, ChannelContext channelContext) {
     //首先獲取請求頭部信息
        Map<String, String> headers = request.getHeaders();
     //獲取Sec-WebSocket-Key
        String Sec_WebSocket_Key = headers.get(HttpConst.RequestHeaderKey.Sec_WebSocket_Key);

     //若是key是空的話,確定不會握手成功
        if (StringUtils.isNotBlank(Sec_WebSocket_Key)) {
       //追加固定串
            String Sec_WebSocket_Key_Magic = Sec_WebSocket_Key + "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
       //SHA-1加密
            byte[] key_array = SHA1Util.SHA1(Sec_WebSocket_Key_Magic);
       //轉化爲base64
            String acceptKey = BASE64Util.byteArrayToBase64(key_array);
       //構造響應體
            HttpResponse httpResponse = new HttpResponse(request, null);
       //響應狀態碼 101 Switching Protocols
            httpResponse.setStatus(HttpResponseStatus.C101);

            Map<String, String> respHeaders = new HashMap<>();
       //Connection:upgrade
            respHeaders.put(HttpConst.ResponseHeaderKey.Connection, HttpConst.ResponseHeaderValue.Connection.Upgrade);
       //Upgrade:websocket
            respHeaders.put(HttpConst.ResponseHeaderKey.Upgrade, "WebSocket");
       //Sec-WebSocket-Accept:生成的base64串
            respHeaders.put(HttpConst.ResponseHeaderKey.Sec_WebSocket_Accept, acceptKey);
       //設置響應頭
            httpResponse.setHeaders(respHeaders);
       //返回響應信息 握手成功
            return httpResponse;
        }
        return null;
    }

WebSocket 數據幀解析

  注:博客部份內容來源於:https://github.com/zhangkaitao/websocket-protocol/wiki/5.%E6%95%B0%E6%8D%AE%E5%B8%A7  有興趣的同窗能夠直接讀本連接內容。

  相信不少人從其餘博客中也看過這個圖,固然啦,這個圖是官方出品的權威數據幀格式圖。

  其實我第一眼看的時候確實看不懂,不過不要緊,一點一點的看。

  FIN:1bit,指示這個消息是否爲最後片斷,1是,0否。若是不是最後片斷,則服務端須要將全部消息接受完並組裝成一個完整的消息才能夠。(t-io中目前只支持FIN=1)

  RSV123每一個長度爲1bit,目前就都是固定 0。

  opcode:4bit,數據操做類型。

  • %x0 表明一個繼續幀
  • %x1 表明一個文本幀
  • %x2 表明一個二進制幀
  • %x3-7 保留用於將來的非控制幀
  • %x8 表明鏈接關閉
  • %x9 表明ping
  • %xA 表明pong
  • %xB-F 保留用於將來的控制幀

  MASK:1bit,是否掩碼,1掩碼,0非掩碼。從客戶端發送到服務端的這個值必須爲1,不然服務端不接受。服務端返回到客戶端的這個值必須爲 0.

  Payload len:負載數據的長度,7bit。因爲7bit只能存儲0-127,因此爲了可以表示準確的長度,在這個值爲0-125區間的時候,payload length的長度就是該值。當 值爲126的時候,後邊兩個字節(16位)的值表示長度。當值爲127的時候,後邊8字節(64位)的值表示長度。

  Mask key:掩碼,0或4個bit。值取決於MASK是否爲1.在有掩碼的狀況下,數據就要根據掩碼來解析。不然不用解析。解析規則爲:每一個字節的值與掩碼的索引(字節索引值對4取模)異或運算。(array[i] = array[i] ^ mask[i % 4])

  其實說實話我也沒弄得很是懂,可是基本瞭解了以上這些知識以後,咱們就能夠讀懂源碼的意思了。

數據幀解析源碼

  代碼來源:tio/websocket/common/WsServerDecoder.java

  代碼中的註釋爲我本身的理解所添加的註釋,不必定正確。(因爲源碼中有部分註釋,個人註釋添加「注」字以做區分)

public static WsRequest decode(ByteBuffer buf, ChannelContext channelContext) throws AioDecodeException {
WsSessionContext imSessionContext = (WsSessionContext) channelContext.getAttribute();
List<byte[]> lastParts = imSessionContext.getLastParts();

//第一階段解析
int initPosition = buf.position();
int readableLength = buf.limit() - initPosition;

int headLength = WsPacket.MINIMUM_HEADER_LENGTH;
    
if (readableLength < headLength) {
return null;
}
//注:讀取第一個字節 這裏以 0x81舉例 它的二進制爲:10000001
byte first = buf.get();
//注:這個 0xff仍是頗有意思的,當byte類型想轉爲int類型的時候,好比: int res = byteValue & 0xff;
//int b = first & 0xFF; //轉換成32位
// 0x80(127) 10000000
// 0x81(128) 10000001
// 此行代碼說實話,我是用了很長的時間才理解,說來慚愧,剛開始連 & 操做符啥意思都不清楚。
// 按位與運算符「&」是雙目運算符。其功能是參與運算的兩數各對應的二進位相與。只要對應的二個二進位都爲1時,結果位就爲1。
// 參與運算的兩個數均以補碼出現。
// 0x80 & 0x81 10000000
boolean fin = (first & 0x80) > 0; //獲得第8位 10000000>0
//注:這段我不理解什麼意思,爲何要右移4位
@SuppressWarnings("unused")
int rsv = (first & 0x70) >>> 4;//獲得五、六、7 爲01110000 而後右移四位爲00000111
//注:獲取操做碼
//0x0f 00001111 (按位與操做,前四位都爲0,那麼操做結果就是opCode的值)
byte opCodeByte = (byte) (first & 0x0F);//後四位爲opCode 00001111
//注:轉換OpCode
Opcode opcode = Opcode.valueOf(opCodeByte);
if (opcode == Opcode.CLOSE) {
//Aio.remove(channelContext, "收到opcode:" + opcode);
//return null;
}
if (!fin) {
    log.error("{} 暫時不支持fin爲false的請求", channelContext);
    Aio.remove(channelContext, "暫時不支持fin爲false的請求");
    return null;
//下面這段代碼不要刪除,之後若支持fin,則須要的

//            if (lastParts == null) {

//                lastParts = new ArrayList<>();

//                imSessionContext.setLastParts(lastParts);

//            }

} else {
    imSessionContext.setLastParts(null);
}

//注:開始解析第二個字節。8-16位,第八位爲mask掩碼值1或者0,後7位爲payload length
byte second = buf.get(); //向後讀取一個字節
//注:又是 & 操做。 0xff:11111111
// 11111111 & 10000001 = 10000001  向右移動七位,只剩下第一位的值 00000001
//因此該操做事後就知道第一位爲 0 或者 1 ,得知 payload Data是否通過掩碼處理
boolean hasMask = (second & 0xFF) >> 7 == 1; //用於標識PayloadData是否通過掩碼處理。若是是1,Masking-key域的數據便是掩碼密鑰,用於解碼PayloadData。客戶端發出的數據幀須要進行掩碼處理,因此此位是1。


// Client data must be masked

if (!hasMask) { //第9爲爲mask,必須爲1
//throw new AioDecodeException("websocket client data must be masked");
} else {
    //注:有掩碼的狀況下,掩碼佔用4個字節,因此在這裏headLength + 4
    headLength += 4;
}
//注:第一位爲mask位置,後7位爲payload length
//0x7f : 01111111
//&操做事後獲得payload的值
//讀取後7位  Payload legth,若是<126則payloadLength
int payloadLength = second & 0x7F;
byte[] mask = null;
//注:若是payloadLength = 126,那麼說明這個值不是真正的payloadLength,後邊兩個字節才表示真正的length
//爲126讀2個字節,後兩個字節爲payloadLength
if (payloadLength == 126) {
    //須要多佔兩個字節表示payloadLength。headlength + 2
    headLength += 2;
if (readableLength < headLength) {
    return null;
}

payloadLength = ByteBufferUtils.readUB2WithBigEdian(buf);
  log.info("{} payloadLengthFlag: 126,payloadLength {}", channelContext, payloadLength);

}
//注:若是payloadLength = 127,則後 8個字節 64位長度的值表示payloadLength
//127讀8個字節,後8個字節爲payloadLength
else if (payloadLength == 127) {
    //頭部長度 + 8
    headLength += 8;
if (readableLength < headLength) {
    return null;
}
//注:我猜想getLong方法就讀取buf中下一位長整數,即64位的payloadLength(first ,second都已經讀取完)
//|first|second|payloadLength|
payloadLength = (int) buf.getLong();
  log.info("{} payloadLengthFlag: 127,payloadLength {}", channelContext, payloadLength);
}

if (payloadLength < 0 || payloadLength > WsPacket.MAX_BODY_LENGTH) {
throw new AioDecodeException("body length(" + payloadLength + ") is not right");
}

if (readableLength < headLength + payloadLength) {
  return null;
}

if (hasMask) {
    //注:有掩碼,掩碼長度爲4個字節,讀取掩碼的值
    mask = ByteBufferUtils.readBytes(buf, 4);
}

//第二階段解析
WsRequest websocketPacket = new WsRequest();
//注:設置各類屬性值
websocketPacket.setWsEof(fin);
websocketPacket.setWsHasMask(hasMask);
websocketPacket.setWsMask(mask);
websocketPacket.setWsOpcode(opcode);
websocketPacket.setWsBodyLength(payloadLength);

if (payloadLength == 0) {
    return websocketPacket;
}
//注:讀取payloadLength長度的body值
byte[] array = ByteBufferUtils.readBytes(buf, payloadLength);
if (hasMask) {
    //注:有掩碼,因此須要經過掩碼解析
    for (int i = 0; i < array.length; i++) {
        //^操做 位值相同爲0 ,不一樣爲1
        // 00001111 ^ 00001010 = 00000101
        array[i] = (byte) (array[i] ^ mask[i % 4]);
    }
}

if (!fin) {
//lastParts.add(array);

    log.error("payloadLength {}, lastParts size {}, array length {}", payloadLength, lastParts.size(), array.length);
    return websocketPacket;
} else {
    int allLength = array.length;
    if (lastParts != null) {
    for (byte[] part : lastParts) {
      allLength += part.length;
  }
byte[] allByte = new byte[allLength];

int offset = 0;
for (byte[] part : lastParts) {
    System.arraycopy(part, 0, allByte, offset, part.length);
    offset += part.length;
}
System.arraycopy(array, 0, allByte, offset, array.length);
    array = allByte;
}

websocketPacket.setBody(array);

if (opcode == Opcode.BINARY) {

} else {
    try {
        String text = null;
        text = new String(array, WsPacket.CHARSET_NAME);
        websocketPacket.setWsBodyText(text);
    } catch (UnsupportedEncodingException e) {
        log.error(e.toString(), e);
        }
    }
}
    return websocketPacket;
}

總結

  因爲本人也是小菜鳥,能看懂的就那麼多了,不少代碼都讀不懂。哎,大神就是大神啊,編碼都精準到每個bit上了。不過經過閱讀源碼和websocket文檔對比,仍是多少可以理解一些的。再次感謝開源貢獻者,向全部開源大神致敬。

相關文章
相關標籤/搜索