spring cloud基于rabbitmq发布订阅的websocket集群

大致结构为：

具体逻辑

springboot 使用websocket 多个节点组成集群，单节点实例本地保存socket的连接在本地内存中，然后使用rabbitmq发布订阅，每次需要推送消息时，先将消息发送的rabbitmq，然后服务实例订阅此消息，消费此消息时，判断本地是否持有被推送的连接及session，若存在则推送，否则不进行推送。

注意事项

1. 使用RabbitMQ发布订阅：使用RabbitMQ可以很好地解耦消息的生产和消费，并且支持广播模式，适合实现WebSocket的消息推送。通过在RabbitMQ上定义交换机和队列，发布者将消息发送到交换机，消费者订阅该交换机即可获取消息。
2. 需要考虑消息顺序问题：在 WebSocket 的推送过程中，消息的顺序非常重要，否则可能出现消息错乱或漏推的情况。为了保证消息的有序性，建议在 RabbitMQ 中使用 Direct 或 Topic 类型的交换机，并设置合适的 RoutingKey，以便控制消息的路由和分发。

代码实现

引入依赖

        <!--webSocket-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-websocket</artifactId>
        </dependency>
        <!--rabbitmq-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-amqp</artifactId>
        </dependency>

定义广播交换机

@Configuration
public class StockMessageConfig {

    /**
     * 站内信(websocket)交换机，发布订阅
     * @return
     */
    @Bean(NEWSLETTER_EXCHANGE)
    public FanoutExchange exchange() {
        return ExchangeBuilder.fanoutExchange(NEWSLETTER_EXCHANGE).build();
    }
} 

集成配置websocket

@EnableWebSocket
@Configuration
public class WebSocketConfig {
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
}

public class Constants {

    /**
     * 本地socket连接
     */
    public static ConcurrentHashMap<String,MsgWebSocketServer> webSocketMap = new ConcurrentHashMap<>();

}

@Slf4j
@ServerEndpoint("/websocket/{userId}")
@Component
public class MsgWebSocketServer {

    public Session session;

    /**接收userId*/
    public String userId="";


    @OnOpen
    public void onOpen(Session session, @PathParam("userId") String userId) {
        this.session = session;
        this.userId=userId;
        // 如果存在与websocket的连接则更新此连接，否则将本地缓存中加入此连接
        if (webSocketMap.containsKey(userId)) {
            webSocketMap.remove(userId);
            webSocketMap.put(userId, this);
        } else {
            webSocketMap.put(userId, this);
        }
        log.info("用户连接:" + userId);
    }

    /**
     * 连接关闭调用的方法
     */
    @OnClose
    public void onClose(@PathParam("userId") String userId) {
        if(webSocketMap.containsKey(userId)){
            webSocketMap.remove(userId);
        }
        log.info("用户退出:" + userId);
    }

    /**
     * @param message
     * @param session
     */
    @OnMessage
    public void onMessage(String message, Session session) {
        log.info("用户消息:" + message);
    }

    /**
     * 发生异常调用方法
     */
    @OnError
    public void onError(Session session, Throwable error) {
        log.error("用户错误,原因:" + error.getMessage());
        error.printStackTrace();
    }
}

消息执行方法

public interface MessageExecutor {

    /**
     * 发送给用户消息
     * @param userId
     * @param msg
     * @return
     */
    boolean sendMessage(String userId,String msg);

}

websocket实现方法

@Component
public class NewsletterMessage implements MessageExecutor {

    @Override
    public boolean sendMessage(String userId, String msg) {
        if(webSocketMap.containsKey(userId)){ // 如果本地存在此用户的连接则向用户发送消息
            webSocketMap.get(userId).session.getAsyncRemote().sendText(msg);
        }
        return true;
    }

}

订阅消息进行消费推送逻辑

@Slf4j
@Component
public class WebSocketPushConsumer {

    @Resource
    private NewsletterMessage newsletterMessage;

    @RabbitListener(bindings = @QueueBinding(
            value = @Queue(),
            exchange = @Exchange(value = NEWSLETTER_EXCHANGE,type = ExchangeTypes.FANOUT)
    ))
    public void getData(Message message,String str,Channel channel) {
        try {
            // 将消息解析（json）
            log.info(str);
            UserMessage userMessage = JSONUtil.toBean(str, UserMessage.class);
            // 用户ID由mq中消息内容解析得到，同时解析出发送的具体内容
            boolean success = newsletterMessage.sendMessage(userMessage.getUserId(), userMessage.getMsgContent());
            // 如果本地处理成功则手动应答成功
            if (success) {
                channel.basicAck(message.getMessageProperties().getDeliveryTag(), false);
            } else {
                // TODO 若不成功则重新发送到交换机中处理？？or 放入一个死信队列 延期处理？
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

配置附录

 spring:
  rabbitmq:
    host: 192.168.110.108
    port: 5672
    username: guest
    password: guest
    virtual-host: youproject_vhost
    listener:
      type: simple
      simple:
        ## 手动应答模式
        acknowledge-mode: MANUAL
        concurrency: 1
        max-concurrency: 10
        default-requeue-rejected: false
    publisher-confirm-type: simple