iOS 接入WebSocket


WebSocket是什么

WebSocket協(xié)議是 基于TCP 的一種網(wǎng)絡(luò)協(xié)議。
它實(shí)現(xiàn)了瀏覽器與服務(wù)器全雙工(full-duplex)通信——允許服務(wù)器主動(dòng)發(fā)送信息給客戶端。

websocket與http的區(qū)別




WebSocket基本原理

幀協(xié)議:

      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 ...                |
     +---------------------------------------------------------------+
  • fin(1 bit):指示該幀是否構(gòu)成該消息的最終幀。大多數(shù)情況下,消息適合于一個(gè)單一的幀,這一點(diǎn)總是默認(rèn)設(shè)置的。實(shí)驗(yàn)表明吞加,F(xiàn)irefox 在 32K 之后創(chuàng)建了第二個(gè)幀。

  • rsv1尽狠,rsv2衔憨,rsv3(1 bit each):必須為0,除非擴(kuò)展里協(xié)商定義了非零值的含義袄膏。如果收到一個(gè)非零值践图,并且協(xié)商的擴(kuò)展中沒有一個(gè)定義這個(gè)非零值的含義,那么接收端必須拋出失敗連接沉馆。

  • opcode(4bits):展示了幀表示什么码党。以下值目前正在使用:
    0x00:這個(gè)幀繼續(xù)前面的有效載荷德崭。
    0x01:此幀包含文本數(shù)據(jù)。
    0x02:這個(gè)幀包含二進(jìn)制數(shù)據(jù)揖盘。
    0x08:這個(gè)幀終止連接眉厨。
    0x09:這個(gè)幀是一個(gè) ping 。
    0x0a:這個(gè)幀是一個(gè) pong 兽狭。
    (正如你所看到的憾股,有足夠的值未被使用,它們已被保留供將來(lái)使用)箕慧。

  • mask(1 bit):指示連接是否掩蓋服球。就目前而言,從客戶端到服務(wù)器的每條消息都必須掩蓋颠焦,如果規(guī)范沒有掩蓋斩熊,規(guī)范就會(huì)終止連接。

  • payload_len(7 bits):有效載荷的長(zhǎng)度伐庭。 WebSocket 的幀有以下長(zhǎng)度括號(hào):
    0-125 表示有效載荷的長(zhǎng)度粉渠。 126 表示以下兩個(gè)字節(jié)表示長(zhǎng)度,127 表示接下來(lái)的 8 個(gè)字節(jié)表示長(zhǎng)度圾另。所以有效負(fù)載的長(zhǎng)度在 ?7bit霸株,16bit 和 64bit 括號(hào)內(nèi)。

  • masking-key(32 bits):從客戶端發(fā)送到服務(wù)器的所有幀都被幀中包含的 32 位值掩蓋盯捌。

  • payload:最可能被掩蓋的實(shí)際數(shù)據(jù)。它的長(zhǎng)度是 payload_len 的長(zhǎng)度蘑秽。



連接過(guò)程示意圖

其他特點(diǎn)包括:
(1)建立在 TCP 協(xié)議之上饺著,服務(wù)器端的實(shí)現(xiàn)比較容易。
(2)與 HTTP 協(xié)議有著良好的兼容性肠牲。默認(rèn)端口也是80和443幼衰,并且握手階段采用 HTTP 協(xié)議,因此握手時(shí)不容易屏蔽缀雳,能通過(guò)各種 HTTP 代理服務(wù)器渡嚣。
(3)數(shù)據(jù)格式比較輕量肥印,性能開銷小识椰,通信高效。
(4)可以發(fā)送文本深碱,也可以發(fā)送二進(jìn)制數(shù)據(jù)腹鹉。
(5)沒有同源限制,客戶端可以與任意服務(wù)器通信敷硅。
(6)協(xié)議標(biāo)識(shí)符是ws(如果加密功咒,則為wss)愉阎,服務(wù)器網(wǎng)址就是 URL。




WebSocket常見的使用場(chǎng)景

要求服務(wù)器可以主動(dòng)向客戶端推送信息力奋,客戶端也可以主動(dòng)向服務(wù)器發(fā)送信息榜旦。(也可以采用HTTP/2)




