一、相關依賴
<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
/**
* @program: test_demo
* @description: 配置websocket
* @author: HQ Zheng
* @create: 2019-12-04 10:05
*/
@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
//註冊名爲"endpointTest"的endpoint
registry.addEndpoint("/endpointTest").addInterceptors(
new HandshakeInterceptor() {
@Override
public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler webSocketHandler, Map<String, Object> map) throws Exception {
ServletServerHttpRequest req = (ServletServerHttpRequest) request;
//獲取token認證
String token = req.getServletRequest().getParameter("token");
if (!token.equals("123")) {
return false;
}
return true;
}
@Override
public void afterHandshake(ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse, WebSocketHandler webSocketHandler, Exception e) {
}
}
).setAllowedOrigins("*") //允許跨域
.withSockJS();//指定使用SockJS協議
}
@Override
public void configureMessageBroker(MessageBrokerRegistry registry) {//配置消息代理(Message Broker)
//點對點式應配置/queue和/topic消息代理
registry.enableSimpleBroker("/queue", "/topic");
registry.setUserDestinationPrefix("/queue");
}
}
2)、WebSocketController
/**
* @program: test_demo
* @description: webSocket 控制器
* @author: HQ Zheng
* @create: 2019-12-04 10:16
*/
@Controller
@EnableScheduling //定時任務支持
public class WebSocketController {
//通過simpMessagingTemplate向瀏覽器發送消息
@Autowired
private SimpMessagingTemplate simpMessagingTemplate;
/**
* 服務端推送消息到指定用戶得客戶端
* 例如以下將會推送到
* 因爲設置了setUserDestinationPrefix("/userTest")，因此推送到/userTest/fanqi/info
* 如果沒有設置setUserDestinationPrefix()，則默認前端爲user，將會推送到/user/fanqi/info
* 客戶端訂閱/userTest/fanqi/info將會收到服務端推送得消息
*
* @return
* @throws Exception
*/
@Scheduled(initialDelay = 7000, fixedRate = 2000)
public String serverTimeToUser() throws Exception {
DateFormat df = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
simpMessagingTemplate.convertAndSendToUser("test", "/info", df.format(new Date())+"哈哈哈");
return "serverTimeToUser";
}
}
三、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">
<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('/endpointTest?token=123'); //連接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('/queue/test/info', function (response) {
console.log(response);
showResponse(response.body);
//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>
四、測試
