Spring Boot系列22 Spring Websocket實現websocket叢集方案的Demo

hryou0922發表於2018-07-30
Spring BootWeb

概述

上一篇文章Spring Boot系列21 Spring Websocket實現websocket叢集方案討論裡詳細介紹了WebSocket叢集的三種方案，並得出結論第三個方案是最好的，本文我們實現第三個方案。

第三個方案如下圖

這裡寫圖片描述

在方案一的基礎進行如下修改，新的架構圖流程如下：

  1. 服務A增加WS模組，當websocket連線過來時，將此使用者的連線資訊（主要是websocket sesionId值）儲存redis中
  2. 訊息生產者傳送訊息到的交換機，這些服務不直接推送服務A/B
  3. 增加新的模組dispatch，此模組接收推送過來的資訊，並從redis中讀取訊息接收使用者對應的websocket sesionId值，然後根據上面的規則計算出使用者對應的路由鍵，然後將訊息傳送到使用者訂閱的佇列上
  4. 前端接收訊息

詳細實現的程式碼

工程名稱：mvc 本文在Spring Boot系列20 Spring Websocket實現向指定的使用者傳送訊息的基礎進行修改。

在pom.xml中引入redis,rabbitmq相關的jar

<!--  webscoekt 叢集 需要 引入支援RabbitMQ, redis-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-amqp</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
複製程式碼

rabbitmq, redis的配置

application-wscluster.properties

# websocket叢集需要配置RabbitMQ
spring.rabbitmq.host:192.168.21.3
spring.rabbitmq.virtual-host: /icc-local
spring.rabbitmq.username: icc-dev
spring.rabbitmq.password: icc-dev

# 配置redis
spring.redis.database=0
spring.redis.host=192.168.21.4
# spring.redis.password=
spring.redis.port=7001
spring.redis.pool.max-idle=8
spring.redis.pool.min-idle=0  
spring.redis.pool.max-active=8  
spring.redis.pool.max-wait=-1
複製程式碼

IRedisSessionService及實現

介面IRedisSessionService定義了對redis的操作 IRedisSessionService實現類將使用者名稱稱和websocket sessionId的關係儲存到redis，提供新增、刪除、查詢 IRedisSessionService

public interface IRedisSessionService {
    void add(String name, String wsSessionId);
    boolean del(String name);
    String get(String name);
}
複製程式碼

SimulationRedisSessionServiceImpl 將使用者名稱稱和websocket sessionId的關係儲存到redis，提供新增、刪除、查詢

@Component
public class SimulationRedisSessionServiceImpl implements IRedisSessionService {

    @Autowired
    private RedisTemplate<String, String> template;

    // key = 登入使用者名稱稱， value=websocket的sessionId
    private ConcurrentHashMap<String,String> redisHashMap = new ConcurrentHashMap<>(32);

    /**
     * 在快取中儲存使用者和websocket sessionid的資訊
     * @param name
     * @param wsSessionId
     */
    public void add(String name, String wsSessionId){
        BoundValueOperations<String,String> boundValueOperations = template.boundValueOps(name);
        boundValueOperations.set(wsSessionId,24 * 3600, TimeUnit.SECONDS);
    }

    /**
     * 從快取中刪除使用者的資訊
     * @param name
     */
    public boolean del(String name){
        return template.execute(new RedisCallback<Boolean>() {

            @Override
            public Boolean doInRedis(RedisConnection connection)
                    throws DataAccessException {
                byte[] rawKey = template.getStringSerializer().serialize(name);
                return connection.del(rawKey) > 0;
            }
        }, true);
    }

    /**
     * 根據使用者id獲取使用者對應的sessionId值
     * @param name
     * @return
     */
    public String get(String name){
        BoundValueOperations<String,String> boundValueOperations = template.boundValueOps(name);
        return boundValueOperations.get();
    }
}
複製程式碼

AuthWebSocketHandlerDecoratorFactory

裝飾WebSocketHandlerDecorator物件，在連線建立時，儲存websocket的session id，其中key為帳號名稱；在連線斷開時，從快取中刪除使用者的sesionId值。此websocket sessionId值用於建立訊息的路由鍵。

@Component
public class AuthWebSocketHandlerDecoratorFactory implements WebSocketHandlerDecoratorFactory {
    private static final Logger log = LoggerFactory.getLogger(AuthWebSocketHandlerDecoratorFactory.class);

    @Autowired
    private IRedisSessionService redisSessionService;

    @Override
    public WebSocketHandler decorate(WebSocketHandler handler) {
        return new WebSocketHandlerDecorator(handler) {
            @Override
            public void afterConnectionEstablished(final WebSocketSession session) throws Exception {
                // 客戶端與伺服器端建立連線後，此處記錄誰上線了
                Principal principal = session.getPrincipal();
                if(principal != null){
                    String username = principal.getName();
                    log.info("websocket online: " + username + " session " + session.getId());
                    redisSessionService.add(username, session.getId());
                }
                super.afterConnectionEstablished(session);
            }

            @Override
            public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
                // 客戶端與伺服器端斷開連線後，此處記錄誰下線了
                Principal principal = session.getPrincipal();
                if(principal != null){
                    String username = session.getPrincipal().getName();
                    log.info("websocket offline: " + username);
                    redisSessionService.del(username);
                }
                super.afterConnectionClosed(session, closeStatus);
            }
        };
    }
}
複製程式碼

WebSocketRabbitMQMessageBrokerConfigurer

