一区二区三区日韩精品-日韩经典一区二区三区-五月激情综合丁香婷婷-欧美精品中文字幕专区

分享

springboot集成websocket的四種方式小結(jié)

 宇宙之窗 2022-10-18 發(fā)布于福建
+
目錄

1. 原生注解

pom.xml

1
2
3
4
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-websocket</artifactId>
</dependency>

WebSocketConfig

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
/*
 * *
 *  * blog.coder4j.cn
 *  * Copyright (C) 2016-2019 All Rights Reserved.
 *
 */
package cn.coder4j.study.example.websocket.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;
/**
 * @author buhao
 * @version WebSocketConfig.java, v 0.1 2019-10-18 15:45 buhao
 */
@Configuration
@EnableWebSocket
public class WebSocketConfig {
    @Bean
    public ServerEndpointExporter serverEndpoint() {
        return new ServerEndpointExporter();
    }
}

說(shuō)明:
這個(gè)配置類很簡(jiǎn)單,通過(guò)這個(gè)配置 spring boot 才能去掃描后面的關(guān)于 websocket 的注解

WsServerEndpoint#

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
/*
 * *
 *  * blog.coder4j.cn
 *  * Copyright (C) 2016-2019 All Rights Reserved.
 *
 */
package cn.coder4j.study.example.websocket.ws;
import org.springframework.stereotype.Component;
import javax.websocket.OnClose;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
/**
 * @author buhao
 * @version WsServerEndpoint.java, v 0.1 2019-10-18 16:06 buhao
 */
@ServerEndpoint("/myWs")
@Component
public class WsServerEndpoint {
    /**
     * 連接成功
     *
     * @param session
     */
    @OnOpen
    public void onOpen(Session session) {
        System.out.println("連接成功");
    }
    /**
     * 連接關(guān)閉
     *
     * @param session
     */
    @OnClose
    public void onClose(Session session) {
        System.out.println("連接關(guān)閉");
    }
    /**
     * 接收到消息
     *
     * @param text
     */
    @OnMessage
    public String onMsg(String text) throws IOException {
        return "servet 發(fā)送:" + text;
    }
}

說(shuō)明
這里有幾個(gè)注解需要注意一下,首先是他們的包都在 **javax.websocket **下。并不是 spring 提供的,而 jdk 自帶的,下面是他們的具體作用。

  1. @ServerEndpoint
  2. 通過(guò)這個(gè) spring boot 就可以知道你暴露出去的 ws 應(yīng)用的路徑,有點(diǎn)類似我們經(jīng)常用的@RequestMapping。比如你的啟動(dòng)端口是8080,而這個(gè)注解的值是ws,那我們就可以通過(guò) ws://127.0.0.1:8080/ws 來(lái)連接你的應(yīng)用
  3. @OnOpen
  4. 當(dāng) websocket 建立連接成功后會(huì)觸發(fā)這個(gè)注解修飾的方法,注意它有一個(gè) Session 參數(shù)
  5. @OnClose
  6. 當(dāng) websocket 建立的連接斷開后會(huì)觸發(fā)這個(gè)注解修飾的方法,注意它有一個(gè) Session 參數(shù)
  7. @OnMessage
  8. 當(dāng)客戶端發(fā)送消息到服務(wù)端時(shí),會(huì)觸發(fā)這個(gè)注解修改的方法,它有一個(gè) String 入?yún)⒈砻骺蛻舳藗魅氲闹?/li>
  9. @OnError
  10. 當(dāng) websocket 建立連接時(shí)出現(xiàn)異常會(huì)觸發(fā)這個(gè)注解修飾的方法,注意它有一個(gè) Session 參數(shù)

另外一點(diǎn)就是服務(wù)端如何發(fā)送消息給客戶端,服務(wù)端發(fā)送消息必須通過(guò)上面說(shuō)的 Session 類,通常是在@OnOpen 方法中,當(dāng)連接成功后把 session 存入 Map 的 value,key 是與 session 對(duì)應(yīng)的用戶標(biāo)識(shí),當(dāng)要發(fā)送的時(shí)候通過(guò) key 獲得 session 再發(fā)送,這里可以通過(guò) session.getBasicRemote_().sendText(_) 來(lái)對(duì)客戶端發(fā)送消息。

