SpringBoot+WebSocket实现在线聊天

最新推荐文章于 2024-07-25 09:00:53 发布

青莳吖

最新推荐文章于 2024-07-25 09:00:53 发布

阅读量371

点赞数

文章标签： websocket spring boot java

本文链接：https://blog.csdn.net/weixin_44758923/article/details/126992029

版权

首先引入依赖

<!--websocket依赖-->
<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-websocket</artifactId>
</dependency>

WebSocketConfig

import com.cn.ih.java.main.module.chathistory.service.ChatHistoryService;
import com.cn.ih.java.main.module.websocket.WebSocketServer;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.messaging.simp.config.MessageBrokerRegistry;
import org.springframework.web.socket.config.annotation.AbstractWebSocketMessageBrokerConfigurer;
import org.springframework.web.socket.config.annotation.EnableWebSocketMessageBroker;
import org.springframework.web.socket.config.annotation.StompEndpointRegistry;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;

@Configuration
@EnableWebSocketMessageBroker
public class WebSocketConfig extends AbstractWebSocketMessageBrokerConfigurer {
	@Override
	public void registerStompEndpoints(StompEndpointRegistry stompEndpointRegistry) {
		stompEndpointRegistry.addEndpoint("/endpointih").withSockJS();
	}

	@Override
	public void configureMessageBroker(MessageBrokerRegistry registry) {
		registry.enableSimpleBroker("/topic");
	}
	
	@Bean
    public ServerEndpointExporter serverEndpointExporter() {

        return new ServerEndpointExporter();
    }

	//如果需要在WebSocketServer里面调用注入的业务方法，则需要下面这行代码
//	@Autowired
//	public void setChatHistoryService(ChatHistoryService chatHistoryService){
//		WebSocketServer.chatHistoryService=chatHistoryService;
//	}
}

WebSocketServer


import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

import javax.websocket.EncodeException;
import javax.websocket.OnClose;
import javax.websocket.OnError;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;

import com.cn.ih.java.main.module.chathistory.service.ChatHistoryService;
import com.cn.ih.java.main.utils.JsonHelper;
import com.cn.ih.java.main.utils.TimeHelper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Lazy;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;

import com.alibaba.fastjson.JSON;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import lombok.extern.slf4j.Slf4j;

/**
 * 前端连接地址
 * ws://ip:port/msgservice/api/pushMessage/{1}
 */

@Component
@Slf4j
@Lazy
@ServerEndpoint(value = "/api/pushMessage/{userId}")
public class WebSocketServer {
	protected  final Logger logger = LoggerFactory.getLogger(this.getClass());
	 /**静态变量，用来记录当前在线连接数。应该把它设计成线程安全的。*/
    private static int onlineCount = 0;
    /**concurrent包的线程安全Set，用来存放每个客户端对应的WebSocket对象。*/
    private static ConcurrentHashMap<String,WebSocketServer> webSocketMap = new ConcurrentHashMap<>();
    /**与某个客户端的连接会话，需要通过它来给客户端发送数据*/
    private Session session;
    /**接收userId*/
    private String userId = "";

	//对应config最后一行代码
    //public static ChatHistoryService chatHistoryService;

