文章目錄

• 前言
• 一、websocket資料
• • 1.什么是websocket
  • 2.websocket優(yōu)缺點
  • 3.WebSocket 原理
  • 4.WebSocket 源碼下載
• 二、客戶端
• • 1.開發(fā)
  • 2.測試
• 三、服務器
• • 1.開發(fā)
  • 2.測試
• 總結

---

前言

本文是websocket客戶端、服務器開發(fā)總結文檔，記錄從資料收集、代碼編寫到程序測試等需要注意的事項，幫助同樣需要開發(fā)websocket的同學能快速完成開發(fā)任務。

---

一、websocket資料

1.什么是websocket

WebSocket是一種在單個TCP連接上進行全雙工通信的協(xié)議。WebSocket通信協(xié)議于2011年被IETF定為標準RFC 6455，并由RFC7936補充規(guī)范。WebSocket API也被W3C定為標準。
WebSocket使得客戶端和服務器之間的數據交換變得更加簡單，允許服務端主動向客戶端推送數據。在WebSocket API中，瀏覽器和服務器只需要完成一次握手，兩者之間就直接可以創(chuàng)建持久性的連接，并進行雙向數據傳輸。

很多網站為了實現(xiàn)推送技術，所用的技術都是輪詢。輪詢是在特定的的時間間隔（如每1秒），由瀏覽器對服務器發(fā)出HTTP請求，然后由服務器返回最新的數據給客戶端的瀏覽器。這種傳統(tǒng)的模式帶來很明顯的缺點，即瀏覽器需要不斷的向服務器發(fā)出請求，然而HTTP請求可能包含較長的頭部，其中真正有效的數據可能只是很小的一部分，顯然這樣會浪費很多的帶寬等資源。
而比較新的技術去做輪詢的效果是Comet。這種技術雖然可以雙向通信，但依然需要反復發(fā)出請求。而且在Comet中，普遍采用的長鏈接，也會消耗服務器資源。
在這種情況下，HTML5定義了WebSocket協(xié)議，能更好的節(jié)省服務器資源和帶寬，并且能夠更實時地進行通訊。

2.websocket優(yōu)缺點

1、較少的控制開銷。在連接創(chuàng)建后，服務器和客戶端之間交換數據時，用于協(xié)議控制的數據包頭部相對較小。在不包含擴展的情況下，對于服務器到客戶端的內容，此頭部大小只有2至10字節(jié)（和數據包長度有關）；對于客戶端到服務器的內容，此頭部還需要加上額外的4字節(jié)的掩碼。相對于HTTP請求每次都要攜帶完整的頭部，此項開銷顯著減少了。
2、更強的實時性。由于協(xié)議是全雙工的，所以服務器可以隨時主動給客戶端下發(fā)數據。相對于HTTP請求需要等待客戶端發(fā)起請求服務端才能響應，延遲明顯更少；即使是和Comet等類似的長輪詢比較，其也能在短時間內更多次地傳遞數據。
3、保持連接狀態(tài)。與HTTP不同的是，Websocket需要先創(chuàng)建連接，這就使得其成為一種有狀態(tài)的協(xié)議，之后通信時可以省略部分狀態(tài)信息。而HTTP請求可能需要在每個請求都攜帶狀態(tài)信息（如身份認證等）。
4、更好的二進制支持。Websocket定義了二進制幀，相對HTTP，可以更輕松地處理二進制內容。
5、可以支持擴展。Websocket定義了擴展，用戶可以擴展協(xié)議、實現(xiàn)部分自定義的子協(xié)議。如部分瀏覽器支持壓縮等。
6、更好的壓縮效果。相對于HTTP壓縮，Websocket在適當的擴展支持下，可以沿用之前內容的上下文，在傳遞類似的數據時，可以顯著地提高壓縮率。

3.WebSocket 原理

websocket原理可以看這位大神的筆記：https://www.zhihu.com/question/20215561

4.WebSocket 源碼下載

