一、引入案例需要的jar
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- webSocket -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
二、核心代碼
1）、WebSocketConfig
@Configuration
//註解開啓使用STOMP協議來傳輸基於代理(message broker)的消息,這時控制器支持使用@MessageMapping,就像使用@RequestMapping一樣
@EnableWebSocketMessageBroker
//SpringBoot2.x將extends AbstractWebSocketMessageBrokerConfigurer改爲 implements WebSocketMessageBrokerConfigurer
public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {
@Override
public void registerStompEndpoints(StompEndpointRegistry registry) {//註冊STOMP協議的節點(endpoint),並映射指定的url
//註冊一個STOMP的endpoint,並指定使用SockJS協議
registry.addEndpoint("/endpointBroadcast").withSockJS();
}
@Override
public void configureMessageBroker(MessageBrokerRegistry registry) {//配置消息代理(Message Broker)
//廣播式應配置一個/topic消息代理
registry.enableSimpleBroker("/topic");
}
}
2）、 RequestMessage
/**
* @program: test_demo
* @description: 瀏覽器向服務器發送消息
* @author: HQ Zheng
* @create: 2019-12-04 09:58
*/
public class RequestMessage {
private String name;
public String getName(){
return name;
}
}
3）、ResponseMessage
/**
* @program: test_demo
* @description: 服務器返回數據給瀏覽器
* @author: HQ Zheng
* @create: 2019-12-04 10:02
*/
public class ResponseMessage {
private String responseMessage;
public ResponseMessage(String responseMessage){
this.responseMessage=responseMessage;
}
public String getResponseMessage(){
return responseMessage;
}
}
4）、WebMvcConfig
/**
* @program: test_demo
* @description: 配置viewController,爲頁面提供路徑映射
* @author: HQ Zheng
* @create: 2019-12-04 10:24
*/
@Controller
public class WebMvcConfig extends WebMvcConfigurerAdapter {
/**
* 配置viewController,提供映射路徑
*/
@Override
public void addViewControllers(ViewControllerRegistry registry) {
registry.addViewController("/webSocket").setViewName("/webSocket");
}
}
5）、 WebSocketController
/**
* @program: test_demo
* @description: webSocket 控制器
* @author: HQ Zheng
* @create: 2019-12-04 10:16
*/
@Controller
public class WebSocketController {
//當瀏覽器向服務端發送請求時,通過@MessageMapping映射/welcome這個地址,類似於@ResponseMapping
@MessageMapping("/welcome")
//當服務器有消息時,會對訂閱了@SendTo中的路徑的瀏覽器發送消息
@SendTo("/topic/getResponse")
public ResponseMessage say(RequestMessage requestMessage) {
try {
//睡眠1秒
Thread.sleep(1000);
} catch (InterruptedException e) {
e.printStackTrace();
}
return new ResponseMessage("welcome," + requestMessage.getName() + "!");
}
}
三、html 頁面代碼
<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8"/>
<title>SpringBoot實現廣播式WebSocket</title>
<script src="https://cdn.bootcss.com/jquery/3.4.1/jquery.js"></script>
<script src="https://cdn.bootcss.com/sockjs-client/1.3.0/sockjs.js"></script>
<script src="https://cdn.bootcss.com/stomp.js/2.3.3/stomp.js"></script>
</head>
<body>
<noscript><h2 style="color:#ff0000">抱歉,您的瀏覽器不支持改功能!</h2></noscript>
<div>
<div>
<button id="connect" onclick="connect();">連接</button>
<button id="disconnect" disabled="disabled" onclick="disconnect();">斷開連接</button>
</div>
<div id="conversationDiv">
<label>請輸入您的姓名</label><input type="text" id="name"/>
<button id="sendName" onclick="sendName();">發送</button>
<p id="response"></p>
</div>
</div>
</body>
<script type="text/javascript">
var stompClient = null;
function setConnected(connected) {
document.getElementById('connect').disabled = connected;
document.getElementById('disconnect').disabled = !connected;
document.getElementById('conversationDiv').style.visibility = connected ? 'visible' : 'hidden';
$("#response").html();
}
function connect() {
var socket = new SockJS('/endpointBroadcast'); //連接SockJS的endpoint名稱爲"endpointWisely"
stompClient = Stomp.over(socket);//使用STMOP子協議的WebSocket客戶端
stompClient.connect({}, function (frame) {//連接WebSocket服務端
setConnected(true);
console.log('Connected:' + frame);
//通過stompClient.subscribe訂閱/topic/getResponse 目標(destination)發送的消息,這個是在控制器的@SentTo中定義的
stompClient.subscribe('/topic/getResponse', function (response) {
showResponse(JSON.parse(response.body).responseMessage);
});
});
}
function disconnect() {
if (stompClient != null) {
stompClient.disconnect();
}
setConnected(false);
console.log("Disconnected");
}
function sendName() {
var name = $("#name").val();
//通過stompClient.send向/welcome 目標(destination)發送消息,這個是在控制器的@MessageMapping中定義的
stompClient.send("/welcome", {}, JSON.stringify({'name': name}));
}
function showResponse(message) {
var response = $("#response");
response.html(message);
}
</script>
</html>
四、測試
連接測試
測試多個窗口