iOS端實(shí)現(xiàn)WebSocket連接的參考方案


SocketRocket

SocketRocket是facebook封裝的websocket開源庫(kù),采用純Objective-C編寫景殷。
使用者需要自己實(shí)現(xiàn)心跳機(jī)制溅呢,以及適配斷網(wǎng)重連等情況。

SocketIO

SocketIO將WebSocket滨彻、AJAX和其它的通信方式全部封裝成了統(tǒng)一的通信接口藕届,也就是說(shuō),我們?cè)谑褂肧ocketIO時(shí)亭饵,不用擔(dān)心兼容問(wèn)題休偶,底層會(huì)自動(dòng)選用最佳的通信方式。因此說(shuō)辜羊,WebSocket是SocketIO的一個(gè)子集踏兜。
另外,如果后端采用的是原生WebSocket八秃,不建議大家使用SocketIO碱妆。
因?yàn)镾ocketIO定制了專有的協(xié)議,并不是純粹的WebSocket昔驱,可能會(huì)遭遇適配問(wèn)題疹尾。
不過(guò),SocketIO的API極其易用V韪亍D杀尽!

Starscream

采用Swift編寫腋颠,不過(guò)筆者暫時(shí)還沒有用過(guò)繁成,不發(fā)表任何評(píng)論。




iOS端利用SocketRocket實(shí)現(xiàn)WebSocket連接



示例代碼如下淑玫,歡迎指正:

import Foundation
import SocketRocket
import Alamofire

/// Websocket連接中的通知
let FSWebSocketConnectingNotification = NSNotification.Name.init("FSWebSocketConnectingNotification")
/// Websocket連接成功的通知
let FSWebSocketDidOpenNotification = NSNotification.Name.init("FSWebSocketDidOpenNotification")
/// Websocket連接收到新消息的通知
let FSWebSocketDidReceiveMessageNotification = NSNotification.Name.init("FSWebSocketDidReceiveMessageNotification")
/// Websocket連接失敗的通知
let FSWebSocketFailWithErrorNotification = NSNotification.Name.init("FSWebSocketFailWithErrorNotification")
/// Websocket連接已關(guān)閉的通知
let FSWebSocketDidCloseNotification = NSNotification.Name.init("FSWebSocketDidCloseNotification")

/// websocket連接地址巾腕,請(qǐng)輸入有效的websocket地址!
let WSAddr = "ws://host:port/ws"

/// 心跳包發(fā)送間隔絮蒿,3分鐘
let PingDuration = 180

/// Websocket連接對(duì)象
class FSWebsocket: NSObject,SRWebSocketDelegate {
    
    static let `default` = FSWebsocket.init()
    /// 是否在斷開連接后自動(dòng)重連
    var autoReconnect = true
    
    private var reachabilityManager = NetworkReachabilityManager.init(host: "www.baidu.com")
    /// websocket連接地址
    private var addr = WSAddr
    /// websocket連接
    private var ws:SRWebSocket?
    /// 心跳包定時(shí)發(fā)送計(jì)時(shí)器
    private var heartbeatTimer:Timer?
    /// 重連計(jì)數(shù)器
    private var reconnectCount = 0
    
