微服務-springboot+websocket線上聊天室(多人聊天)
阿新 • • 發佈：2019-01-05
一.引入依賴
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
二.注入ServerEndpointExporter
編寫一個WebSocketConfig配置類，注入物件ServerEndpointExporter，
這個bean會自動註冊使用了@ServerEndpoint註解宣告的Websocket endpoint
import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.web.socket.server.standard.ServerEndpointExporter; /** * @Description: 編寫一個WebSocketConfig配置類，注入物件ServerEndpointExporter， * 這個bean會自動註冊使用了@ServerEndpoint註解宣告的Websocket endpoint*/ @Configuration public class WebSocketConfig { @Bean public ServerEndpointExporter serverEndpointExporter() { return new ServerEndpointExporter(); } }
三.websocket的具體實現類
使用springboot的唯一區別是要@Component宣告下，而使用獨立容器是由容器自己管理websocket的，
但在springboot中連容器都是spring管理的。
雖然@Component預設是單例模式的，但springboot還是會為每個websocket連線初始化一個bean，
所以可以用一個靜態set儲存起來。
import org.springframework.stereotype.Component; import javax.websocket.*; import javax.websocket.server.ServerEndpoint; import java.util.concurrent.CopyOnWriteArraySet; /** * * @Description: websocket的具體實現類 * * 使用springboot的唯一區別是要@Component宣告下，而使用獨立容器是由容器自己管理websocket的， * * 但在springboot中連容器都是spring管理的。 * 雖然@Component預設是單例模式的，但springboot還是會為每個websocket連線初始化一個bean， * 所以可以用一個靜態set儲存起來。 */ @ServerEndpoint(value = "/websocket") @Component public class MyWebSocket { //用來存放每個客戶端對應的MyWebSocket物件。 private static CopyOnWriteArraySet<MyWebSocket> webSocketSet = new CopyOnWriteArraySet<MyWebSocket>(); //與某個客戶端的連線會話，需要通過它來給客戶端傳送資料 private Session session; /** * 連線建立成功呼叫的方法 */ @OnOpen public void onOpen(Session session) { this.session = session; webSocketSet.add(this); //加入set中 System.out.println("有新連線加入！當前線上人數為" + webSocketSet.size()); //群發訊息，告訴每一位 broadcast(session.getId()+"連線上WebSocket-->當前線上人數為："+webSocketSet.size()); } /** * 連線關閉呼叫的方法 */ @OnClose public void onClose() { webSocketSet.remove(this); //從set中刪除 System.out.println("有一連線關閉！當前線上人數為" + webSocketSet.size()); //群發訊息，告訴每一位 broadcast(session.getId()+"下線，當前線上人數為："+webSocketSet.size()); } /** * 收到客戶端訊息後呼叫的方法 * * @param message 客戶端傳送過來的訊息 * */ @OnMessage public void onMessage(String message, Session session) { System.out.println("來自客戶端的訊息:" + message); //群發訊息 broadcast(message); } /** * 發生錯誤時呼叫 * */ @OnError public void onError(Session session, Throwable error) { System.out.println("發生錯誤"); error.printStackTrace(); } /** * 群發自定義訊息 * */ public void broadcast(String message){ for (MyWebSocket item : webSocketSet) { //同步非同步說明參考：http://blog.csdn.net/who_is_xiaoming/article/details/53287691 //this.session.getBasicRemote().sendText(message); item.session.getAsyncRemote().sendText(message);//非同步傳送訊息. } } }
四.編寫index.ftl
<!DOCTYPE html>
<html>
<head lang="en">
<title>Spring Boot Demo - FreeMarker</title>
<link href="/css/index.css" rel="stylesheet" />
<script src="/js/index.js"></script>
</head>
<body>
<button onclick="connectWebSocket()">連線WebSocket</button>
<button onclick="closeWebSocket()">斷開連線</button>
<hr />
<br />
訊息：<input id="text" type="text" />
<button onclick="send()">傳送訊息</button>
<div id="message"></div>
</body>
</html>
五.編寫index.js
var websocket = null; function connectWebSocket(){ //判斷當前瀏覽器是否支援WebSocket //判斷當前瀏覽器是否支援WebSocket if ('WebSocket'in window) { websocket = new WebSocket("ws://localhost:8080/websocket"); } else { alert('當前瀏覽器不支援websocket'); } //連線發生錯誤的回撥方法 websocket.onerror = function() { setMessageInnerHTML("error"); }; //接收到訊息的回撥方法 websocket.onmessage = function(event) { setMessageInnerHTML(event.data); } //連線關閉的回撥方法 websocket.onclose = function() { setMessageInnerHTML("Loc MSG:關閉連線"); } //監聽視窗關閉事件，當視窗關閉時，主動去關閉websocket連線，防止連線還沒斷開就關閉視窗，server端會拋異常。 window.onbeforeunload = function() { websocket.close(); } } //將訊息顯示在網頁上 function setMessageInnerHTML(innerHTML) { document.getElementById('message').innerHTML += innerHTML + '<br/>'; } //關閉連線 function closeWebSocket() { websocket.close(); } //傳送訊息 function send() { var message = document.getElementById('text').value; websocket.send(message); }
六.index.css
#message{ margin-top:40px; border:1px solid gray; padding:20px; }
七.controller
import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestMapping; @Controller @RequestMapping("web") public class WebController { @RequestMapping("index") public String index(){ return "index"; } }
測試：http://localhost:8080/web/index
點選【連線WebSocket】,然後就可以傳送訊息了。
開啟另外一個瀏覽器或者直接開啟一個TAB訪問地址http://localhost:8080/web/index
點選【連線WebSocket】,然後就可以傳送訊息了。
觀察兩邊的資訊列印，看是否可以接收到訊息。
原始碼：下載地址