Spring Websocket使用指南

Spring Websocket使用指南

1. 首先需要一个类去实现WebSocketConfigurer, 并且指定ws的地址

/**
* Represents the web socket configuration.
*/
@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
   private TextWebSocketHandler webSocketHandler;

   /**
    * Constructs the web socket config.
    *
    * @param webSocketHandler Web socket handler.
    */
   @Autowired
   WebSocketConfig(TextWebSocketHandler webSocketHandler) {
       this.webSocketHandler = webSocketHandler;
   }

   /**
    * Registers the web socket handlers.
    *
    * @param registry Web socket handler registry.
    */
   @Override
   public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
       registry.addHandler(webSocketHandler, "/ws").setAllowedOrigins("*");
   }
}

2. 接下来需要定义一个WS请求的handler

/**
* Represents websocket handler.
*/
@Slf4j
@Service
public class WebSocketHandler extends TextWebSocketHandler {
   private WebSocketService webSocketService;

   /**
    * Constructs an web socket handler.
    *
    * @param webSocketService Application websocket service.
    */
   @Autowired
   public WebSocketHandler(WebSocketService webSocketService) {
       this.webSocketService = webSocketService;
   }

   /**
    * Event handler for after connection established event.
    *
    * @param session Session.
    */
   @Override
   public void afterConnectionEstablished(WebSocketSession session) {
       log.info("sessionId {} established", session.getId());
       webSocketService.put(session.getId(), session);
   }

   /**
    * Event handler for text message event.
    *
    * @param session Session.
    * @param message Message.
    */
   @Override
   protected void handleTextMessage(WebSocketSession session, TextMessage message) {
       log.info("get message from sessionId {} with message {}", session.getId(), message);
       webSocketService.onMessage(session.getId(), message);
   }

   /**
    * Event handler for transport error event.
    *
    * @param session   Session.
    * @param exception Exception.
    */
   @Override
   public void handleTransportError(WebSocketSession session, Throwable exception) {
       webSocketService.remove(session.getId());
   }

   /**
    * Event handler for after connection closed event.
    *
    * @param session     Session.
    * @param closeStatus Close status.
    */
   @Override
   public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) {
       webSocketService.remove(session.getId());
   }

   /**
    * Configures whether supports partial messages.
    */
   @Override
   public boolean supportsPartialMessages() {
       return false;
   }


}

3. 具体实现handler中的对应策略

/**
* Websocket service.
*/
@Service
@Slf4j
public class WebSocketService {

   private final Map<String, WsPayloadSession> sessionMap = new HashMap<>();

   @Autowired
   public WebSocketService(RecgAtomService recgAtomService) {
       this.recgAtomService = recgAtomService;
   }

   public void put(String id, WebSocketSession webSocketSession) {
       WsPayloadSession wsPayloadSession = new WsPayloadSession();
       wsPayloadSession.setWebSocketSession(webSocketSession);
       sessionMap.put(id, wsPayloadSession);
       log.info("websocket connection {} open, now: {}", id, sessionMap.size());
   }

   public void remove(String sessionId) {
       if (sessionMap.containsKey(sessionId)) {
           try {
               sessionMap.get(sessionId).getConcurrentWebSocketSession().close();
               sessionMap.remove(sessionId);
               log.info("websocket connection {} closed, now: {}", sessionId, sessionMap.size());
           } catch (IOException e) {
               log.error("Failed to close session {}", sessionId);
           }
       }
   }

   void onMessage(String sessionId, TextMessage message) {
       if (sessionMap.containsKey(sessionId)) {
           try {
               WsRequestType wsRequestType = gson.fromJson(message.getPayload(), WsRequestType.class);
               if (null == wsRequestType) {
                   throw new JsonSyntaxException("Request type of null is not supported!");
               }
               WsPayloadSession wsPayloadSession = sessionMap.get(sessionId);
               // 这里可以在WsPayloadSession里加点自己的数据，如type, uuid之类的
               sendMessage(sessionId, gson.toJson(wsResponse));
           } catch (JsonSyntaxException e) {
               log.error("Unknown wsRequestType: {}", message.getPayload(), e);
           }
       } else {
           log.error("Websocket session {} is expired.", sessionId);
       }

   }

   public void sendMessage(String sessionId, String message) {
       TextMessage textMessage = new TextMessage(message);
       // your code
   }


   @Data
   private class WsPayloadSession {
       private WebSocketSession webSocketSession;
   }


}