本文websocket開發(fā)使用的開源庫是libwebsocket，其官網可以查看庫的相關資料。在Getting started-》Browse git可以下載源碼，當前使用的版本是v4.2。當然，你也可以從GitHub上下載源碼。

二、客戶端

1.開發(fā)

在下載的庫中，有客戶端的許多demo，路徑：libwebsockets-main\minimal-examples\ws-client。客戶端的目的是根據URL連接服務器，接受服務器推送來的數據以及把客戶端的數據發(fā)送到服務器。

客戶端的關鍵代碼解析：
1、connect_client填寫的user可以在callback_client中的user獲取，是一個上下文的用戶數據，在處理業(yè)務的時候需要用到；
2、連接成功后，會觸發(fā)LWS_CALLBACK_CLIENT_ESTABLISHED事件；
3、當服務器向客戶端推送數據時，觸發(fā)LWS_CALLBACK_CLIENT_RECEIVE，此時可以處理收到的數據,in是數據，len是數據長度；
4、當需要給服務器發(fā)數據的時候，需要手動觸發(fā)LWS_CALLBACK_CLIENT_WRITEABLE事件，觸發(fā)方法：調用lws_callback_on_writable((struct lws*)(client_wsi))方法，數據可以通過user保存，在callback_client中取出后發(fā)送。
5、客戶端需要收到數據，必須一直調用lws_service(context, 0)函數。只有調用這個函數，回調函數才會接收來自服務器的函數。我們可以啟動一個定時器或線程，一直執(zhí)行這個函數即可。
關鍵源碼如下：