    override init() {
        super.init()
        
        NotificationCenter.default.addObserver(self, selector: #selector(appWillEnterForeground), name: NSNotification.Name.UIApplicationWillEnterForeground, object: nil)
        NotificationCenter.default.addObserver(self, selector: #selector(appDidEnterBackground), name: NSNotification.Name.UIApplicationDidEnterBackground, object: nil)
        
        // 切換網(wǎng)絡(luò)自動(dòng)重連
        reachabilityManager?.listener = { [weak self] (networkReachabilityStatus) in
            // 正在連接中或已經(jīng)連接成功尊搬,不需要重連
            if self?.ws?.readyState == .CONNECTING || self?.ws?.readyState == .OPEN{
                return
            }
            // 設(shè)置自動(dòng)重連才會(huì)進(jìn)行自動(dòng)重連
            if let s = self, s.autoReconnect{
                self?.reconnect()
            }
        }
        reachabilityManager?.startListening()
    }
    deinit {
        NotificationCenter.default.removeObserver(self)
    }
    
    @objc func appDidEnterBackground(){
        
        close()
    }
    @objc func appWillEnterForeground(){
        
        reconnect()
    }
    
    // MARK: - Send Message
    
    @discardableResult
    func sendJSON(_ json:[AnyHashable : Any]) -> NSError?{
        let jsonData = try? JSONSerialization.data(withJSONObject: json, options: JSONSerialization.WritingOptions.prettyPrinted)
        return self.sendData(jsonData)
    }
    
    @discardableResult
    func sendData(_ data:Data?) -> NSError?{
        
        guard ws?.readyState == SRReadyState.OPEN else{
            return NSError.init(domain: "FSWebsocket", code: SRStatusCodeGoingAway.rawValue, userInfo: nil)
        }
        ws?.send(data)
        return nil
    }
    
    // MARK: - Connection Management
    
    /// 連接websocket服務(wù)器
    func open(){
        
        let url = URL(string: self.addr)
        assert(url != nil)
        
        self.ws = SRWebSocket.init(url: url!)
        ws?.delegate = self
        ws?.open()
        NotificationCenter.default.post(name: FSWebSocketConnectingNotification, object: self)
    }
    
    /// 重新連接
    private func reconnect(){
        
        if !autoReconnect{
            return
        }
        if reconnectCount > 64 {
            return
        }
        
        let seconds = DispatchTime.now().uptimeNanoseconds + UInt64(reconnectCount) * NSEC_PER_SEC
        let time = DispatchTime.init(uptimeNanoseconds: seconds)
        DispatchQueue.main.asyncAfter(deadline: time) {
            self.ws?.close()
            self.ws = nil
            
            self.open()
        }
        
        if reconnectCount == 0 {
            reconnectCount = 1
        }
        reconnectCount *= 2
    }
    
    /// 關(guān)閉連接
    func close(){
        
        self.destroyHeartbeat()
        
        self.ws?.close()
        self.ws = nil
        
        resetConnectCount()
    }
    
    /// 發(fā)送心跳包
    @objc func heartbeat(){
        
        guard ws?.readyState == SRReadyState.OPEN else{
            return
        }
        self.ws?.sendPing(nil)
    }
    /// 啟動(dòng)心跳
    private func startHeartbeat(){
        
        let timer = Timer.init(timeInterval: TimeInterval(PingDuration), target: self, selector: #selector(heartbeat), userInfo: nil, repeats: true)
        self.heartbeatTimer = timer
        RunLoop.current.add(timer, forMode: RunLoopMode.commonModes)
    }
    /// 停止心跳
    private func destroyHeartbeat(){
        
        self.heartbeatTimer?.invalidate()
        self.heartbeatTimer = nil
    }
    /// 重置重連嘗試次數(shù)
    private func resetConnectCount(){
        
        reconnectCount = 0
    }
    
    
    // MARK: - SRWebSocketDelegate
    
    func webSocketDidOpen(_ webSocket: SRWebSocket!) {
        
        self.resetConnectCount()
        self.startHeartbeat()
        NotificationCenter.default.post(name: FSWebSocketDidOpenNotification, object: self)
    }
    
    func webSocket(_ webSocket: SRWebSocket!, didReceiveMessage message: Any!) {
        
        guard let msgString = message as? NSString else{
            return
        }
        guard let msgData = msgString.data(using: String.Encoding.utf8.rawValue) else{
            return
        }
        // 如果傳輸?shù)氖荍SON數(shù)據(jù),可以使用JSONSerialization將JSON字符串轉(zhuǎn)換為字典
        guard let msgJSON = try? JSONSerialization.jsonObject(with: msgData, options: JSONSerialization.ReadingOptions.allowFragments) else{
            return
        }
        NotificationCenter.default.post(name: FSWebSocketDidReceiveMessageNotification, object: self, userInfo: ["message":msgJSON])
    }
    
    func webSocket(_ webSocket: SRWebSocket!, didFailWithError error: Error!) {

        NotificationCenter.default.post(name: FSWebSocketFailWithErrorNotification, object: self, userInfo: ["error": error])
        // 連接失斖晾浴:
        if (error as NSError).code == 50{
            // 斷網(wǎng)毁嗦,不重連
            return
        }
        // 當(dāng)前頁(yè)面不需要使用websocket,不重連
        // 重連次數(shù)超過(guò)限制回铛,不重連
        reconnect()
    }
    
    func webSocket(_ webSocket: SRWebSocket!, didReceivePong pongPayload: Data!) {
        // 心跳包響應(yīng)回調(diào)
    }
    
    func webSocket(_ webSocket: SRWebSocket!, didCloseWithCode code: Int, reason: String!, wasClean: Bool) {
        
        // 連接被關(guān)閉
        NotificationCenter.default.post(name: FSWebSocketDidCloseNotification, object: self, userInfo: ["code": code, "reason": reason, "wasClean": wasClean])
        
        close()
    }
}




參考資料:
WebSocket 教程
iOS websocket接入
[iOS] 接入WebSocket記錄 + 一些個(gè)人經(jīng)驗(yàn)
解讀 JavaScript 之深入探索 WebSockets 和 HTTP/2
IETF Tools - The WebSocket Protocol

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末狗准,一起剝皮案震驚了整個(gè)濱河市克锣,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌腔长,老刑警劉巖袭祟,帶你破解...
    沈念sama閱讀 206,311評(píng)論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異捞附,居然都是意外死亡巾乳,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,339評(píng)論 2 382
  • 文/潘曉璐 我一進(jìn)店門鸟召,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)胆绊,“玉大人,你說(shuō)我怎么就攤上這事欧募⊙棺矗” “怎么了?”我有些...
    開封第一講書人閱讀 152,671評(píng)論 0 342
  • 文/不壞的土叔 我叫張陵跟继,是天一觀的道長(zhǎng)种冬。 經(jīng)常有香客問(wèn)我,道長(zhǎng)舔糖,這世上最難降的妖魔是什么娱两? 我笑而不...
    開封第一講書人閱讀 55,252評(píng)論 1 279
  • 正文 為了忘掉前任,我火速辦了婚禮金吗,結(jié)果婚禮上十兢,老公的妹妹穿的比我還像新娘。我一直安慰自己摇庙,他們只是感情好旱物,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,253評(píng)論 5 371
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著跟匆,像睡著了一般异袄。 火紅的嫁衣襯著肌膚如雪通砍。 梳的紋絲不亂的頭發(fā)上玛臂,一...
    開封第一講書人閱讀 49,031評(píng)論 1 285
  • 那天,我揣著相機(jī)與錄音封孙,去河邊找鬼迹冤。 笑死,一個(gè)胖子當(dāng)著我的面吹牛虎忌,可吹牛的內(nèi)容都是我干的泡徙。 我是一名探鬼主播,決...
    沈念sama閱讀 38,340評(píng)論 3 399
  • 文/蒼蘭香墨 我猛地睜開眼膜蠢,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼堪藐!你這毒婦竟也來(lái)了莉兰?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 36,973評(píng)論 0 259
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤礁竞,失蹤者是張志新(化名)和其女友劉穎糖荒,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體模捂,經(jīng)...
    沈念sama閱讀 43,466評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡捶朵,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,937評(píng)論 2 323
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了狂男。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片综看。...
    茶點(diǎn)故事閱讀 38,039評(píng)論 1 333
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖岖食,靈堂內(nèi)的尸體忽然破棺而出红碑,到底是詐尸還是另有隱情,我是刑警寧澤县耽,帶...
    沈念sama閱讀 33,701評(píng)論 4 323
  • 正文 年R本政府宣布句喷,位于F島的核電站,受9級(jí)特大地震影響兔毙,放射性物質(zhì)發(fā)生泄漏唾琼。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,254評(píng)論 3 307
  • 文/蒙蒙 一澎剥、第九天 我趴在偏房一處隱蔽的房頂上張望锡溯。 院中可真熱鬧,春花似錦哑姚、人聲如沸祭饭。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,259評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)倡蝙。三九已至,卻和暖如春绞佩,著一層夾襖步出監(jiān)牢的瞬間寺鸥,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,485評(píng)論 1 262
  • 我被黑心中介騙來(lái)泰國(guó)打工品山, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留胆建,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 45,497評(píng)論 2 354
  • 正文 我出身青樓肘交,卻偏偏與公主長(zhǎng)得像笆载,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,786評(píng)論 2 345

推薦閱讀更多精彩內(nèi)容