WebSocket Java: основы, примеры и руководство

Websocket в Java - это протокол связи между клиентом и сервером, который обеспечивает более эффективную двустороннюю связь. Он позволяет устанавливать постоянное соединение между клиентом и сервером, что позволяет отправлять сообщения в реальном времени без необходимости повторного установления соединения.

Для работы с Websocket в Java можно использовать стандартную библиотеку Java EE (Enterprise Edition) или библиотеку Spring. Далее приведены примеры использования WebSocket с использованием Java EE и библиотеки Spring.

Пример использования WebSocket с использованием Java EE:

1. Создайте класс, который будет являться WebSocket endpoint'ом, реализующим интерфейс javax.websocket.Endpoint.

java
import javax.websocket.Endpoint;
import javax.websocket.EndpointConfig;
import javax.websocket.MessageHandler;
import javax.websocket.Session;
import javax.websocket.CloseReason;
public class MyEndpoint extends Endpoint {
  @Override
  public void onOpen(Session session, EndpointConfig config) {
    session.addMessageHandler(new MessageHandler.Whole() {
      @Override
      public void onMessage(String message) {
        // Обработка принятого сообщения
        session.getBasicRemote().sendText("Ответ на ваше сообщение: " + message);
      }
    });
  }
  @Override
  public void onClose(Session session, CloseReason closeReason) {
    // Обработка закрытия соединения
  }
}

2. Создайте класс, который будет являться WebSocket помощником, реализующим интерфейс javax.websocket.server.ServerApplicationConfig.

java
import javax.websocket.server.ServerApplicationConfig;
import javax.websocket.server.ServerEndpointConfig;
public class MyApplicationConfig implements ServerApplicationConfig {
  @Override
  public Set getEndpointConfigs(Set> scanned) {
    return new HashSet<>();
  }
  @Override
  public Set> getAnnotatedEndpointClasses(Set> scanned) {
    Set> endpoints = new HashSet<>();
    endpoints.add(MyEndpoint.class);
    return endpoints;
  }
}

3. Создайте файл конфигурации под названием javax.websocket.server.ServerApplicationConfig, указав полный путь к классу MyApplicationConfig, в папке resources/META-INF/services/.

org.glassfish.tyrus.spi.ServerApplicationConfig=your.package.name.MyApplicationConfig

4. Запустите сервер с помощью контейнера Java EE, который поддерживает WebSocket.

Пример использования WebSocket с использованием Spring:

1. Добавьте зависимость на библиотеку Spring WebSocket в файле pom.xml.

xml

  org.springframework.boot
  spring-boot-starter-websocket

2. Создайте класс конфигурации WebSocket.

java
@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
  @Override
  public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
    registry.addHandler(myHandler(), "/myHandler").setAllowedOrigins("*");
  }
  @Bean
  public WebSocketHandler myHandler() {
    return new MyHandler();
  }
}

3. Создайте класс, реализующий интерфейс org.springframework.web.socket.WebSocketHandler.

java
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;
public class MyHandler extends TextWebSocketHandler {
  @Override
  public void handleMessage(WebSocketSession session, WebSocketMessage message) throws Exception {
    // Обработка принятого сообщения
    session.sendMessage(new TextMessage("Ответ на ваше сообщение: " + message.getPayload()));
  }
}

4. Запустите сервер с помощью Spring Boot.

Это лишь некоторые примеры использования Websocket в Java. Здесь показаны базовые шаги для настройки WebSocket в Java EE и с использованием Spring. Однако, существуют и другие библиотеки, такие как Atmosphere или Vert.x, которые также предлагают поддержку Websocket в Java.