Spring消息之WebSocket

時間  2019-11-19
標籤 spring 消息 websocket 欄目 Spring 简体版
原文   原文鏈接

1、WebSocket簡介

    WebSocket 的定義？WebSocket是HTML5下一種全雙工通訊協議。在創建鏈接後，WebSocket服務器端和客戶端都能主動的向對方發送和接收數據，就像Socket同樣。javascript

    WebSocket 的由來？衆所周知，HTTP協議有「無鏈接」、「不可靠」、「盡最大努力」的特色。WebSocket的出現能夠當作是HTTP協議爲了支持長鏈接所打的一個大補丁。首先，由 IETF 制定發佈了WebSocket 協議。後來，HTML5爲了在Web端支持WebSocket協議，由W3C 發佈了一整套WebSocket API。其次，WebSocket主要用於Web端，對於非Web部分的意義不大（畢竟直接使用TCP就行了）。所以，在廣義上，Websocket 也經常被人稱爲是HTML5 下的通訊協議。css

    HTTP 和 WebSocket 的區別？前端

一、HTTP 和 WebSocket 是兩種不一樣的協議，可是HTTP負責了創建WebSocket的鏈接。java

二、HTTP 請求以 http:// 或 https:// 開始，WebSocket 請求通常以ws:// 或 wss:// 開始。git

三、全部瀏覽器都支持 HTTP 協議，WebScoket 能夠會遇到不支持的瀏覽器（可經過SockJS解決）github

四、HTTP長鏈接中，每次數據交換除了真正的數據部分外，服務器和客戶端還要大量交換HTTP header，信息交換效率很低。Websocket協議經過第一個request創建了TCP鏈接以後，以後交換的數據都不須要發送 HTTP header就能交換數據。web

    能夠看看知乎上的這個回答，解釋的挺生動的：https://www.zhihu.com/question/20215561spring

2、使用Spring的低層級WebSocket API

    先來看看客戶端如何創建起WebSocket 的鏈接。首先，咱們使用 new WebSocket(url) 建立一個WebSocket 的實例對象；而後，使用這個實例對象創建WebSocket的事件處理功能，onopen、onmessage、onclose 和 onerror 事件，分別對應着 打開鏈接、接收消息、關閉鏈接 和 異常處理 事件。api

/*WebSocket*/
var url = 'ws://localhost:8080/marco2';
var sock = new WebSocket(url);


sock.onopen = function (ev) {
    console.log("正在創建鏈接...");
    sayMarco();
};

sock.onmessage = function (ev) {
    console.log("接收並處理消息：" + ev.data);
    if (count == 10) {
        sock.close();
    }
    setTimeout(
        function () {
            sayMarco();
            count++;
        }, 2000);
};

sock.onclose = function (ev) {
    console.log("鏈接關閉...");
};

sock.error = function (ev) {
    console.log("鏈接異常");
};

function sayMarco() {
    console.log('Sending Marco !');
    sock.send("Marco!")
}
WebSocket客戶端

    接下來看看服務端這邊如何創建起WebSocket的服務：瀏覽器

一、pom 依賴

    <!--WebSocket-->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-websocket</artifactId>
      <version>4.3.13.RELEASE</version>
    </dependency>
    <!--輔助包-->
    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-core</artifactId>
      <version>2.8.10</version>
    </dependency>
    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-databind</artifactId>
      <version>2.8.10</version>
    </dependency>
    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-annotations</artifactId>
      <version>2.8.10</version>
    </dependency>
View Code

二、WebSocket 服務

    有兩種方案能夠創建起WebSocket服務，一種是基於Spring 的 spring-websocket，一種是基於 java 的 websocket-api。

  • spring-websocket

    WebSocketHandler 接口定義了服務端處理WebSocket消息要作的一系列事情。相比直接實現WebSocketHandler，更爲簡單的方法是擴展AbstractWebSocketHandler，這是WebSocketHandler的一個抽象實現。固然根據處理消息的類型，還能夠選擇繼承TextWebSocketHandler（文本類消息）、BinaryWebSocketHandler（二進制消息）等...

public class MarcoHandler_2 extends AbstractWebSocketHandler {

    private static final Logger LOGGER = LoggerFactory.getLogger(MarcoHandler_2.class);

    @Override
    public void afterConnectionEstablished(WebSocketSession session) {
        LOGGER.info("WebSocket 鏈接創建......");
    }

    @Override
    protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {

        LOGGER.info("接收到消息：" + message.getPayload());
        Thread.sleep(2000);
        //發送文本消息
        session.sendMessage(new TextMessage("Polo!"));

    }

    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus){
        LOGGER.info("WebSocket 鏈接關閉......");
    }

}
View Code
  • websocket-api

    websocket-api 提供了一種基於註解、更爲簡單明瞭的方式處理WebSocket消息。美中不足的是它須要依賴 javax.websocket-api.jar。