2. Spring封裝

pom.xml

1
2
3
4
<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-websocket</artifactId>
</dependency>

HttpAuthHandler

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
/*
 * *
 *  * blog.coder4j.cn
 *  * Copyright (C) 2016-2019 All Rights Reserved.
 *
 */
package cn.coder4j.study.example.websocket.handler;
import cn.coder4j.study.example.websocket.config.WsSessionManager;
import org.springframework.stereotype.Component;
import org.springframework.web.socket.CloseStatus;
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;
import java.time.LocalDateTime;
/**
 * @author buhao
 * @version MyWSHandler.java, v 0.1 2019-10-17 17:10 buhao
 */
@Component
public class HttpAuthHandler extends TextWebSocketHandler {
    /**
     * socket 建立成功事件
     *
     * @param session
     * @throws Exception
     */
    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        Object token = session.getAttributes().get("token");
        if (token != null) {
            // 用戶連接成功,放入在線用戶緩存
            WsSessionManager.add(token.toString(), session);
        } else {
            throw new RuntimeException("用戶登錄已經(jīng)失效!");
        }
    }
    /**
     * 接收消息事件
     *
     * @param session
     * @param message
     * @throws Exception
     */
    @Override
    protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        // 獲得客戶端傳來(lái)的消息
        String payload = message.getPayload();
        Object token = session.getAttributes().get("token");
        System.out.println("server 接收到 " + token + " 發(fā)送的 " + payload);
        session.sendMessage(new TextMessage("server 發(fā)送給 " + token + " 消息 " + payload + " " + LocalDateTime.now().toString()));
    }
    /**
     * socket 斷開連接時(shí)
     *
     * @param session
     * @param status
     * @throws Exception
     */
    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
        Object token = session.getAttributes().get("token");
        if (token != null) {
            // 用戶退出,移除緩存
            WsSessionManager.remove(token.toString());
        }
    }
}

說(shuō)明
通過(guò)繼承 TextWebSocketHandler 類并覆蓋相應(yīng)方法,可以對(duì) websocket 的事件進(jìn)行處理,這里可以同原生注解的那幾個(gè)注解連起來(lái)看

  1. afterConnectionEstablished 方法是在 socket 連接成功后被觸發(fā),同原生注解里的 @OnOpen 功能
  2. **afterConnectionClosed  **方法是在 socket 連接關(guān)閉后被觸發(fā),同原生注解里的 @OnClose 功能
  3. **handleTextMessage **方法是在客戶端發(fā)送信息時(shí)觸發(fā),同原生注解里的 @OnMessage 功能

WsSessionManager

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
/*
 * *
 *  * blog.coder4j.cn
 *  * Copyright (C) 2016-2019 All Rights Reserved.
 *
 */
package cn.coder4j.study.example.websocket.config;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.socket.WebSocketSession;
import java.io.IOException;
import java.util.concurrent.ConcurrentHashMap;
/**
 * @author buhao
 * @version WsSessionManager.java, v 0.1 2019-10-22 10:24 buhao
 */
@Slf4j
public class WsSessionManager {
    /**
     * 保存連接 session 的地方
     */
    private static ConcurrentHashMap<String, WebSocketSession> SESSION_POOL = new ConcurrentHashMap<>();
    /**
     * 添加 session
     *
     * @param key
     */
    public static void add(String key, WebSocketSession session) {
        // 添加 session
        SESSION_POOL.put(key, session);
    }
    /**
     * 刪除 session,會(huì)返回刪除的 session
     *
     * @param key
     * @return
     */
    public static WebSocketSession remove(String key) {
        // 刪除 session
        return SESSION_POOL.remove(key);
    }
    /**
     * 刪除并同步關(guān)閉連接
     *
     * @param key
     */
    public static void removeAndClose(String key) {
        WebSocketSession session = remove(key);
        if (session != null) {
            try {
                // 關(guān)閉連接
                session.close();
            } catch (IOException e) {
                // todo: 關(guān)閉出現(xiàn)異常處理
                e.printStackTrace();
            }
        }
    }
    /**
     * 獲得 session
     *
     * @param key
     * @return
     */
    public static WebSocketSession get(String key) {
        // 獲得 session
        return SESSION_POOL.get(key);
    }
}

