SpringBoot整合Websocket实现即时聊天功能

最新推荐文章于 2024-08-17 01:21:11 发布
置顶 最新推荐文章于 2024-08-17 01:21:11 发布
阅读量1.6k 收藏
点赞数 1
分类专栏： websocket 文章标签： java spring boot websocket
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/wushuyu008/article/details/106261064
版权

小弟第一次写博客，空闲时间整理出来，望大家互相交流! 如有技术上的漏洞，请海涵！

近期，公司需要新增即时聊天的业务，于是用websocket 整合到Springboot完成业务的实现。

一、我们来简单的介绍下websocket的交互原理：
1.客户端先服务端发起websocket请求；
2.服务端接收到请求之后，把请求响应返回给客户端；
3.客户端与服务端只需要一次握手即可完成交互通道；
如图所示： Alt
二、webscoket支持的协议：基于TCP协议下，http协议和https协议；
http协议 springboot不需要做任何的配置
https协议则需要配置nignx代理，注意证书有效的问题 —在这不做详细说明
三、开始我们的实现java后端的实现
1.添加依赖

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

      <dependency>
          <groupId>org.springframework</groupId>
          <artifactId>spring-websocket</artifactId>
          <version>${spring.version}</version>
      </dependency>

      <dependency>
          <groupId>org.springframework</groupId>
          <artifactId>spring-messaging</artifactId>
          <version>${spring.version}</version>
      </dependency>
      <!-- WebSocket -->

	2.配置config

@ConditionalOnWebApplication
@Configuration
@EnableWebSocketMessageBroker
public class WebSocketConfig extends AbstractSessionWebSocketMessageBrokerConfigurer {
    @Bean
    public ServerEndpointExporter serverEndpointExporter(){
        return  new ServerEndpointExporter();
    }
    @Bean
    public CustomSpringConfigurator customSpringConfigurator() {
        return new CustomSpringConfigurator(); 
    }
    @Override
    protected void configureStompEndpoints(StompEndpointRegistry registry) {
        registry.addEndpoint("/websocket").setAllowedOrigins("*")
                .addInterceptors(new HttpSessionHandshakeInterceptor()).withSockJS();
    }

 	public class CustomSpringConfigurator extends ServerEndpointConfig.Configurator implements ApplicationContextAware {


    private static volatile BeanFactory context;

    @Override
    public <T> T getEndpointInstance(Class<T> clazz) throws InstantiationException {
        return context.getBean(clazz);
    }

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        CustomSpringConfigurator.context = applicationContext;
    }

    @Override
    public void modifyHandshake(ServerEndpointConfig sec,
                                HandshakeRequest request, HandshakeResponse response) {
        super.modifyHandshake(sec,request,response);
        HttpSession httpSession=(HttpSession) request.getHttpSession();
        if(httpSession!=null){
            sec.getUserProperties().put(HttpSession.class.getName(),httpSession);
        }
    }

}

@SpringBootApplication
@EnableCaching
@ComponentScan("com")
@EnableWebSocket
public class Application extends SpringBootServletInitializer {
	 static final Logger logger = LoggerFactory.getLogger(Application.class);
    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
        return application.sources(Application.class);
    }

需要注意的是: @EnableWebSocket 一定要加在启动类上，不然springboot无法对其扫描进行管理;
@SeverEndpoint --将目标类定义成一个websocket服务端，注解对应的值将用于监听用户连接的终端访问地址，客户端可以通过URL来连接到websocket服务端。

四、设计思路：用map<房间id， 用户set>来保存房间对应的用户连接列表，当有用户进入一个房间的时候，就会先检测房间是否存在，如果不存在那就新建一个空的用户set，再加入本身到这个set中，确保不同房间号里的用户session不串通！