    /**
     * 连接建立成功调用的方法
     */
    @OnOpen
    public void onOpen(Session session,@PathParam("userId") String userId) {
        this.session = session;
        this.userId=userId;
        if(webSocketMap.containsKey(userId)){
            webSocketMap.remove(userId);
            //加入set中
            webSocketMap.put(userId,this);
        }else{
            //加入set中
            webSocketMap.put(userId,this);
            //在线数加1
            addOnlineCount();
        }
        logger.info("用户连接:"+userId+",当前在线人数为:" + getOnlineCount());

        Map<String,Object> resMap=new HashMap<String,Object>();
        resMap.put("message", "连接成功");
        resMap.put("code", 200);
        resMap.put("timestamp", TimeHelper.getCurrentTime());
        try {
            String result = JsonHelper.parserMap(resMap);
            sendMessage(result);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    /**
     * 连接关闭调用的方法
     */
    @OnClose
    public void onClose() {
        if(webSocketMap.containsKey(userId)){
            webSocketMap.remove(userId);
            //从set中删除
            subOnlineCount();
        }
        logger.info("用户退出:"+userId+",当前在线人数为:" + getOnlineCount());
    }

    /**
     * 收到客户端消息后调用的方法
     * @param message
     * 客户端发送过来的消息
     **/
    @OnMessage
    public void onMessage(String message, Session session) {
        logger.info("用户id:"+userId+",报文:"+message);
        if(!StringUtils.isEmpty(message)){
            try {
                //解析发送的报文
                com.alibaba.fastjson.JSONObject jsonObject = JSON.parseObject(message);
                //追加发送人(防止串改)
                jsonObject.put("fromUserId",this.userId);//发送者
                String fromUserId= jsonObject.getString("fromUserId");//发送者
                String toUserId= jsonObject.getString("toUserId");//接收者
                //传送给对应toUserId用户的websocket
                if(!StringUtils.isEmpty(toUserId)&&webSocketMap.containsKey(toUserId)){
                    //业务
                    Map<String,Object> resMap=new HashMap<String,Object>();
                    resMap.put("message", "发送消息成功");
                    resMap.put("code", 200);
                    resMap.put("data", jsonObject);
                    resMap.put("timestamp", TimeHelper.getCurrentTime());
                    String result = JsonHelper.parserMap(resMap);
                    webSocketMap.get(this.userId).sendMessage(result);//给发送者返回发送成功
                    webSocketMap.get(toUserId).sendMessage(result);//给接收者推送消息内容
                }else{
                    //userId不存在
                    Map<String,Object> resMap=new HashMap<String,Object>();
                    resMap.put("message", "发送消息失败，请求的userId:"+toUserId+"不在该服务器上");
                    resMap.put("code", 400);
                    resMap.put("data", null);
                    resMap.put("timestamp", TimeHelper.getCurrentTime());
                    String result = JsonHelper.parserMap(resMap);
                    webSocketMap.get(this.userId).sendMessage(result);
                }
            }catch (Exception e){
                e.printStackTrace();
            }
        }
    }

    /**
     * @param session
     * @param error
     */
    @OnError
    public void onError(Session session, Throwable error) {

        logger.error("用户错误:"+this.userId+",原因:"+error.getMessage());
        error.printStackTrace();
    }

    /**
     * 实现服务器主动推送
     */
    public void sendMessage(String message) {
        try {
            logger.info("--------------websocket主动推送数据：{}",message);
            synchronized(session){
                this.session.getBasicRemote().sendText(message);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
    /**
     * @description: 实现服务器主动推送实体消息
     */
    public void sendObjectMessage(Object message) {
        try {
            this.session.getBasicRemote().sendObject(message);
        } catch (IOException | EncodeException e) {
            e.printStackTrace();
        }
    }

    /**
     *发送自定义消息
     **/
    public void sendInfo(String message, String userId) {
        try {
            logger.info("发送消息到:"+userId+"，报文:"+message);
		} catch (Exception e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
        if(!StringUtils.isEmpty(userId) && webSocketMap.containsKey(userId)){
            webSocketMap.get(userId).sendMessage(message);
        }else{
            logger.info("用户"+userId+",不在线！");
        }
    }

    /**
     *发送广播消息
     **/
    public void sendAllInfo(String message) {
        ConcurrentHashMap.KeySetView<String, WebSocketServer> keySet = webSocketMap.keySet();
        for (String key:keySet){
            try {
                logger.info("发送消息到:"+key+"，报文:"+message);
            } catch (Exception e) {
                // TODO Auto-generated catch block
                e.printStackTrace();
            }
            if(!StringUtils.isEmpty(key) && webSocketMap.containsKey(key)){
                webSocketMap.get(key).sendMessage(message);
            }else{
                logger.info("用户"+key+",不在线！");
            }
        }
    }

    /**
     * 获得此时的在线人数
     * @return
     */
    public static synchronized int getOnlineCount() {
        return onlineCount;
    }

    /**
     * 在线人数加1
     */
    public static synchronized void addOnlineCount() {
        WebSocketServer.onlineCount++;
    }

    /**
     * 在线人数减1
     */
    public static synchronized void subOnlineCount() {
        WebSocketServer.onlineCount--;
    }

}

Postaman测试通信

file-new
选择WebSocket Request

在这里插入图片描述

输入服务器ip和端口号即可，如果是本地测试ip为127.0.0.1
点击右侧的
connect即可，compose里面是你要发送的报文，格式和WebSocketServer里的报文解析保持一致

在这里插入图片描述

只需要再创建一个和接收者相同id的请求即可实现相互通信，同理，可以创建多个通信请求

在这里插入图片描述
服务器实现主动推送消息给客户端

@ApiOperation(value = "服务器主动推送消息")
    @RequestMapping(value="/sendMessage",method= RequestMethod.POST)
    public void sendMessage() {
        webSocketServer.sendInfo("aaa","10");//给指定用户推送消息
        webSocketServer.sendAllInfo("bbb");//给所有在线用户推送消息
    }