說(shuō)明
這里簡(jiǎn)單通過(guò) **ConcurrentHashMap **來(lái)實(shí)現(xiàn)了一個(gè) session 池,用來(lái)保存已經(jīng)登錄的 web socket 的  session。前文提過(guò),服務(wù)端發(fā)送消息給客戶端必須要通過(guò)這個(gè) session。

MyInterceptor

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
/*
 * *
 *  * blog.coder4j.cn
 *  * Copyright (C) 2016-2019 All Rights Reserved.
 *
 */
package cn.coder4j.study.example.websocket.interceptor;
import cn.hutool.core.util.StrUtil;
import cn.hutool.http.HttpUtil;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.stereotype.Component;
import org.springframework.web.socket.WebSocketHandler;
import org.springframework.web.socket.server.HandshakeInterceptor;
import java.util.HashMap;
import java.util.Map;
/**
 * @author buhao
 * @version MyInterceptor.java, v 0.1 2019-10-17 19:21 buhao
 */
@Component
public class MyInterceptor implements HandshakeInterceptor {
    /**
     * 握手前
     *
     * @param request
     * @param response
     * @param wsHandler
     * @param attributes
     * @return
     * @throws Exception
     */
    @Override
    public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map<String, Object> attributes) throws Exception {
        System.out.println("握手開始");
        // 獲得請(qǐng)求參數(shù)
        HashMap<String, String> paramMap = HttpUtil.decodeParamMap(request.getURI().getQuery(), "utf-8");
        String uid = paramMap.get("token");
        if (StrUtil.isNotBlank(uid)) {
            // 放入屬性域
            attributes.put("token", uid);
            System.out.println("用戶 token " + uid + " 握手成功!");
            return true;
        }
        System.out.println("用戶登錄已失效");
        return false;
    }
    /**
     * 握手后
     *
     * @param request
     * @param response
     * @param wsHandler
     * @param exception
     */
    @Override
    public void afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Exception exception) {
        System.out.println("握手完成");
    }
}

說(shuō)明
通過(guò)實(shí)現(xiàn) HandshakeInterceptor 接口來(lái)定義握手?jǐn)r截器,注意這里與上面 Handler 的事件是不同的,這里是建立握手時(shí)的事件,分為握手前與握手后,而  Handler 的事件是在握手成功后的基礎(chǔ)上建立 socket 的連接。所以在如果把認(rèn)證放在這個(gè)步驟相對(duì)來(lái)說(shuō)最節(jié)省服務(wù)器資源。它主要有兩個(gè)方法 beforeHandshake 與 **afterHandshake **,顧名思義一個(gè)在握手前觸發(fā),一個(gè)在握手后觸發(fā)。

WebSocketConfig

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
/*
 * *
 *  * blog.coder4j.cn
 *  * Copyright (C) 2016-2019 All Rights Reserved.
 *
 */
package cn.coder4j.study.example.websocket.config;
import cn.coder4j.study.example.websocket.handler.HttpAuthHandler;
import cn.coder4j.study.example.websocket.interceptor.MyInterceptor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;
/**
 * @author buhao
 * @version WebSocketConfig.java, v 0.1 2019-10-17 15:43 buhao
 */
@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
    @Autowired
    private HttpAuthHandler httpAuthHandler;
    @Autowired
    private MyInterceptor myInterceptor;
    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry
                .addHandler(httpAuthHandler, "myWS")
                .addInterceptors(myInterceptor)
                .setAllowedOrigins("*");
    }
}

