предисловие
Как следует из названия, сегодняшнее введение — это интеграция WebSocket в SpringBoot для реализации широковещательных сообщений.
Что такое веб-сокет?
WebSocket обеспечивает функцию дуплексной асинхронной связи между браузером и сервером, то есть браузер может отправлять информацию на сервер, и наоборот.
WebSocket реализует возможность дуплексной асинхронной связи через сокет, но очень громоздко использовать WebSocket (или SockJS: имитация протокола WebSocket, добавление поддержки совместимости, которую современные браузеры не поддерживают с использованием WebSocket) программа разработки протокола очень громоздка, поэтому используйте ее Подпротокол STOMP.
Введение в протокол STOMP
Это расширенный протокол потокового текстового сообщения, простой текстовый протокол, разработанный для MOM (Message Oriented Middleware).
Он обеспечивает интероперабельный формат соединения, который позволяет клиентам STOMP взаимодействовать с произвольными брокерами сообщений STOMP (брокерами), подобно OpenWire (бинарный протокол).
Благодаря простому дизайну и легкой клиентской разработке он широко используется на многих языках и платформах. Одним из самых популярных брокеров сообщений STOMP является Apache ActiveMQ.
Протокол STOMP использует формат на основе (фрейма) для определения сообщений, аналогично запросу и ответу Http.
транслировать
Затем реализуйте демонстрацию трансляции сообщения. То есть, когда у сервера есть сообщение, он отправит его всем браузерам, подключенным к текущей конечной точке.
Готов к работе
- SpringBoot 2.1.3
- IDEA
- JDK8
Конфигурация зависимостей Pom
<dependencies>
<!-- thymeleaf 模板引擎 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<!-- web 启动类 -->
<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>
<!-- test 单元测试 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
Комментарии к коду очень подробные, сказать особо нечего.
Настроить веб-сокеты
Реализовать интерфейс WebSocketMessageBrokerConfigurer, зарегистрировать узел STOMP и настроить брокер широковещательных сообщений.
@Configuration
// @EnableWebSocketMessageBroker注解用于开启使用STOMP协议来传输基于代理（MessageBroker）的消息，这时候控制器（controller）
// 开始支持@MessageMapping,就像是使用@requestMapping一样。
@EnableWebSocketMessageBroker
public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {
@Override
public void registerStompEndpoints(StompEndpointRegistry registry) {
//注册一个 Stomp 的节点(endpoint),并指定使用 SockJS 协议。
registry.addEndpoint("/endpointNasus").withSockJS();
}
@Override
public void configureMessageBroker(MessageBrokerRegistry registry) {
// 广播式配置名为 /nasus 消息代理 , 这个消息代理必须和 controller 中的 @SendTo 配置的地址前缀一样或者全匹配
registry.enableSimpleBroker("/nasus");
}
}
класс сообщений
Клиент отправляет на сервер:
public class Client2ServerMessage {
private String name;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
}
Сервер отправляет клиенту:
public class Server2ClientMessage {
private String responseMessage;
public Server2ClientMessage(String responseMessage) {
this.responseMessage = responseMessage;
}
public String getResponseMessage() {
return responseMessage;
}
public void setResponseMessage(String responseMessage) {
this.responseMessage = responseMessage;
}
}
код демонстрационного контроллера
@RestController
public class WebSocketController {
@MessageMapping("/hello") // @MessageMapping 和 @RequestMapping 功能类似，浏览器向服务器发起消息，映射到该地址。
@SendTo("/nasus/getResponse") // 如果服务器接受到了消息，就会对订阅了 @SendTo 括号中的地址的浏览器发送消息。
public Server2ClientMessage say(Client2ServerMessage message) throws Exception {
Thread.sleep(3000);
return new Server2ClientMessage("Hello," + message.getName() + "!");
}
}
Внедрение сценариев STOMP
Поместите stomp.min.js (клиентский скрипт STOMP) и sockJS.min.js (клиентский скрипт sockJS) и Jquery в статический каталог папки ресурсов.
демонстрационная страница
<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8" />
<title>Spring Boot+WebSocket+广播式</title>
</head>
<body onload="disconnect()">
<noscript><h2 style="color: #ff0000">貌似你的浏览器不支持websocket</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>
<script th:src="@{sockjs.min.js}"></script>
<script th:src="@{stomp.min.js}"></script>
<script th:src="@{jquery.js}"></script>
<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() {
// 连接 SockJs 的 endpoint 名称为 "/endpointNasus"
var socket = new SockJS('/endpointNasus');
// 使用 STOMP 子协议的 WebSocket 客户端
stompClient = Stomp.over(socket);
stompClient.connect({}, function(frame) {
setConnected(true);
console.log('Connected: ' + frame);
// 通过 stompClient.subscribe 订阅 /nasus/getResponse 目标发送的信息，对应控制器的 SendTo 定义
stompClient.subscribe('/nasus/getResponse', function(respnose){
// 展示返回的信息，只要订阅了 /nasus/getResponse 目标，都可以接收到服务端返回的信息
showResponse(JSON.parse(respnose.body).responseMessage);
});
});
}
function disconnect() {
// 断开连接
if (stompClient != null) {
stompClient.disconnect();
}
setConnected(false);
console.log("Disconnected");
}
function sendName() {
// 向服务端发送消息
var name = $('#name').val();
// 通过 stompClient.send 向 /hello （服务端）发送信息，对应控制器 @MessageMapping 中的定义
stompClient.send("/hello", {}, JSON.stringify({ 'name': name }));
}
function showResponse(message) {
// 接收返回的消息
var response = $("#response");
response.html(message);
}
</script>
</body>
</html>
Контроллер страницы
Обратите внимание, что здесь используется аннотация @Controller для соответствия префиксу html и загрузки страницы.
@Controller
public class ViewController {
@GetMapping("/nasus")
public String getView(){
return "nasus";
}
}
Результаты теста
Откройте три окна, чтобы посетить http://localhost:8080/nasus, начальная страница выглядит так:
Все три страницы подключены, нажмите, чтобы подключиться к конечной точке подписки, как показано ниже:
На первой странице введите свое имя и нажмите «Отправить», как показано ниже:
Отправьте сообщение на первой странице и подождите секунды 3. В результате все 3 страницы получили информацию, возвращенную сервером, и трансляция прошла успешно.
Загрузка исходного кода:
https://github.com/turoDog/Demo/tree/master/springboot_websocket_demo
Если вы считаете, что это полезно для вас, пожалуйста, поставьте звезду и уходите, большое спасибо.
послесловие
Если эта статья поможет вам хоть немного, пожалуйста, помогите. Твоя внешность мотивирует меня продолжать писать.
Кроме того, я отправляю его после того, как обратил внимание1024Доступны бесплатные учебные материалы.
Подробнее см. в этой старой статье:Python, C++, Java, Linux, Go, внешний интерфейс, алгоритм обмена данными