在Spring Boot系列20 Spring Websocket實現向指定的使用者傳送訊息的基礎上增加如下功能，將myWebSocketHandlerDecoratorFactory配置到websocket

@Configuration
// 此註解開使用STOMP協議來傳輸基於訊息代理的訊息，此時可以在@Controller類中使用@MessageMapping
@EnableWebSocketMessageBroker
public class WebSocketRabbitMQMessageBrokerConfigurer extends AbstractWebSocketMessageBrokerConfigurer {

    @Autowired
    private MyPrincipalHandshakeHandler myDefaultHandshakeHandler;
    @Autowired
    private AuthHandshakeInterceptor sessionAuthHandshakeInterceptor;

    @Autowired
    private AuthWebSocketHandlerDecoratorFactory myWebSocketHandlerDecoratorFactory;

    @Override
    public void registerStompEndpoints(StompEndpointRegistry registry) {
        ….
    }

    @Override
    public void configureMessageBroker(MessageBrokerRegistry registry) {
          …       
    }

    /**
     * 這時實際spring weboscket叢集的新增的配置，用於獲取建立websocket時獲取對應的sessionid值
     * @param registration
     */
    @Override
    public void configureWebSocketTransport(WebSocketTransportRegistration registration) {
        registration.addDecoratorFactory(myWebSocketHandlerDecoratorFactory);
        super.configureWebSocketTransport(registration);
    }
}

複製程式碼

TestMQCtl：

在上文Spring Boot系列20 Spring Websocket實現向指定的使用者傳送訊息的基礎上，對此類進行修改

  • sendMq2User()方法根據使用者的帳號和websocket sessionId根據["web訂閱佇列名稱+'-user'+websocket sessionId"]組合路由鍵。然後通過AmqpTemplate 例項向amq.topic交換機傳送訊息，路由鍵為["web訂閱佇列名稱+'-user'+websocket sessionId"]。方法中websocket sessionId是從根據帳號名稱從redis中獲取 其它的方法，這裡不一一列出
@Controller
@RequestMapping(value = "/ws")
public class TestMQCtl {
    private  static final Logger log = LoggerFactory.getLogger(TestMQCtl.class);

    @Autowired
    private AmqpTemplate amqpTemplate;
    @Autowired
    private IRedisSessionService redisSessionService;

     /**
     * 向執行使用者傳送請求
     * @param msg
     * @param name
     * @return
     */
    @RequestMapping(value = "send2user")
    @ResponseBody
    public int sendMq2User(String msg, String name){
        // 根據使用者名稱稱獲取使用者對應的session id值
        String wsSessionId = redisSessionService.get(name);
        RequestMessage demoMQ = new RequestMessage();
        demoMQ.setName(msg);

        // 生成路由鍵值，生成規則如下: websocket訂閱的目的地 + "-user" + websocket的sessionId值。生成值類似:
        String routingKey = getTopicRoutingKey("demo", wsSessionId);
        // 向amq.topi交換機傳送訊息，路由鍵為routingKey
        log.info("向使用者[{}]sessionId=[{}]，傳送訊息[{}]，路由鍵[{}]", name, wsSessionId, wsSessionId, routingKey);
        amqpTemplate.convertAndSend("amq.topic", routingKey,  JSON.toJSONString(demoMQ));
        return 0;
    }

    /**
     * 獲取Topic的生成的路由鍵
     *
     * @param actualDestination
     * @param sessionId
     * @return
     */
    private String getTopicRoutingKey(String actualDestination, String sessionId){
        return actualDestination + "-user" + sessionId;
    }
   ….
}
複製程式碼

測試

以不同埠啟動兩個服務 啟動服務類：WebSocketClusterApplication 以“--spring.profiles.active=wscluster --server.port=8081”引數啟動服務A 以“--spring.profiles.active=wscluster --server.port=8082”引數啟動服務B

登入模擬帳號:xiaoming登入服務A，xiaoming2登入服務B 使用xiaoming登入服務A，並登入websocket http://127.0.0.1:8081/ws/login 使用xiaoming登入，並提交

這裡寫圖片描述
點選連線，如果連線變灰色，則登入websocket成功
這裡寫圖片描述

開啟另一個瀏覽器，使用xiaoming2登入服務B，並登入websocket http://127.0.0.1:8082/ws/login 使用xiaoming2登入並提交，最後登入websocket

登入服務A模擬傳送頁面 登入http://127.0.0.1:8081/ws/send，傳送訊息

  1. 向帳號xiaoming傳送訊息xiaoming-receive，只能被連線服務A的服務websocket收到 §
  2. 向帳號xiaoming2傳送訊息xiaoming2-receive，只能被連線服務B的服務websocket收到

此時兩個頁面收到資訊：

這裡寫圖片描述

xiaoming帳號只收到xiaoming-receive xiaoming2帳號只收到xiaoming2-receive

登入服務B模擬傳送頁面 登入http://127.0.0.1:8082/ws/send，傳送訊息，和http://127.0.0.1:8081/ws/send 一樣傳送相同訊息，結果是一樣

結論 無論使用者登入的服務A，還是服務B，我們通過以上的程式碼，我們都可以傳送訊息到指定的使用者，所以我們已經實現websocket叢集

程式碼

所有的詳細程式碼見github程式碼，請儘量使用tag v0.24，不要使用master，因為master一直在變，不能保證文章中程式碼和github上的程式碼一直相同

相關文章