說(shuō)明
通過(guò)實(shí)現(xiàn) WebSocketConfigurer 類并覆蓋相應(yīng)的方法進(jìn)行 websocket 的配置。我們主要覆蓋 registerWebSocketHandlers 這個(gè)方法。通過(guò)向 WebSocketHandlerRegistry 設(shè)置不同參數(shù)來(lái)進(jìn)行配置。其中 **addHandler 方法添加我們上面的寫的 ws 的  handler 處理類,第二個(gè)參數(shù)是你暴露出的 ws 路徑。addInterceptors 添加我們寫的握手過(guò)濾器。setAllowedOrigins("*") **這個(gè)是關(guān)閉跨域校驗(yàn),方便本地調(diào)試,線上推薦打開。

3. TIO

pom.xml

1
2
3
4
5
<dependency>
     <groupId>org.t-io</groupId>
     <artifactId>tio-websocket-spring-boot-starter</artifactId>
     <version>3.5.5.v20191010-RELEASE</version>
</dependency>

application.xml

1
2
3
4
tio:
  websocket:
    server:
      port: 8989

說(shuō)明
這里只配置了 ws 的啟動(dòng)端口,還有很多配置,可以通過(guò)結(jié)尾給的鏈接去尋找

MyHandler

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
/*
 * *
 *  * blog.coder4j.cn
 *  * Copyright (C) 2016-2019 All Rights Reserved.
 *
 */
package cn.coder4j.study.example.websocket.handler;
import org.springframework.stereotype.Component;
import org.tio.core.ChannelContext;
import org.tio.http.common.HttpRequest;
import org.tio.http.common.HttpResponse;
import org.tio.websocket.common.WsRequest;
import org.tio.websocket.server.handler.IWsMsgHandler;
/**
 * @author buhao
 * @version MyHandler.java, v 0.1 2019-10-21 14:39 buhao
 */
@Component
public class MyHandler implements IWsMsgHandler {
    /**
     * 握手
     *
     * @param httpRequest
     * @param httpResponse
     * @param channelContext
     * @return
     * @throws Exception
     */
    @Override
    public HttpResponse handshake(HttpRequest httpRequest, HttpResponse httpResponse, ChannelContext channelContext) throws Exception {
        return httpResponse;
    }
    /**
     * 握手成功
     *
     * @param httpRequest
     * @param httpResponse
     * @param channelContext
     * @throws Exception
     */
    @Override
    public void onAfterHandshaked(HttpRequest httpRequest, HttpResponse httpResponse, ChannelContext channelContext) throws Exception {
        System.out.println("握手成功");
    }
    /**
     * 接收二進(jìn)制文件
     *
     * @param wsRequest
     * @param bytes
     * @param channelContext
     * @return
     * @throws Exception
     */
    @Override
    public Object onBytes(WsRequest wsRequest, byte[] bytes, ChannelContext channelContext) throws Exception {
        return null;
    }
    /**
     * 斷開連接
     *
     * @param wsRequest
     * @param bytes
     * @param channelContext
     * @return
     * @throws Exception
     */
    @Override
    public Object onClose(WsRequest wsRequest, byte[] bytes, ChannelContext channelContext) throws Exception {
        System.out.println("關(guān)閉連接");
        return null;
    }
    /**
     * 接收消息
     *
     * @param wsRequest
     * @param s
     * @param channelContext
     * @return
     * @throws Exception
     */
    @Override
    public Object onText(WsRequest wsRequest, String s, ChannelContext channelContext) throws Exception {
        System.out.println("接收文本消息:" + s);
        return "success";
    }
}

說(shuō)明
這個(gè)同上個(gè)例子中的 handler 很像,也是通過(guò)實(shí)現(xiàn)接口覆蓋方法來(lái)進(jìn)行事件處理,實(shí)現(xiàn)的接口是IWsMsgHandler,它的方法功能如下

自媒體培訓(xùn)

  1. handshake
  2. 在握手的時(shí)候觸發(fā)
  3. onAfterHandshaked
  4. 在握手成功后觸發(fā)
  5. onBytes
  6. 客戶端發(fā)送二進(jìn)制消息觸發(fā)
  7. onClose
  8. 客戶端關(guān)閉連接時(shí)觸發(fā)
  9. onText
  10. 客戶端發(fā)送文本消息觸發(fā)

