Реализация Spring Websocket Server и клиента

Конфигурация сборки

Зависимости Maven, необходимые для сервера, показаны ниже. Зависимость spring-boot-starter-websocket включает в себя библиотеки, необходимые для реализации WebSockets на стороне сервера.

Остальные зависимости org.webjars — это jQuery, Bootstrap и клиентские библиотеки для обмена сообщениями WebSocket и STOMP, необходимые клиенту чата HTML / Javascript. Эти зависимости Javascript не используются реализацией сервера Java WebSocket. Они необходимы для клиентского интерфейса, который полностью отделен от серверного приложения. Эти зависимости можно безопасно удалить из POM, если клиент HTML / Javascript не используется или упакован отдельно от приложения Spring.

 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> </dependency> <dependency> <groupId>org.webjars</groupId> <artifactId>webjars-locator</artifactId> </dependency> <dependency> <groupId>org.webjars</groupId> <artifactId>sockjs-client</artifactId> <version>1.0.2</version> </dependency> <dependency> <groupId>org.webjars</groupId> <artifactId>stomp-websocket</artifactId> <version>2.3.3</version> </dependency> <dependency> <groupId>org.webjars</groupId> <artifactId>bootstrap</artifactId> <version>3.3.7</version> </dependency> <dependency> <groupId>org.webjars</groupId> <artifactId>jquery</artifactId> <version>3.1.0</version> </dependency> 

Контроллер сообщений

В Spring MVC украшение класса с @Controller аннотации @Controller помечает класс как веб-контроллер . Это работает в сочетании с украшением @RequestMapping чтобы пометить метод как конечную точку HTTP. Аналогичным образом, аннотация @MessageMapping доступна в Spring Framework Messaging для регистрации метода в качестве прослушивателя сообщений.

Для нашего простого сервера чата ответ повторяет сообщение, полученное от клиента, и добавляет пару полей. В реальном приложении этот метод используется для реализации бизнес-логики. Вот реализация метода:

 @MessageMapping("/chat/{topic}") @SendTo("/topic/messages") public OutputMessage send( @DestinationVariable("topic") String topic, Message message) throws Exception { return new OutputMessage(message.getFrom(), message.getText(), topic); } 

Метод Message Controller принимает POJO (простой старый объект Java), в который десериализовано сообщение из JSON. Аннотация @DestinationVariable используется для захвата topic переменной шаблона из места назначения. Следующий класс Message определяется сервером для чтения сообщений от клиента.

 public class Message { private String from; private String text; // adding getters and setters here } 

Чтобы отправить ответы обратно клиенту, метод контроллера сообщений использует аннотацию @SendTo указывающую очередь на стороне клиента, в которую должен быть отправлен ответ. Значение, возвращаемое методом, сериализуется в JSON и отправляется в указанное место назначения. В нашем случае мы определяем ответное сообщение следующим образом. Обратите внимание, что text поля входного сообщения просто копируется в сообщение поля ответного message . В вашем приложении вы можете выполнить любую дополнительную обработку, а также включить дополнительные поля в классы запроса или ответа.

 public class OutputMessage { private String from; private String message; private String topic; private Date time = new Date(); // add getters and setters here } 

Настройка Spring

Приложение сконфигурировано для WebSockets с использованием класса @Configuration который расширяет AbstractWebSocketMessageBrokerConfigurer и предоставляет реализацию для следующих методов.

 @Override public void configureMessageBroker(MessageBrokerRegistry config) { config.enableSimpleBroker("/topic"); config.setApplicationDestinationPrefixes("/app"); } @Override public void registerStompEndpoints(StompEndpointRegistry registry) { registry.addEndpoint("/chat").setAllowedOrigins("*").withSockJS(); } 

Обратите внимание на следующие моменты:

• Префикс назначения приложения установлен на « /app ». Это означает, что отображения WebSocket имеют префикс « /app » для получения реального значения.
• Конечная точка « /chat » зарегистрирована для запуска рукопожатия по протоколу WebSocket.
• Метод setAllowedOrigins("*") используется для CORS-включения сервера, чтобы клиенты с несколькими источниками могли подключаться к серверу. Если ваши требования не нуждаются в клиентском соединении между источниками, вы можете удалить этот вызов.

Клиент веб-браузера

Образец веб-приложения, написанного на HTML и Javascript, включен в код — он реализует простой интерфейс для приложения чата. Снимок приложения показан ниже.

Подключение и регистрация Push Callback

Приложение использует библиотеку SocksJS для работы с соединением WebSocket и библиотеку stomp-websocket для поддержки STOMP. Приведенный ниже код подключения создает канал WebSocket и использует его для создания клиента STOMP. Как только WebSocket подключен, для обратных сообщений с сервера регистрируется обратный вызов. Сообщение десериализуется из JSON и отображается для пользователя.

 var wsocket = new SockJS('/chat'); var client = Stomp.over(wsocket); client.connect({}, function(frame) { client.subscribe('/topic/messages', function (message) { showMessage(JSON.parse(message.body)); }); }); 

Отправка сообщений на сервер

Клиент отправляет сообщения на сервер с помощью send() . Сообщение находится в формате JSON и в том же формате, который ожидается контроллером сообщений на стороне сервера.

 client.send("/app/chat/" + topic, {}, JSON.stringify({ from: $("#from").val(), text: $('#text').val(), })); 

 mvn clean package 

 java -Dserver.port=9090 -jar target/chat-server-0.1.0.jar 

 WebSocketClient simpleWebSocketClient = new StandardWebSocketClient(); List<Transport> transports = new ArrayList<>(1); transports.add(new WebSocketTransport(simpleWebSocketClient)); SockJsClient sockJsClient = new SockJsClient(transports); 

 WebSocketStompClient stompClient = new WebSocketStompClient(sockJsClient); 

 stompClient.setMessageConverter(new MappingJackson2MessageConverter()); 

 String url = "ws://localhost:9090/chat"; StompSessionHandler sessionHandler = new MyStompSessionHandler(); StompSession session = stompClient.connect(url, sessionHandler).get(); 

 session.subscribe(topic, new StompFrameHandler() { @Override public Type getPayloadType(StompHeaders headers) { return ServerMessage.class; } @Override public void handleFrame(StompHeaders headers,Object payload) { System.err.println(payload.toString()); } }); 

 ClientMessage msg = new ClientMessage(userId, line); session.send("/app/chat/java", msg);