static int callback_client(struct lws *wsi, enum lws_callback_reasons reason, void *user, void *in, size_t len) {char* out_payload = NULL;int out_payload_len = 0;int write_len = 0;char* sen_data = NULL;switch (reason) {case LWS_CALLBACK_CLIENT_CONNECTION_ERROR:log_warn("CLIENT_CONNECTION_ERROR: %s\n", in ? (char *)in : "(null)");//config_websocket_client->client_wsi = NULL;break;case LWS_CALLBACK_CLIENT_ESTABLISHED:log_info("%s: established\n", __func__);break;case LWS_CALLBACK_CLIENT_RECEIVE:log_info("RX: %s\n", (const char *)in);//收到服務器數據//處理數據break;case LWS_CALLBACK_CLIENT_CLOSED:break;case LWS_CALLBACK_CLIENT_WRITEABLE://可以發(fā)數據了//發(fā)送數據write_len = lws_write(wsi, (unsigned char*)sen_data, send_data_len, LWS_WRITE_TEXT);break;default:break;}return 0; }static int connect_client(void* user,struct lws_context *context, const char* protocol_name, void* client_wsi) {int ret = 0;struct lws_client_connect_info i;memset(&i, 0, sizeof(i));i.context = context;i.port = 1881;i.address = localhost;i.path = '/';i.host = i.address;i.origin = i.address;i.protocol = protocol_name;i.pwsi = (struct lws**)&(client_wsi);i.userdata = user;if (!lws_client_connect_via_info(&i)) {ret = -1;}url_destroy(server_url);return ret; }static int websocket_client_init(void* user) {struct lws_context *context;const struct lws_protocols protocols[] = {{ "lws-minimal-client", callback_client, 0, 0, 0, node, 0 },LWS_PROTOCOL_LIST_TERM};struct lws_context_creation_info info;int ret = 0;memset(&info, 0, sizeof info);log_info("LWS minimal ws client\n");info.options = LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT;info.port = CONTEXT_PORT_NO_LISTEN; /* we do not run any server */info.protocols = protocols;info.timeout_secs = 10;info.connect_timeout_secs = 30;info.gid = -1;info.uid = -1;/** since we know this lws context is only ever going to be used with* one client wsis / fds / sockets at a time, let lws know it doesn't* have to use the default allocations for fd tables up to ulimit -n.* It will just allocate for 1 internal and 1 (+ 1 http2 nwsi) that we* will use.*/info.fd_limit_per_thread = 1 + 1 + 1;context = lws_create_context(&info);if (!context) {log_info("lws init failed\n");return -1;}return connect_client(user, context, protocols[0].name); }

2.測試

測試客戶端，我們需要一個服務器，我們可以利用node-red搭建一個簡易的websocket服務器，用來測試我們的客戶端是否工作正常。關于node-red搭建客戶端和服務器做測試，可以參照這個大神的教程。

三、服務器

1.開發(fā)

在下載的庫中，有服務器端的許多demo，路徑：libwebsockets-main\minimal-examples\ws-server。服務器端的目的是創(chuàng)建websocket服務器，接受客戶端推送來的數據以及把數據發(fā)送到客戶端。

服務器的關鍵代碼解析：
1、websocket_listener_init填寫的user可以在callback_server中獲取，是一個上下文的用戶數據，在處理業(yè)務的時候需要用到，獲取方法：lws_context_user(lws_get_context(wsi))，我們可以用這個方式獲取上下文傳遞的user數據。這和客戶端獲取user數據是不同的，有點繞，本人也是研究了好一會才弄明白的。demo的user參數使用起來更迷糊，不看文檔，根本不會用。
2、有客戶端連接本服務器成功后，會觸發(fā)LWS_CALLBACK_CLIENT_ESTABLISHED事件，我們可以在這里記錄連接進來的客戶端；
3、當服務器向客戶端推送數據時，需要觸發(fā)LWS_CALLBACK_CLIENT_WRITEABLE事件，觸發(fā)方法：調用lws_callback_on_writable((struct lws*)(client_wsi))方法。需要發(fā)送的數據，需要事先保存在websocket_listener_init時的user對象內，在LWS_CALLBACK_CLIENT_WRITEABLE分支取出數據，發(fā)送給指定客戶端。
4、服務器端需要收到數據，必須一直調用lws_service(context, 0)函數。只有調用這個函數，回調函數才會接收來自客戶端的函數。我們可以啟動一個定時器或線程，一直執(zhí)行這個函數即可。
關鍵源碼如下：

static int callback_server(struct lws *wsi, enum lws_callback_reasons reason, void *user, void *in, size_t len) {int write_len = 0;char* sen_data = NULL;struct lws *client_wsi = NULL;struct session_data* client_session_data = NULL; switch (reason) {case LWS_CALLBACK_ESTABLISHED:log_info("%s: established\n", __func__);break;case LWS_CALLBACK_CLOSED:log_info("%s: closed\n", __func__);break;case LWS_CALLBACK_SERVER_WRITEABLE://可以發(fā)數據了write_len = lws_write(wsi, (unsigned char*)sen_data, send_data_len, LWS_WRITE_TEXT);break;case LWS_CALLBACK_RECEIVE://收到數據break;case LWS_CALLBACK_WSI_DESTROY://釋放資源break;default:break;}return 0; }static void* websocket_listener_init(void* user) {struct lws_context *context;const struct lws_protocols protocols[] = {{ "ws", callback_server, 0, 0, 0, node, 0 },LWS_PROTOCOL_LIST_TERM};struct lws_context_creation_info info;memset(&info, 0, sizeof info);log_info("LWS ws server\n");info.options = LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT | LWS_SERVER_OPTION_VALIDATE_UTF8;info.port = 1881;info.protocols = protocols;info.timeout_secs = 10;info.connect_timeout_secs = 30;info.gid = -1;info.uid = -1;info.user = user;context = lws_create_context(&info);if (!context) {log_info("lws init failed\n");return RET_FAIL;}return context; }

2.測試

測試服務器端，我們需要一個客戶端，我們可以利用node-red搭建一個簡易的websocket客戶端，用來測試我們的服務器是否工作正常。關于node-red搭建客戶端和服務器做測試，可以參照這個大神的教程。

---

總結

websocket是HTTP協(xié)議的升級，是一個全新的協(xié)議，使用libwebsockets庫開發(fā)客戶端和服務器是非常方便的，代碼也比較相似，關鍵是需要理清工作流程，把自己的業(yè)務代碼添加進這個框架內即可。

總結

以上是生活随笔為你收集整理的websocket客户端和服务器开发总结的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。