利用 Go 語言編寫一個(gè)簡單的 WebSocket 推送服務(wù)
本文中代碼可以在 github.com/alfred-zhong/wserver 獲取。
背景
最近拿到需求要在網(wǎng)頁上展示報(bào)警信息。以往報(bào)警信息都是通過短信,微信和 App 推送給用戶的,現(xiàn)在要讓登錄用戶在網(wǎng)頁端也能實(shí)時(shí)接收到報(bào)警推送。
依稀記得以前工作的時(shí)候遇到過類似的需求。因?yàn)橐郧暗臑g覽器標(biāo)準(zhǔn)比較陳舊,并且那時(shí)用 Java 較多,所以那時(shí)候解決這個(gè)問題就用了 Comet4J。具體的原理就是長輪詢,長鏈接。但現(xiàn)在畢竟 html5 流行開來了,IE 都被 Edge 接替了,再用以前這種技術(shù)就顯得過時(shí)。
很早以前就聽過 WebSocket 的大名,但因?yàn)槟菚r(shí)很多用戶的瀏覽器還不支持,所以對(duì)這個(gè)技術(shù)也就是淺嘗輒止,沒有太深入研究過。現(xiàn)在趁著項(xiàng)目需要,就來稍微深入了解一下。
websocket 簡介
以往瀏覽器要獲取服務(wù)端數(shù)據(jù),都是通過發(fā)送 HTTP 請(qǐng)求,然后等待服務(wù)端回應(yīng)的。也就是說瀏覽器端一直是整個(gè)請(qǐng)求的發(fā)起者,只有它主動(dòng),才能獲取到數(shù)據(jù)。而要讓瀏覽器一側(cè)能夠獲取到服務(wù)端的實(shí)時(shí)數(shù)據(jù),就需要不停地向服務(wù)端發(fā)起請(qǐng)求。雖然大多數(shù)情況下并沒有獲取到實(shí)際數(shù)據(jù),但這大大增加了網(wǎng)絡(luò)壓力,對(duì)于服務(wù)端來說壓力也直線上升。
后來我們學(xué)會(huì)了使用長連接 + 長輪詢的方式。換句話說,也就是延長 HTTP 請(qǐng)求的存在時(shí)間,盡量保持 HTTP 連接。雖然這在一定程度上降低了不少壓力,但仍然需要不停地進(jìn)行輪詢,也做不到真正的實(shí)時(shí)性。(借用一張圖)
隨著 HTML5 的到來,WebSocket 在 2011 年被定為標(biāo)準(zhǔn)(詳情請(qǐng)參見 RFC 6455)。
借用 《Go Web 編程》的話。WebSocket 采用了一些特殊的報(bào)頭,使得瀏覽器和服務(wù)器只需要做一個(gè)握手的動(dòng)作,就可以在瀏覽器和服務(wù)器之間建立一條連接通道。且此連接會(huì)保持在活動(dòng)狀態(tài),你可以使用 JavaScript 來向連接寫入或從中接收數(shù)據(jù),就像在使用一個(gè)常規(guī)的 TCP Socket 一樣。它解決了 Web 實(shí)時(shí)化的問題。
由于 WebSocket 是全雙工通信,所以當(dāng)建立了 WebSocket 連接之后,接下來的通信就類似于傳統(tǒng)的 TCP 通信了??蛻舳撕头?wù)端可以相互發(fā)送數(shù)據(jù),不再有實(shí)時(shí)性的問題。
開發(fā)包的選擇
在 Go 官方的 SDK 中,并不包含對(duì) WebSocket 的支持,所以必須使用第三方庫。
要使用 Golang 開發(fā) WebSocket,選擇基本就在 x/net/websocket 和 gorilla/websocket 之間?!禛o Web 編程》一書中的例子使用了 x/net/websocket 作為開發(fā)包,而且貌似它也更加官方且正式。而實(shí)際根據(jù)我在網(wǎng)上查詢得到的反饋看來,并非如此。x/net/websocket 貌似 Bug 較多,且較為不穩(wěn)定,問題解決也并不及時(shí)。相比之下,gorilla/websocket 則更加優(yōu)秀。
還有對(duì)于 Gorilla web toolkit 組織的貢獻(xiàn),必須予以感謝。🙏。其下不僅有 WebSocket 的實(shí)現(xiàn),也有一些其他工具。歡迎大家使用并且能夠給予反饋或貢獻(xiàn)。
推送服務(wù)實(shí)現(xiàn)
基本原理
項(xiàng)目初步設(shè)計(jì)如下:
server 啟動(dòng)以后會(huì)注冊(cè)兩個(gè) Handler。
websocketHandler 用于提供瀏覽器端發(fā)送 Upgrade 請(qǐng)求并升級(jí)為 WebSocket 連接。
pushHandler 用于提供外部推送端發(fā)送推送數(shù)據(jù)的請(qǐng)求。
瀏覽器首先連接 websocketHandler (默認(rèn)地址為 ws://ip:port/ws)升級(jí)請(qǐng)求為 WebSocket 連接,當(dāng)連接建立之后需要發(fā)送注冊(cè)信息進(jìn)行注冊(cè)。這里注冊(cè)信息中包含一個(gè) token 信息。server 會(huì)對(duì)提供的 token 進(jìn)行驗(yàn)證并獲取到相應(yīng)的 userId(通常來說,一個(gè) userId 可能同時(shí)關(guān)聯(lián)許多 token),并保存維護(hù)好 token, userId 和 conn(連接)之間的關(guān)系。
推送端發(fā)送推送數(shù)據(jù)的請(qǐng)求到 pushHandler(默認(rèn)地址為 ws://ip:port/push),請(qǐng)求中包含了 userId 字段和 message 字段。server 會(huì)根據(jù) userId 獲取到所有此時(shí)連接到該 server 的 conn,然后將 message 一一進(jìn)行推送。
由于推送服務(wù)的實(shí)時(shí)性,推送的數(shù)據(jù)并沒有也不需要進(jìn)行緩存。
代碼詳解
我在此處會(huì)稍微講述一下代碼的基本構(gòu)成,也順便說說 Go 語言中一些常用的寫法和模式(本人也是從其他語言轉(zhuǎn)向 Go 語言,畢竟 Go 語言也相當(dāng)年輕。所以有建議的話,敬請(qǐng)?zhí)岢?。)。由?Go 語言的發(fā)明人和一些主要維護(hù)者大都來自于 C/C++ 語言,所以 Go 語言的代碼也更偏向于 C/C++ 系。
首先先看一下 Server 的結(jié)構(gòu):
// Server defines parameters for running websocket server. type Server struct { // Address for server to listen on Addr string // Path for websocket request, default "/ws". WSPath string // Path for push message, default "/push". PushPath string // Upgrader is for upgrade connection to websocket connection using // "github.com/gorilla/websocket". // // If Upgrader is nil, default upgrader will be used. Default upgrader is // set ReadBufferSize and WriteBufferSize to 1024, and CheckOrigin always // returns true. Upgrader *websocket.Upgrader // Check token if it's valid and return userID. If token is valid, userID // must be returned and ok should be true. Otherwise ok should be false. AuthToken func(token string) (userID string, ok bool) // Authorize push request. Message will be sent if it returns true, // otherwise the request will be discarded. Default nil and push request // will always be accepted. PushAuth func(r *http.Request) bool wh *websocketHandler ph *pushHandler }
PS: 由于我整個(gè)項(xiàng)目的注釋都是用英文寫的,所以見諒了,希望不妨礙閱讀。
這里說一下 Upgrader *websocket.Upgrader,這是 gorilla/websocket 包的對(duì)象,它用來升級(jí) HTTP 請(qǐng)求。
如果一個(gè)結(jié)構(gòu)體參數(shù)過多,通常不建議直接初始化,而是使用它提供的 New 方法。這里是:
// NewServer creates a new Server. func NewServer(addr string) *Server { return &Server{ Addr: addr, WSPath: serverDefaultWSPath, PushPath: serverDefaultPushPath, } }
這也是 Go 語言對(duì)外提供初始化方法的一種常見用法。
然后 Server 使用 ListenAndServe 方法啟動(dòng)并監(jiān)聽端口,與 http 包的使用類似:
// ListenAndServe listens on the TCP network address and handle websocket // request. func (s *Server) ListenAndServe() error { b := &binder{ userID2EventConnMap: make(map[string]*[]eventConn), connID2UserIDMap: make(map[string]string), } // websocket request handler wh := websocketHandler{ upgrader: defaultUpgrader, binder: b, } if s.Upgrader != nil { wh.upgrader = s.Upgrader } if s.AuthToken != nil { wh.calcUserIDFunc = s.AuthToken } s.wh = &wh http.Handle(s.WSPath, s.wh) // push request handler ph := pushHandler{ binder: b, } if s.PushAuth != nil { ph.authFunc = s.PushAuth } s.ph = &ph http.Handle(s.PushPath, s.ph) return http.ListenAndServe(s.Addr, nil) }
這里我們生成了兩個(gè) Handler,分別為 websocketHandler 和 pushHandler。websocketHandler 負(fù)責(zé)與瀏覽器建立連接并傳輸數(shù)據(jù),而 pushHandler 則處理推送端的請(qǐng)求??梢钥吹剑@里兩個(gè) Handler 都封裝了一個(gè) binder 對(duì)象。這個(gè) binder 用于維護(hù) token <-> userID <-> Conn 的關(guān)系:
// binder is defined to store the relation of userID and eventConn type binder struct { mu sync.RWMutex // map stores key: userID and value of related slice of eventConn userID2EventConnMap map[string]*[]eventConn // map stores key: connID and value: userID connID2UserIDMap map[string]string }
websocketHandler
具體看一下 websocketHandler 的實(shí)現(xiàn)。
// websocketHandler defines to handle websocket upgrade request. type websocketHandler struct { // upgrader is used to upgrade request. upgrader *websocket.Upgrader // binder stores relations about websocket connection and userID. binder *binder // calcUserIDFunc defines to calculate userID by token. The userID will // be equal to token if this function is nil. calcUserIDFunc func(token string) (userID string, ok bool) }
很簡單的結(jié)構(gòu)。websocketHandler 實(shí)現(xiàn)了 http.Handler 接口:
// First try to upgrade connection to websocket. If success, connection will // be kept until client send close message or server drop them. func (wh *websocketHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) { wsConn, err := wh.upgrader.Upgrade(w, r, nil) if err != nil { return } defer wsConn.Close() // handle Websocket request conn := NewConn(wsConn) conn.AfterReadFunc = func(messageType int, r io.Reader) { var rm RegisterMessage decoder := json.NewDecoder(r) if err := decoder.Decode(&rm); err != nil { return } // calculate userID by token userID := rm.Token if wh.calcUserIDFunc != nil { uID, ok := wh.calcUserIDFunc(rm.Token) if !ok { return } userID = uID } // bind wh.binder.Bind(userID, rm.Event, conn) } conn.BeforeCloseFunc = func() { // unbind wh.binder.Unbind(conn) } conn.Listen() }
首先將傳入的 http.Request 轉(zhuǎn)換為 websocket.Conn,再將其分裝為我們自定義的一個(gè) wserver.Conn(封裝,或者說是組合,是 Go 語言的典型用法。記住,Go 語言沒有繼承,只有組合)。然后設(shè)置了 Conn 的 AfterReadFunc 和 BeforeCloseFunc 方法,接著啟動(dòng)了 conn.Listen()。AfterReadFunc 意思是當(dāng) Conn 讀取到數(shù)據(jù)后,嘗試驗(yàn)證并根據(jù) token 計(jì)算 userID,然乎 bind 注冊(cè)綁定。BeforeCloseFunc 則為 Conn 關(guān)閉前進(jìn)行解綁操作。
pushHandler
pushHandler 則容易理解。它解析請(qǐng)求然后推送數(shù)據(jù):
// Authorize if needed. Then decode the request and push message to each // realted websocket connection. func (s *pushHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) { if r.Method != http.MethodPost { w.WriteHeader(http.StatusMethodNotAllowed) return } // authorize if s.authFunc != nil { if ok := s.authFunc(r); !ok { w.WriteHeader(http.StatusUnauthorized) return } } // read request var pm PushMessage decoder := json.NewDecoder(r.Body) if err := decoder.Decode(&pm); err != nil { w.WriteHeader(http.StatusBadRequest) w.Write([]byte(ErrRequestIllegal.Error())) return } // validate the data if pm.UserID == "" || pm.Event == "" || pm.Message == "" { w.WriteHeader(http.StatusBadRequest) w.Write([]byte(ErrRequestIllegal.Error())) return } cnt, err := s.push(pm.UserID, pm.Event, pm.Message) if err != nil { w.WriteHeader(http.StatusInternalServerError) w.Write([]byte(err.Error())) return } result := strings.NewReader(fmt.Sprintf("message sent to %d clients", cnt)) io.Copy(w, result) }
Conn
Conn (此處指 wserver.Conn) 為 websocket.Conn 的包裝。
// Conn wraps websocket.Conn with Conn. It defines to listen and read // data from Conn. type Conn struct { Conn *websocket.Conn AfterReadFunc func(messageType int, r io.Reader) BeforeCloseFunc func() once sync.Once id string stopCh chan struct{} }
最主要的方法為 Listen():
// Listen listens for receive data from websocket connection. It blocks // until websocket connection is closed. func (c *Conn) Listen() { c.Conn.SetCloseHandler(func(code int, text string) error { if c.BeforeCloseFunc != nil { c.BeforeCloseFunc() } if err := c.Close(); err != nil { log.Println(err) } message := websocket.FormatCloseMessage(code, "") c.Conn.WriteControl(websocket.CloseMessage, message, time.Now().Add(time.Second)) return nil }) // Keeps reading from Conn util get error. ReadLoop: for { select { case <-c.stopCh: break ReadLoop default: messageType, r, err := c.Conn.NextReader() if err != nil { // TODO: handle read error maybe break ReadLoop } if c.AfterReadFunc != nil { c.AfterReadFunc(messageType, r) } } } }
主要設(shè)置了當(dāng) websocket 連接關(guān)閉時(shí)的處理和不停地讀取數(shù)據(jù)。
文中很難全面地描述整個(gè)代碼的運(yùn)作流程,像具體閱讀代碼,請(qǐng)前往 github.com/alfred-zhong/wserver 獲取。
后記
代碼我已經(jīng)進(jìn)行了一定的測(cè)試,也已經(jīng)在正式環(huán)境中運(yùn)行了一段時(shí)間。但是代碼可能仍然不夠穩(wěn)定,所以在使用過程中出現(xiàn)問題,也實(shí)屬正常。隨意隨時(shí)歡迎大家給我提 issues 或者 PRs。
總結(jié)
以上所述是小編給大家介紹的利用 Go 語言編寫一個(gè)簡單的 WebSocket 推送服務(wù),希望對(duì)大家有所幫助,如果大家有任何疑問請(qǐng)給我留言,小編會(huì)及時(shí)回復(fù)大家的。在此也非常感謝大家對(duì)腳本之家網(wǎng)站的支持!
相關(guān)文章
Golang對(duì)MongoDB數(shù)據(jù)庫的操作簡單封裝教程
mongodb官方?jīng)]有關(guān)于go的mongodb的驅(qū)動(dòng),因此只能使用第三方驅(qū)動(dòng),mgo就是使用最多的一種。下面這篇文章主要給大家介紹了關(guān)于利用Golang對(duì)MongoDB數(shù)據(jù)庫的操作簡單封裝的相關(guān)資料,需要的朋友可以參考下2018-07-07淺談Go語言不提供隱式數(shù)字轉(zhuǎn)換的原因
本文主要介紹了淺談Go語言不提供隱式數(shù)字轉(zhuǎn)換的原因,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2023-03-03Golang泛型實(shí)現(xiàn)類型轉(zhuǎn)換的方法實(shí)例
將一個(gè)值從一種類型轉(zhuǎn)換到另一種類型,便發(fā)生了類型轉(zhuǎn)換,下面這篇文章主要給大家介紹了關(guān)于Golang泛型實(shí)現(xiàn)類型轉(zhuǎn)換的相關(guān)資料,文中通過實(shí)例代碼介紹的非常詳細(xì),需要的朋友可以參考下2022-12-12golang?gorm學(xué)習(xí)之如何指定數(shù)據(jù)表
在sql中首先要指定是從哪張表中查詢,所以這篇文章小編就來帶大家一起看一下gorm是如何根據(jù)model來自動(dòng)解析表名的,感興趣的小伙伴可以了解下2023-08-08