StudyWebsocketExampleApplication

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
/*
 * *
 *  * blog.coder4j.cn
 *  * Copyright (C) 2016-2019 All Rights Reserved.
 *
 */
package cn.coder4j.study.example.websocket;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.tio.websocket.starter.EnableTioWebSocketServer;
@SpringBootApplication
@EnableTioWebSocketServer
public class StudyWebsocketExampleApplication {
    public static void main(String[] args) {
        SpringApplication.run(StudyWebsocketExampleApplication.class, args);
    }
}

說(shuō)明
這個(gè)類的名稱不重要,它其實(shí)是你的 spring boot 啟動(dòng)類,只要記得加上@EnableTioWebSocketServer注解就可以了

STOMP

pom.xml

1
2
3
4
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-websocket</artifactId>
</dependency>

WebSocketConfig

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
/*
 * *
 *  * blog.coder4j.cn
 *  * Copyright (C) 2016-2019 All Rights Reserved.
 *
 */
package cn.coder4j.study.example.websocket.config;
import org.springframework.context.annotation.Configuration;
import org.springframework.messaging.simp.config.MessageBrokerRegistry;
import org.springframework.web.socket.config.annotation.EnableWebSocketMessageBroker;
import org.springframework.web.socket.config.annotation.StompEndpointRegistry;
import org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurer;
/**
 * @author buhao
 * @version WebSocketConfig.java, v 0.1 2019-10-21 16:32 buhao
 */
@Configuration
@EnableWebSocketMessageBroker
public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {
    @Override
    public void registerStompEndpoints(StompEndpointRegistry registry) {
        // 配置客戶端嘗試連接地址
        registry.addEndpoint("/ws").setAllowedOrigins("*").withSockJS();
    }
    @Override
    public void configureMessageBroker(MessageBrokerRegistry registry) {
        // 設(shè)置廣播節(jié)點(diǎn)
        registry.enableSimpleBroker("/topic", "/user");
        // 客戶端向服務(wù)端發(fā)送消息需有/app 前綴
        registry.setApplicationDestinationPrefixes("/app");
        // 指定用戶發(fā)送(一對(duì)一)的前綴 /user/
        registry.setUserDestinationPrefix("/user/");
    }
}

說(shuō)明

  • 通過(guò)實(shí)現(xiàn) WebSocketMessageBrokerConfigurer 接口和加上@EnableWebSocketMessageBroker來(lái)進(jìn)行 stomp 的配置與注解掃描。
  • 其中覆蓋 registerStompEndpoints 方法來(lái)設(shè)置暴露的 stomp 的路徑,其它一些跨域、客戶端之類的設(shè)置。
  • 覆蓋 **configureMessageBroker **方法來(lái)進(jìn)行節(jié)點(diǎn)的配置。
  • 其中 **enableSimpleBroker **配置的廣播節(jié)點(diǎn),也就是服務(wù)端發(fā)送消息,客戶端訂閱就能接收消息的節(jié)點(diǎn)。
  • 覆蓋**setApplicationDestinationPrefixes **方法,設(shè)置客戶端向服務(wù)端發(fā)送消息的節(jié)點(diǎn)。
  • 覆蓋 setUserDestinationPrefix 方法,設(shè)置一對(duì)一通信的節(jié)點(diǎn)。

WSController

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
/*
 * *
 *  * blog.coder4j.cn
 *  * Copyright (C) 2016-2019 All Rights Reserved.
 *
 */
package cn.coder4j.study.example.websocket.controller;
import cn.coder4j.study.example.websocket.model.RequestMessage;
import cn.coder4j.study.example.websocket.model.ResponseMessage;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.messaging.handler.annotation.MessageMapping;
import org.springframework.messaging.handler.annotation.SendTo;
import org.springframework.messaging.simp.SimpMessagingTemplate;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;
/**
 * @author buhao
 * @version WSController.java, v 0.1 2019-10-21 17:22 buhao
 */
