WebSocket 在 SpringBoot 中的使用

介紹

WebSocket 是 HTML5 開始提供的一種在單個 TCP 鏈接上進行全雙工通信的協議。

WebSocket 使得客戶端和服務器之間的數據交換變得更加簡單，容許服務端主動向客戶端推送數據。在 WebSocket API 中，瀏覽器和服務器只須要完成一次握手，二者之間就直接能夠建立持久性的鏈接，並進行雙向數據傳輸。

在 WebSocket API 中，瀏覽器和服務器只須要作一個握手的動做，而後，瀏覽器和服務器之間就造成了一條快速通道。二者之間就直接能夠數據互相傳送。

如今，不少網站爲了實現推送技術，所用的技術都是 Ajax 輪詢。輪詢是在特定的的時間間隔（如每1秒），由瀏覽器對服務器發出HTTP請求，而後由服務器返回最新的數據給客戶端的瀏覽器。這種傳統的模式帶來很明顯的缺點，即瀏覽器須要不斷的向服務器發出請求，然而HTTP請求可能包含較長的頭部，其中真正有效的數據可能只是很小的一部分，顯然這樣會浪費不少的帶寬等資源。

HTML5 定義的 WebSocket 協議，能更好的節省服務器資源和帶寬，而且可以更實時地進行通信。

瀏覽器經過 JavaScript 向服務器發出創建 WebSocket 鏈接的請求，鏈接創建之後，客戶端和服務器端就能夠經過 TCP 鏈接直接交換數據。

當你獲取 Web Socket 鏈接後，你能夠經過 send() 方法來向服務器發送數據，並經過 onmessage 事件來接收服務器返回的數據。

如下 API 用於建立 WebSocket 對象。

WebSocket協議

WebSocket並非全新的協議，而是利用了HTTP協議來創建鏈接。咱們來看看WebSocket鏈接是如何建立的。

首先，WebSocket鏈接必須由瀏覽器發起，由於請求協議是一個標準的HTTP請求，格式以下：

GET ws://localhost:3000/ws/chat HTTP/1.1
Host: localhost
Upgrade: websocket
Connection: Upgrade
Origin: http://localhost:3000
Sec-WebSocket-Key: client-random-string
Sec-WebSocket-Version: 13

該請求和普通的HTTP請求有幾點不一樣：

1. GET請求的地址不是相似/path/，而是以ws://開頭的地址；
2. 請求頭Upgrade: websocket和Connection: Upgrade表示這個鏈接將要被轉換爲WebSocket鏈接；
3. Sec-WebSocket-Key是用於標識這個鏈接，並不是用於加密數據；
4. Sec-WebSocket-Version指定了WebSocket的協議版本。

隨後，服務器若是接受該請求，就會返回以下響應：

HTTP/1.1 101 Switching Protocols
Upgrade: websocket
Connection: Upgrade
Sec-WebSocket-Accept: server-random-string

該響應代碼101表示本次鏈接的 HTTP 協議即將被更改，更改後的協議就是Upgrade: websocket指定的WebSocket協議。

版本號和子協議規定了雙方能理解的數據格式，以及是否支持壓縮等等。若是僅使用WebSocket的API，就不須要關心這些。

如今，一個WebSocket鏈接就創建成功，瀏覽器和服務器就能夠隨時主動發送消息給對方。消息有兩種，一種是文本，一種是二進制數據。一般，咱們能夠發送JSON格式的文本，這樣，在瀏覽器處理起來就十分容易。

爲何 WebSocket 鏈接能夠實現全雙工通訊而HTTP鏈接不行呢？實際上 HTTP 協議是創建在 TCP 協議之上的，TCP 協議自己就實現了全雙工通訊，可是 HTTP 協議的請求－應答機制限制了全雙工通訊。WebSocket 鏈接創建之後，其實只是簡單規定了一下：接下來，我們通訊就不使用HTTP協議了，直接互相發數據吧。

安全的WebSocket鏈接機制和HTTPS相似。首先，瀏覽器用wss://xxx建立WebSocket鏈接時，會先經過HTTPS建立安全的鏈接，而後，該 HTTPS 鏈接升級爲 WebSocket 鏈接，底層通訊走的仍然是安全的 SSL/TLS 協議。

瀏覽器