/**
 * Create by wushuyu
 * on 2020/4/30 13:24
 * 
*/
@ServerEndpoint(value = "/websocket/{roomName}", configurator = CustomSpringConfigurator.class)
@Component
public class WebSocketRoom {
    //连接超时--一天
    private static final long MAX_TIME_OUT = 24*60*60*1000; 
    // key为房间号，value为该房间号的用户session
    private static final Map<String, Set<Session>> rooms = new ConcurrentHashMap<>();
    //将用户的信息存储在一个map集合里
    private static final Map<String, Object> users = new ConcurrentHashMap<>();
	/**
	*{roomName} 使用通用跳转，实现动态获取房间号和用户信息  格式：roomId|xx|xx
	*/
    @OnOpen  
    public void connect(@PathParam("roomName") String roomName, Session session) {
        String roomId = roomName.split("[|]")[0];
        String nickname = roomName.split("[|]")[1];
        String loginId = roomName.split("[|]")[2];
         //设置连接超时时间
            session.setMaxIdleTimeout(MAX_TIME_OUT);
        try {
           
           //可实现业务逻辑
            }
            // 将session按照房间名来存储，将各个房间的用户隔离
            if (!rooms.containsKey(roomId)) {
                // 创建房间不存在时，创建房间
                Set<Session> room = new HashSet<>();
                // 添加用户
                room.add(session);
                rooms.put(roomId, room);
            } else { // 房间已存在，直接添加用户到相应的房间               
                if (rooms.values().contains(session)) {//如果房间里有此session直接不做操作
                } else {//不存在则添加
                    rooms.get(roomId).add(session);
                }
            }
            JSONObject jsonObject = new JSONObject();
            -----
            //根据自身业务情况实现业务
            -----
            users.put(session.getId(), jsonObject);
            //向在线的人发送当前在线的人的列表     -------------可有可无，看业务需求
            List<ChatMessage> userList = new LinkedList<>();
            rooms.get(roomId)
                    .stream()
                    .map(Session::getId)
                    .forEach(s -> {
                        ChatMessage chatMessage = new ChatMessage();
                        chatMessage.setDate(new Date());
                        chatMessage.setStatus(1);
                        chatMessage.setChatContent(users.get(s));
                        chatMessage.setMessage("");
                        userList.add(chatMessage);
                    });
//        session.getBasicRemote().sendText(JSON.toJSONString(userList));
            //向房间的所有人群发谁上线了
            ChatMessage chatMessage = new ChatMessage();   ----将聊天信息封装起来。
            chatMessage.setDate(new Date());
            chatMessage.setStatus(1);
            chatMessage.setChatContent(users.get(session.getId()));
            chatMessage.setMessage("");
            broadcast(roomId, JSON.toJSONString(chatMessage));
            broadcast(roomId, JSON.toJSONString(userList));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    @OnClose
    public void disConnect(@PathParam("roomName") String roomName, Session session) {
        String roomId = roomName.split("[|]")[0];
        String loginId = roomName.split("[|]")[2];
        try {
            rooms.get(roomId).remove(session);
            ChatMessage chatMessage = new ChatMessage();
            chatMessage.setDate(new Date());
            chatMessage.setUserName(user.getRealname());
            chatMessage.setStatus(0);
            chatMessage.setChatContent(users.get(session.getId()));
            chatMessage.setMessage("");
            users.remove(session.getId());
            //向在线的人发送当前在线的人的列表  ----可有可无，根据业务要求
            List<ChatMessage> userList = new LinkedList<>();
            rooms.get(roomId)
                    .stream()
                    .map(Session::getId)
                    .forEach(s -> {
                        ChatMessage chatMessage1 = new ChatMessage();
                        chatMessage1.setDate(new Date());
                        chatMessage1.setUserName(user.getRealname());
                        chatMessage1.setStatus(1);
                        chatMessage1.setChatContent(users.get(s));
                        chatMessage1.setMessage("");
                        userList.add(chatMessage1);
                    });
            broadcast(roomId, JSON.toJSONString(chatMessage));
            broadcast(roomId, JSON.toJSONString(userList));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    @OnMessage
    public void receiveMsg( String msg, Session session) {
        try {
                ChatMessage chatMessage = new ChatMessage();
                chatMessage.setUserName(user.getRealname());
                chatMessage.setStatus(2);
                chatMessage.setChatContent(users.get(session.getId()));
                chatMessage.setMessage(msg);
                // 按房间群发消息
                broadcast(roomId, JSON.toJSONString(chatMessage));
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    // 按照房间名进行群发消息
    private void broadcast(String roomId, String msg) {
        rooms.get(roomId).forEach(s -> {
            try {
                s.getBasicRemote().sendText(msg);   -----此还有一个getAsyncRemote()   
            } catch (IOException e) {
                e.printStackTrace();
            }
        });
    }

    @OnError
    public void onError(Throwable error) {
        error.printStackTrace();
    }
}

友情提示：此session是websocket里的session，并非httpsession；

小小码童
关注
专栏目录
springboot3搭建WebSocket服务
Java技术实践
06-27 1702
本文详细介绍了如何在SpringBoot项目中搭建WebSocket服务，包括创建工程、添加依赖、配置文件、主启动类和WebSocket相关类的实现，以及编写测试页面以验证功能。WebSocket 是一种在客户端和服务器之间实现双向通信的协议。即时聊天应用：WebSocket 可以实现实时的双向通信，适用于即时聊天应用，如在线聊天室、社交媒体平台的聊天功能等。实时数据更新：WebSocket可以在服务器端有新数据时，自动将更新推送到客户端，适用于实时数据展示应用，如股票行情展示、实时监控系统等。
SpringBoot整合websocket实现及时通信聊天
m0_54853420的博客
06-12 1514
线上演示地址：http://chat.breez.work 场景再现：构造函数如下所示： 例子如下： ??1.1.1 函数 1、 webSocket.send() 该函数用于向服务端发送一条消息，例子如下： 2、 webSocket.close() 该函数用于关闭客户端与服务端的连接，例子如下： ??1.1.2　事件 1、webSocket.onopen 该事件用于监听客户端与服务端的连接状态，如果客户端与服务端则该事件触发，例子如下： 2、webSocket.onclose 如果服务端与客户端连接断开，那
Spring整合websocket实现即时通讯聊天室
10-20
Spring-websocket 传统的HTTP协议，一般通过向服务器发送请求，拉取数据实现半双工通信，缺点是服务器难以直接向浏览器下发消息，因此，websocket协议应运而生，可用于向建立连接的浏览器主动下发任意数据（PUSH）。本项目基于Spring平台，整合websocket协议，实现一个简易web聊天室的功能。主要特性如下: 1.包含聊天室登录、退出的功能。登录时，浏览器自动向服务器发起websocket连接，退出时自动切断。 2.登录后，用户可查看到聊天室在线的用户列表，我们在服务器上通过一个hashmap始终记录了当前在线的用户列表； 3.登录的用户可以点击一个在线的其他用户，并给他发送消息，消息先提交给服务器，在通过服务器转发给另一端用户； 4.支持群发消息的功能，使用时，服务器会将收到的消息群发给当前在线的所有用户; 5.添加好友上线提醒和下线提醒的功能，当有好友上线或下线时自动通知所有其他在线人，不要刷新页面可看到实时在线用户列表。
springboot集成websocket实现简单聊天
03-29
springboot集成websocket实现即时通信，你发的消息将直接显示在另一台pc机的浏览器上
Springboot3 Websocket 没反应
最新发布
weixin_45051415的博客
08-17 153
Springboot3 Websocket // 正确依赖 org.springframework.boot spring-boot-starter-websocket jakarta.websocket jakarta.websocket-api
SpringBoot3集成WebSocket
【积累】，是一个长期持续的过程。
05-12 842
WebSocket通过一个TCP连接在客户端和服务器之间建立一个全双工、双向的通信通道，使得客户端和服务器之间的数据交换变得更加简单。
Spring boot3简单实现websocket（拦截器，跨域，并行发送，服务端发送）
lingxiaoNo1的博客
04-11 3608
Spring boot3简单实现websocket（拦截器，跨域，并行发送，服务端发送）
springboot整合WebSocket实现即时通信demo源码案例演示
07-23
一、简介 二、工程搭建 1、工程结构 2、依赖管理 三、WebSocket用法 1、示意图 2、API参考 四、源码参考
Spring boot整合websocket实现即时通讯demo(适合新手或者开发人员学习)
06-27
本项目基于Spring平台，整合websocket协议，实现一个简易web聊天室的功能。主要特性如下: 1.包含聊天室登录、退出的功能。登录时，浏览器自动向服务器发起websocket连接，退出时自动切断。登录页面为...
SpringBoot整合websocket实现在线客服聊天
热门推荐
浅汐
06-09 7万+
websocket最伟大之处在于服务器和客户端可以在给定的时间范围内的任意时刻，相互推送信息。 浏览器和服务器只需要要做一个握手的动作，在建立连接之后，服务器可以主动传送数据给客户端，客户端也可以随时向服务器发送数据。 实现功能：springboot整合websocket实现一对一，多对多聊天系统。 依赖 <dependency> <groupId>com.alibaba</groupId> <
springboot整合websocket
01-08
总结来说，"springboot整合websocket"是一个结合了Spring Boot的便捷性和WebSocket的实时性，实现即时通讯功能的过程。通过创建WebSocket处理器，配置WebSocket端点，以及前端JavaScript的交互，我们可以构建出支持...
SpringBoot从入门到精通系列三：WebSocket
zhengzaifeidelushang的博客
09-30 669
SpringBoot从入门到精通系列三：WebSocket使用@ServerEndpoint开发WebSocket1.定义pom.xml2.定义WebSocket处理类3.配置ServerEndpointExporter Bean3.使用JavaScript来开发WebSocket客户端4.主程序类 使用WebSocket能让客户端与服务端进行双向的实时通信。当客户端与服务端之间交互的内容较多或对实时性要求较高时，可使用WebSocket。 使用@ServerEndpoint开发WebSocket Spri
Springboot3.0 响应式WebSocket代码分享
chundonghan的博客
12-31 1549
springboot3 reactive websocket
【Spring实战项目】SpringBoot3整合WebSocket+拦截器实现登录验证！从原理到实战
终于等到你啦~欢迎来到我的知识空间 这里是苏泽的成神之路
04-03 2921
WebSocket是基于TCP协议的一种网络协议，它实现了浏览器与服务器全双工通信，支持客户端和服务端之间相互发送信息。在有WebSocket之前，如果服务端数据发生了改变，客户端想知道的话，只能采用定时轮询的方式去服务端获取，这种方式很大程度上增大了服务器端的压力，有了WebSocket之后，如果服务端数据发生改变，可以立即通知客户端，客户端就不用轮询去换取，降低了服务器的压力。目前主流的浏览器都已经支持WebSocket协议了。
Spring boot 实现 WebSocket服务端
m0_37887812的博客
05-12 1653
Spring boot 实现 WebSocket服务端 这里写目录标题Spring boot 实现 WebSocket服务端声明准备工作1. 配置2. WebSocket服务类3. 编写客户端，测试websocket服务总结 声明 此文档适合初次搭建websocket的情况，包含以下内容 websocket启动需要的配置 ws地址 注入业务service 上传内容过大问题，如：base64的图片 websocket服务端 websocket客户端 准备工作 引入Maven依赖
Springboot3.X集成WebSocket完整流程
qq_43437208的博客
03-12 3711
pom文件。--spring 版本--> < parent > < groupId > org.springframework.boot < artifactId > spring-boot-starter-parent < version > 3.0.5
SpringBoot整合WebSocket详解
asoklove的专栏
08-10 1187
SpringBoot整合WebSocket详解
springboot下的websocket服务端和客户端编写
xiaogangpi的专栏
06-16 811
一：服务端 引入maven依赖 <!-- websocket--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> </dependency> <!-- 引入外部SD..
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值