@Controller
public class WSController {
    @Autowired
    private SimpMessagingTemplate simpMessagingTemplate;
    @MessageMapping("/hello")
    @SendTo("/topic/hello")
    public ResponseMessage hello(RequestMessage requestMessage) {
        System.out.println("接收消息:" + requestMessage);
        return new ResponseMessage("服務(wù)端接收到你發(fā)的:" + requestMessage);
    }
    @GetMapping("/sendMsgByUser")
    public @ResponseBody
    Object sendMsgByUser(String token, String msg) {
        simpMessagingTemplate.convertAndSendToUser(token, "/msg", msg);
        return "success";
    }
    @GetMapping("/sendMsgByAll")
    public @ResponseBody
    Object sendMsgByAll(String msg) {
        simpMessagingTemplate.convertAndSend("/topic", msg);
        return "success";
    }
    @GetMapping("/test")
    public String test() {
        return "test-stomp.html";
    }
}

說(shuō)明

  • 通過(guò) @MessageMapping 來(lái)暴露節(jié)點(diǎn)路徑,有點(diǎn)類似 @RequestMapping。注意這里雖然寫的是 hello ,但是我們客戶端調(diào)用的真正地址是** /app/hello。 因?yàn)槲覀冊(cè)谏厦娴?config 里配置了registry.setApplicationDestinationPrefixes("/app")**。
  • @SendTo這個(gè)注解會(huì)把返回值的內(nèi)容發(fā)送給訂閱了 /topic/hello 的客戶端,與之類似的還有一個(gè)@SendToUser 只不過(guò)他是發(fā)送給用戶端一對(duì)一通信的。這兩個(gè)注解一般是應(yīng)答時(shí)響應(yīng)的,如果服務(wù)端主動(dòng)發(fā)送消息可以通過(guò) simpMessagingTemplate類的convertAndSend方法。注意 simpMessagingTemplate.convertAndSendToUser(token, "/msg", msg) ,聯(lián)系到我們上文配置的 registry.setUserDestinationPrefix("/user/"),這里客戶端訂閱的是/user/{token}/msg,千萬(wàn)不要搞錯(cuò)。

Session 共享的問(wèn)題

上面反復(fù)提到一個(gè)問(wèn)題就是,服務(wù)端如果要主動(dòng)發(fā)送消息給客戶端一定要用到 session。而大家都知道的是 session 這個(gè)東西是不跨 jvm 的。如果有多臺(tái)服務(wù)器,在 http 請(qǐng)求的情況下,我們可以通過(guò)把 session 放入緩存中間件中來(lái)共享解決這個(gè)問(wèn)題,通過(guò) spring session 幾條配置就解決了。但是 web socket  不可以。他的 session 是不能序列化的,當(dāng)然這樣設(shè)計(jì)的目的不是為了為難你,而是出于對(duì) http 與 web socket 請(qǐng)求的差異導(dǎo)致的。

目前網(wǎng)上找到的最簡(jiǎn)單方案就是通過(guò) redis 訂閱廣播的形式,主要代碼跟第二種方式差不多,你要在本地放個(gè) map 保存請(qǐng)求的 session。也就是說(shuō)每臺(tái)服務(wù)器都會(huì)保存與他連接的 session 于本地。然后發(fā)消息的地方要修改,并不是現(xiàn)在這樣直接發(fā)送,而通過(guò) redis 的訂閱機(jī)制。服務(wù)器要發(fā)消息的時(shí)候,你通過(guò) redis 廣播這條消息,所有訂閱的服務(wù)端都會(huì)收到這個(gè)消息,然后本地嘗試發(fā)送。最后肯定只有有這個(gè)對(duì)應(yīng)用戶 session 的那臺(tái)才能發(fā)送出去。

如何選擇

如果你在使用 tio,那推薦使用 tio 的集成。因?yàn)樗呀?jīng)實(shí)現(xiàn)了很多功能,包括上面說(shuō)的通過(guò) redis 的 session 共享,只要加幾個(gè)配置就可以了。但是 tio 是半開源,文檔是需要收費(fèi)的。如果沒有使用,那就忘了他。
如果你的業(yè)務(wù)要求比較靈活多變,推薦使用前兩種,更推薦第二種 Spring 封裝的形式。
如果只是簡(jiǎn)單的服務(wù)器雙向通信,推薦 stomp 的形式,因?yàn)樗菀滓?guī)范使用。