很顯然，要支持WebSocket通訊，瀏覽器得支持這個協議，這樣才能發出ws://xxx的請求。目前，支持WebSocket的主流瀏覽器以下：

• Chrome
• Firefox
• IE >= 10
• Sarafi >= 6
• Android >= 4.4
• iOS >= 8

SpringBoot 中 WebSocket 的使用

加入 maven 依賴

SpringBoot 2.0 以後，直接導此包便可：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-websocket</artifactId>
    <version>1.5.10.RELEASE</version>
</dependency>

WebSocketConfig

開啓 websocket 支持，若是是使用獨立的 servlet 容器（如tomcat），則不須要注入 ServerEndpointExporter

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;

/**
 * 開啓 websocket 支持<br>
 *     配置WebSocketEndpointServer
 *     若是使用獨立的servlet容器，不是使用SpringBoot的內置容器
 *     不須要注入ServerEndpointExporter, 它將由容器本身提供和管理
 * @author zhangchuanqiang
 */
@Configuration
public class WebSocketConfig {
	@Bean
	public ServerEndpointExporter serverEndpointExporter() {
		return new ServerEndpointExporter();
	}
}

WebSocketServer

websocket 服務器，至關於一個ws協議的 Controller

import lombok.extern.java.Log;
import org.springframework.stereotype.Component;

import javax.websocket.*;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.concurrent.CopyOnWriteArraySet;
import java.util.concurrent.atomic.AtomicInteger;

/**
 * @Description: WebSocketServer
 * @Author: zcq
 * @Date: 2019-06-14 14:37
 */
@Log
@Component
@ServerEndpoint("/index/{sid}")  //該註解表示該類被聲明爲一個webSocket終端
public class MySocket {
	/**
	 * 初始在線人數
	 */
	private static AtomicInteger online_num = new AtomicInteger(0);
	/**
	 * 線程安全的socket集合，存儲在線用戶實例
	 */
	private static CopyOnWriteArraySet<MySocket> webSocketSet = new CopyOnWriteArraySet<MySocket>();
	/**
	 * 當前會話
	 */
	private Session session;

	/**
	 * 接收用戶id
	 */
	private String sid = "";

	/**
	 * 鏈接創建成功調用的方法
	 */
	@OnOpen
	public void onOpen(Session session, @PathParam("sid") String sid) {
		this.sid = sid;
		this.session = session;
		webSocketSet.add(this);
		// 在線人數+1
		addOnlineCount();
		log.info("有連接加入，當前人數爲:" + getOnline_num());
		sendMessageBasic("有連接加入，當前人數爲:" + getOnline_num());
	}

	/**
	 * 鏈接關閉調用的方法
	 */
	/**
	 * 鏈接關閉調用的方法
	 */
	@OnClose
	public void onClose() {
		webSocketSet.remove(this);
		subOnlineCount(); //在線數減1
		log.info("有一鏈接關閉！當前在線人數爲" + getOnline_num());
	}

	/**
	 * 收到客戶端消息後調用的方法
	 *
	 * @param message
	 * @param session
	 * @throws IOException
	 */
	@OnMessage
	public void onMessage(String message, Session session) throws IOException {
		log.info("來自客戶端的消息:" + message);
		for (MySocket item : webSocketSet) {
			item.sendMessageBasic(message);
		}
	}

	/**
	 * @param session
	 * @param error
	 */
	@OnError
	public void onError(Session session, Throwable error) {
		log.info("發生錯誤");
		error.printStackTrace();
	}

	/**
	 * 實現服務器主動推送
	 */
	public void sendMessageBasic(String message) {
		try {
			this.session.getBasicRemote().sendText(message);
		} catch (IOException e) {
			e.printStackTrace();
		}
	}

	/**
	 * 實現服務器主動推送
	 */
	public void sendMessageAsync(String message) {
		this.session.getAsyncRemote().sendText(message);
	}

	/**
	 * 羣發自定義消息
	 */
	public static void sendInfo(String message, @PathParam("sid") String sid) throws IOException {
		log.info("推送消息到窗口" + sid + "，推送內容:" + message);
		for (MySocket item : webSocketSet) {
			//這裏能夠設定只推送給這個sid的，爲null則所有推送
			if (sid == null || "all".equals(sid)) {
				item.sendMessageBasic(message);
			} else if (item.sid.equals(sid)) {
				item.sendMessageBasic(message);
			}
		}
	}

