springboot项目下WebSocket+RabbitMq的搭建
springboot 分布式 项目下WebSocket+RabbitMq的搭建
本文仅仅是个人工作上用到的知识点的备忘笔记
前提：支持RabbitMq运行的环境
在搭建rabbitmq之前，得先搭建他的运行环境，传送阵法biubiubiu：
https://blog.csdn.net/weixin_43738469/article/details/106195105
必不可少的导包，在pom文件中引入下面的包
<!-- rabbitMq 的依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-amqp</artifactId>
</dependency>
<!-- websocket 的依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
1.websocket配置：新建WebSocketConfig类，用来支持websocket
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;
/**
* 开启WebSocket支持
*/
@Configuration
public class WebSocketConfig {
@Bean
public ServerEndpointExporter serverEndpointExporter() {
return new ServerEndpointExporter();
}
}
2.rabbitmq配置：新建FanoutRabbitConfig类，用来定义队列并绑定交换机
import org.springframework.amqp.core.Binding;
import org.springframework.amqp.core.BindingBuilder;
import org.springframework.amqp.core.FanoutExchange;
import org.springframework.amqp.core.Queue;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class FanoutRabbitConfig {
/**
* 定义队列A
* @return
*/
@Bean
public Queue aMessage() {
return new Queue("q_fanout_A");
}
/**
* 定义队列B
* @return
*/
@Bean
public Queue bMessage() {
return new Queue("q_fanout_B");
}
/**
* 定义交换机
* @return
*/
@Bean
FanoutExchange fanoutExchange() {
return new FanoutExchange("myfanoutExchange");
}
/**
* 将队列A和交换机进行绑定
* @return
*/
@Bean
Binding bindingExchangeA() {
return BindingBuilder.bind(aMessage()).to(fanoutExchange());
}
/**
* 将队列B和交换机进行绑定
* @return
*/
@Bean
Binding bindingExchangeB() {
return BindingBuilder.bind(bMessage()).to(fanoutExchange());
}
}
3.新建WebSocketServer类结合RabbitMq，实现实时消息推送
这个方法可以获取到mq队列中的消息，我这里是将要接收消息的用户id在我的后台方法中拼接成一个字符串，然后放进mq队列中去，这个方法中获取到mq队列中的信息之后，将他进行处理成集合然后与websocket中的登陆用户进行对比
package com.medicine.management_side.controller;
import org.apache.commons.collections.map.HashedMap;
import org.springframework.amqp.rabbit.annotation.RabbitHandler;
import org.springframework.amqp.rabbit.annotation.RabbitListener;
import org.springframework.stereotype.Component;
import org.springframework.util.CollectionUtils;
import javax.websocket.*;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
/**
* @ServerEndpoint 注解是一个类层次的注解，它的功能主要是将目前的类定义成一个websocket服务器端,
* 注解的值将被用于监听用户连接的终端访问URL地址,客户端可以通过这个URL来连接到WebSocket服务器端
*
* @RabbitListene注解是用来接收某个队列中的消息，如果该队列有消息，就给@RabbitHandle注解下的方法
*/
@RabbitListener(queues = "q_fanout_A")
@ServerEndpoint(value = "/websocket")
@Component
public class WebSocketServer {
//静态变量，用来记录当前在线连接数。应该把它设计成线程安全的。
private static int onlineCount = 0;
//concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。若要实现服务端与单一客户端通信的话，可以使用Map来存放，其中Key可以为用户标识
//private static CopyOnWriteArraySet webSocketSet = new CopyOnWriteArraySet();
private static ConcurrentHashMap<String, WebSocketServer> webSocketSet = new ConcurrentHashMap<>();
/**
* concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。
*/
private static Map<String, Session> sessionPools = new HashMap<>();
//与某个客户端的连接会话，需要通过它来给客户端发送数据
private Session session;
/**
* 连接建立成功调用的方法
*
* @param session 可选的参数。session为与某个客户端的连接会话，需要通过它来给客户端发送数据
*/
@OnOpen
public void onOpen(Session session) {
//这个地方我是从session中获取登陆id，然后作为map中的key，session作为value
//方法我觉得怪怪的，还得循环遍历，哪位大佬要是有什么好的意见给我指点指点
this.session = session;
List<String> uid = session.getRequestParameterMap().get("uid");
if (!CollectionUtils.isEmpty(uid)) {
for (String id : uid) {
webSocketSet.put(id, this); //加入set中
addOnlineCount(); //在线数加1
}
}
System.out.println("有新连接加入！当前在线人数为" + getOnlineCount());
}
/**
* 连接关闭调用的方法
*/
@OnClose
public void onClose(Session session) {
List<String> uid = session.getRequestParameterMap().get("uid");
if (!CollectionUtils.isEmpty(uid)) {
for (String id : uid) {
webSocketSet.remove(id); //从set中删除
subOnlineCount(); //在线数减1
System.out.println("有一连接关闭！当前在线人数为" + getOnlineCount());
}
}
}
/**
* 收到客户端消息后调用的方法
* @param message 客户端发送过来的消息
* @param session 可选的参数
*/
@OnMessage
public void onMessage(String message, Session session) {
Map<String, String> userIdMap = new HashedMap();
System.out.println("来自客户端的消息:" + message);
try {
//这个地方的admin是写死的，我的需求是消息推送，如果用户阅读了消息，我这里直接在前端调用这个方法传admin进来，然后就可以实时更新前端数据了
if ("admin".equals(message)) {//阅读类型的
for (String key : webSocketSet.keySet()) {
webSocketSet.get(key).sendMessage(message);
}
} else {
String[] messageAry = message.split(",");
for (String id : messageAry) {
userIdMap.put(id, id);
}
//群发消息
for (String key : webSocketSet.keySet()) {
if (userIdMap.get(key) != null) {
webSocketSet.get(key).sendMessage(message);
}
}
}
} catch (IOException e) {
e.printStackTrace();
}
}
/**
* 发生错误时调用
*
* @param session
* @param error
*/
@OnError
public void onError(Session session, Throwable error) {
System.out.println("发生错误");
error.printStackTrace();
}
/**
* 这个方法与上面几个方法不一样。没有用注解，是根据自己需要添加的方法。
*
* @param message
* @throws IOException
*/
public void sendMessage(String message) throws IOException {
this.session.getAsyncRemote().sendText(message);
}
/**
* 查询连接人数的方法
* @return
*/
public static synchronized int getOnlineCount() {
return onlineCount;
}
/**
* 连接人数+1的方法
* @return
*/
public static synchronized void addOnlineCount() {
WebSocketServer.onlineCount++;
}
/**
* 连接人数-1的方法
* @return
*/
public static synchronized void subOnlineCount() {
WebSocketServer.onlineCount--;
}
/**
* 这个方法没用到，但是也先留着，说不定哪天就用到了
* 发送信息给指定ID用户，如果用户不在线则返回不在线信息给自己
*
* @param message
* @param sendUserId
* @throws IOException
*/
public void sendtoUser(String message, List<String> sendUserId) throws IOException {
for (String userId : sendUserId) {
if (webSocketSet.get(userId) != null) {
webSocketSet.get(userId).sendMessage(message);
}
}
}
/**
* rabbit订阅队列中的消息(发送消息)
*
* @param message
*/
@RabbitHandler
public void process(String message) {
onMessage(message, session);
}
}
4.定义MsgSenderFanout类，往mq交换机上发送消息
import org.springframework.amqp.core.AmqpTemplate;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
@Component
public class MsgSenderFanout {
@Autowired
private AmqpTemplate rabbitTemplate;
/**
* 在自己的方法中调用这个类下的这个方法，根据自己不同的需求
* 接收消息，并将消息传到mq交换机上，绑定了该交换机的队列的消费者都可收到该消息
* @param message
*/
public void send(String message) {
System.out.println("Sender : " + message);
rabbitTemplate.convertAndSend("myfanoutExchange","", message);
}
}
5.html页面
这个页面是针对websocket的页面，我用来测试用的，我自己的页面是用的layui，就不放出来了
如果想测试可以写一个测试类来调用第4步的send方法，传参为6，应该就会在页面上显示了
页面上还有一个心跳检测有待补全，后期会更新
<!DOCTYPE html>
<html>
<head>
<title>Java后端WebSocket的Tomcat实现</title>
<link rel="stylesheet" href="../../../static/layui2/css/layui.css" media="all"/>
<link rel="stylesheet" href="../../../static/css/font_eolqem241z66flxr.css" media="all"/>
<link rel="stylesheet" href="../../../static/css/user.css" media="all"/>
</head>
<body>
Welcome<br/><input id="text" type="text"/>
<button onclick="send()">发送消息</button>
<hr/>
<button onclick="closeWebSocket()">关闭WebSocket连接</button>
<hr/>
<div id="message"></div>
</body>
<script type="text/javascript" src="../../../static/js/jquery.js"></script>
<script type="text/javascript" src="../../../static/layui2/layui.js"></script>
<script type="text/javascript" src="../../../static/js/queryUtils.js"></script>
<script type="text/javascript">
var websocket = null;
//判断当前浏览器是否支持WebSocket
if ('WebSocket' in window) {
//这个地方特别坑，建立连接的地址在网上众说纷纭
//我个人实现的方法是
//ws:如果你是http请求就写ws；如果你是https请求得改成wss
//localhost:8080：项目启动地址(本地),如果登陆页面是：http://localhost:8080/login,就用localhsot:8080
//websocket:这个写上WebSocketServer类上@ServerEndpoint注解后的value值
//uid:这个是传到后台去的登陆id
websocket = new WebSocket("ws://localhost:8080/websocket?uid=6");
} else {
alert('当前浏览器 Not support websocket')
}
//连接发生错误的回调方法
websocket.onerror = function () {
setMessageInnerHTML("WebSocket连接发生错误");
};
//连接成功建立的回调方法
websocket.onopen = function () {
setMessageInnerHTML("WebSocket连接成功");
}
//接收到消息的回调方法
websocket.onmessage = function (res) {
setMessageInnerHTML(res.data);
}
//连接关闭的回调方法
websocket.onclose = function () {
setMessageInnerHTML("WebSocket连接关闭");
}
//监听窗口关闭事件，当窗口关闭时，主动去关闭websocket连接，防止连接还没断开就关闭窗口，server端会抛异常。
window.onbeforeunload = function () {
closeWebSocket();
}
//将消息显示在网页上
function setMessageInnerHTML(innerHTML) {
document.getElementById('message').innerHTML += innerHTML + '
';
}
//关闭WebSocket连接
function closeWebSocket() {
websocket.close();
}
//发送消息，这是websocket的实时消息
function send() {
var message = document.getElementById('text').value;
websocket.send(message);
}
</script>
</html>
写在最后：
作为一个新菜鸟，头一次接触这个知识点，用完之后记录一下。内容不足之处还望各位多多指教，感谢！
遇到的问题：
问题：生产环境是分布式的，所以RabbitMq我用的是订阅模式，一个交换机，两个队列，按道理来说，订阅模式下所有绑定同一个交换机下的队列都能收到该交换机的消息，但是在生产环境中发送消息的之后，竟然是轮询接收参数。
结果：今天在局域网上搭建了跟生产环境一样的环境，并把代码部署上去了，经过测试后发现没有任何问题，所以以上代码是正确的，问题应该是生产环境中RabbitMq的环境!