其它

websocket 在線驗(yàn)證
寫完服務(wù)端代碼后想調(diào)試,但是不會(huì)前端代碼怎么辦,點(diǎn)這里,這是一個(gè)在線的 websocket 客戶端,功能完全夠我們調(diào)試了。

stomp 驗(yàn)證
這個(gè)沒找到在線版的,但是網(wǎng)上有很多 demo 可以下載到本地進(jìn)行調(diào)試,也可以通過(guò)后文的連接找到。

另外由于篇幅有限,并不能放上所有代碼,但是測(cè)試代碼全都上傳 gitlab,保證可以正常運(yùn)行,可以在這里 找到

參考鏈接

SpringBoot 系統(tǒng) - 集成 WebSocket 實(shí)時(shí)通信

WebSocket 的故事(二)—— Spring 中如何利用 STOMP 快速構(gòu)建 WebSocket 廣播式消息模式

SpringBoot集成WebSocket【基于純H5】進(jìn)行點(diǎn)對(duì)點(diǎn)[一對(duì)一]和廣播[一對(duì)多]實(shí)時(shí)推送

Spring Framework 參考文檔(WebSocket STOMP)

Spring Boot中使用WebSocket總結(jié)(一):幾種實(shí)現(xiàn)方式詳解

Spring Boot 系列 - WebSocket 簡(jiǎn)單使用

tio-websocket-spring-boot-starter

到此這篇關(guān)于springboot集成websocket的四種方式小結(jié)的文章就介紹到這了,更多相關(guān)springboot集成websocket內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!

    本站是提供個(gè)人知識(shí)管理的網(wǎng)絡(luò)存儲(chǔ)空間,所有內(nèi)容均由用戶發(fā)布,不代表本站觀點(diǎn)。請(qǐng)注意甄別內(nèi)容中的聯(lián)系方式、誘導(dǎo)購(gòu)買等信息,謹(jǐn)防詐騙。如發(fā)現(xiàn)有害或侵權(quán)內(nèi)容,請(qǐng)點(diǎn)擊一鍵舉報(bào)。
    轉(zhuǎn)藏 分享 獻(xiàn)花(0

    0條評(píng)論

    發(fā)表

    請(qǐng)遵守用戶 評(píng)論公約

    類似文章 更多

    久久大香蕉一区二区三区| 欧洲亚洲精品自拍偷拍| 成人免费高清在线一区二区| 视频一区日韩经典中文字幕| 日韩高清一区二区三区四区| 国产一级一片内射视频在线| 亚洲av日韩一区二区三区四区 | 99国产精品国产精品九九| 国产av熟女一区二区三区四区| 成人亚洲国产精品一区不卡| 欧美野外在线刺激在线观看| 有坂深雪中文字幕亚洲中文| 日本免费熟女一区二区三区| 成人你懂的在线免费视频| 亚洲黑人精品一区二区欧美| 亚洲最新一区二区三区| 欧美国产日本免费不卡| 在线欧洲免费无线码二区免费| 国产欧美亚洲精品自拍| 加勒比日本欧美在线观看| 日韩精品视频免费观看| 日韩蜜桃一区二区三区| 国产麻豆一线二线三线| 中文文精品字幕一区二区| 国产欧美日本在线播放| 99久只有精品免费视频播放| 亚洲一区二区精品久久av| 99久久精品久久免费| 国产精品久久男人的天堂| 激情爱爱一区二区三区| 在线观看视频日韩精品| 五月天综合网五月天综合网| 黄色污污在线免费观看| 亚洲成人久久精品国产| 日韩人妻精品免费一区二区三区| 亚洲国产精品无遮挡羞羞| 欧美午夜一级艳片免费看| 欧美一区二区不卡专区| 91爽人人爽人人插人人爽| 久久精品国产熟女精品| 日本理论片午夜在线观看|