① pom依賴

    <dependency>
      <groupId>javax.websocket</groupId>
      <artifactId>javax.websocket-api</artifactId>
      <version>1.1</version>
      <scope>provided</scope>
    </dependency>
View Code

② WebSocket服務

/**
 * Created by XiuYin.Cui on 2018/5/2.
 *
 * 基於註解方式的WebSocket 控制器
 */

@ServerEndpoint("/ws")
public class WsController {

    private static final Logger LOGGER = LoggerFactory.getLogger(WsController.class);

    @OnOpen
    public void onOpen(){
        LOGGER.info("鏈接創建");
    }

    @OnClose
    public void onClose(){
        LOGGER.info("鏈接關閉");
    }

    @OnMessage
    public void onMessage(String message, Session session){
        try {
            LOGGER.info("接收到消息：" + message);
            Thread.sleep(2000);
            session.getBasicRemote().sendText("polo"); //發送消息
        } catch (IOException e) {
            e.printStackTrace();
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }

    @OnError
    public void onError(Session session, Throwable throwable){
        throw new IllegalArgumentException(throwable);
    }


}
View Code

三、創建映射

    如今，已經有了消息處理器類，咱們必需要對其進行配置，這樣Spring才能將消息轉發給它。在Spring的Java配置中，這須要在一個配置類上使用@EnableWebSocket，並實現WebSocketConfigurer接口。

    像全部HTTP請求同樣，咱們須要將WebSocket服務暴露成一個供客戶端訪問的url 地址。依舊有兩種方式，配置類方式 和 XML方式：

3.一、配置類方式
@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {

    /**
     *
     * @param registry 該對象能夠調用addHandler()來註冊信息處理器。
     */
    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
          registry.addHandler(marcoHandler_2(),"/marco2")
                  .addInterceptors(webSocketHandshakeInterceptor()) //聲明攔截器
                  .setAllowedOrigins("*"); //聲明容許訪問的主機列表
    }


    @Bean
    public MarcoHandler_2 marcoHandler_2(){
        return new MarcoHandler_2();
    }

    @Bean
    public WebSocketHandshakeInterceptor webSocketHandshakeInterceptor(){
        return new WebSocketHandshakeInterceptor();
    }
}
View Code
3.二、xml 方式
    <websocket:handlers>
        <websocket:mapping handler="marcoHandler_1" path="/marco1"/>
    </websocket:handlers>
View Code

3、使用SockJS支持WebSocket 

    既然已經有了WebSocket API 爲何還要有SockJS呢？

一、WebSocket 是一個較新的協議規範，在Web瀏覽器和應用服務器上可能沒有獲得一致的支持。

二、防火牆代理一般會限制全部除HTTP之外的流量。它們可能不支持或者尚未配置容許進行WebSocket 通訊。

    SockJS 又是什麼呢？

    SockJS是WebSocket技術的一種模擬，在表面上，它儘量對應WebSocket API，可是在底層它很是智能。SockJS會優先選用WebSocket，可是若是WebSocket不可用的話，它將會從以下的方案中挑選最優的可行方案：

  • XHR流。
  • XDR流。
  • iFrame事件源。
  • iFrame HTML文件。
  • XHR輪詢。
  • XDR輪詢。
  • iFrame XHR輪詢。
  • JSONP輪詢。

    接下來讓咱們看看SockJS 的使用和WebSocket 有什麼差別？

  • 客戶端
一、SockJS客戶端庫

要在客戶端使用SockJS，須要確保加載了SockJS客戶端庫。

            <script type="text/javascript" src="http://cdn.bootcss.com/sockjs-client/1.1.1/sockjs.js"></script>
二、修改URL，構建SockJS實例

SockJS所處理的URL是「http://」或「https://」模式，而不是「ws://」和「wss://」。

            var url = 'http://localhost:8080/marcoSockJS';
            var sock = new SockJS(url);
  • 服務端

    服務端這邊只要在創建映射的時候加上SockJS的支持便可：

一、配置類方式
@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {

    /**
     *
     * @param registry 該對象能夠調用addHandler()來註冊信息處理器。
     */
    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
          //聲明啓用SockJS鏈接，若是前端還用 new WebSocket(url); 會報：Error during WebSocket handshake: Unexpected response code: 200
          registry.addHandler(marcoHandler_2(), "/marcoSockJS")
                  .setAllowedOrigins("*") ////聲明容許訪問的主機列表
                  .withSockJS();
    }


    @Bean
    public MarcoHandler_2 marcoHandler_2(){
        return new MarcoHandler_2();
    }
    
}
View Code
二、XML方式
    <websocket:handlers>
        <websocket:mapping handler="marcoHandler_1" path="/marco1"/>
        <websocket:sockjs/> <!--聲明啓用SockJS功能-->
    </websocket:handlers>
View Code

 

 

效果展現：

演示源碼下載連接：https://github.com/JMCuixy/SpringWebSocket/tree/developer

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程