	public static MySocket getWebSocket(String sid) {
		if (webSocketSet == null || webSocketSet.size() <= 0) {
			return null;
		}
		for (MySocket item : webSocketSet) {
			if (sid.equals(item.sid)) {
				return item;
			}
		}
		return null;
	}

	public AtomicInteger getOnline_num() {
		return MySocket.online_num;
	}

	public int subOnlineCount() {
		return MySocket.online_num.addAndGet(-1);
	}

	public int addOnlineCount() {
		return MySocket.online_num.addAndGet(1);
	}
}

推送消息

/**
 * @Description: 頁面請求
 * @Author: zcq
 * @Date: 2019-06-14 14:35
 */
@GetMapping("/socket/{cid}")
public ModelAndView socket(@PathVariable String cid) {
    ModelAndView mav = new ModelAndView("/index1");
    mav.addObject("cid", cid);
    return mav;
}

/**
 * @Description: 推送數據接口
 * @Author: zcq
 * @Date: 2019-06-14 14:35
 * @param cid 爲 all 時，爲推送所有
 */
@ResponseBody
@RequestMapping("/socket/push/{cid}")
public Result pushToWeb(@PathVariable String cid, String message) {
    try {
        MySocket.sendInfo(message, cid);
    } catch (IOException e) {
        e.printStackTrace();
        return Result.error();
    }
    return Result.success(cid);
}

頁面發起 socket 請求

協議是 ws 或者 wss，能夠封裝了一些 basePath 的路徑類，能夠replace(「http」,「ws」)來替換協議。

<html>
<head>
    <meta charset="utf-8">
    <title>My WebSocket</title>
</head>

<body>
Welcome<br/>
<input id="text" type="text"/>
<button onclick="send()">Send</button>
<button onclick="closeWebSocket()">Close</button>
<div id="message">
</div>
</body>

<script type="text/javascript">
    var websocket = null;
    //判斷當前瀏覽器是否支持WebSocket
    if ('WebSocket' in window) {
        // Websocket 使用 ws 或 wss 的統一資源標誌符，相似於 HTTPS，其中 wss 表示在 TLS 之上的 Websocket。
        // onlinenum = new WebSocket("ws://localhost:8086/websocket/20");
        onlinenum = new WebSocket("http://localhost:8086/websocket/${cid}".replace("http", "ws").replace("https", "ws"));
    } else {
        alert('Not support websocket')
    }

    //鏈接發生錯誤的回調方法
    onlinenum.onerror = function () {
        setMessageInnerHTML("error");
    };

    //鏈接成功創建的回調方法
    onlinenum.onopen = function (event) {
        setMessageInnerHTML("open");
    }

    //接收到消息的回調方法
    onlinenum.onmessage = function (event) {
        setMessageInnerHTML(event.data);
    }

    //鏈接關閉的回調方法
    onlinenum.onclose = function () {
        setMessageInnerHTML("close");
    }

    //監聽窗口關閉事件，當窗口關閉時，主動去關閉websocket鏈接，防止鏈接還沒斷開就關閉窗口，server端會拋異常。
    window.onbeforeunload = function () {
        onlinenum.close();
    };

    //將消息顯示在網頁上
    function setMessageInnerHTML(innerHTML) {
        document.getElementById('message').innerHTML += innerHTML + '<br/>';
    }

    //關閉鏈接
    function closeWebSocket() {
        onlinenum.close();
    }

    //發送消息
    function send() {
        const message = document.getElementById('text').value;
        onlinenum.send(message);
    }
</script>
</html>

問題補充： 

• 若是但願打成WAR包，部署到TOMCAT中。須要使啓動類繼承：SpringBootServletInitializer，並加入方法： 

/** 
* 用於支持打包成 WAR，部署到 tomcat 中
*/ 
@Override 
    protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) { 
    return builder.sources(AssetApplication.class); 
} 

• 若是打成WAR包後，在TOMCAT中啓動時報錯：Multiple Endpoints may not be deployed to the same path 註釋掉 WebSocketServer 類上的 @Component 註解。

資料

• WebSocket API
• WebSocket 廖雪峯 node.js 編寫聊天室
• SpringBoot2.0集成WebSocket，實現後臺向前端推送信息