175. Spring Boot WebSocket：单聊

最新推荐文章于 2025-06-13 15:43:18 发布

原创最新推荐文章于 2025-06-13 15:43:18 发布 · 2.2w 阅读

文章标签：

#spring boot #spring boot视频 #spring boot实战 #spring boot教程 #从零开始学Spring Boot

从零开始学Spring Boot 同时被 2 个专栏收录

284 篇文章

订阅专栏

spring boot

270 篇文章

订阅专栏

本文介绍如何利用WebSocket实现单聊与群聊功能，并详细解释了服务端和客户端的调整过程，包括创建Socket消息对象、调整连接及消息发送方法等。

【视频 & 交流平台】

à SpringBoot视频

http://study.163.com/course/introduction.htm?courseId=1004329008&utm_campaign=commission&utm_source=400000000155061&utm_medium=share

à SpringCloud视频

http://study.163.com/course/introduction.htm?courseId=1004638001&utm_campaign=commission&utm_source=400000000155061&utm_medium=share

à Spring Boot源码

https://gitee.com/happyangellxq520/spring-boot

à Spring Boot交流平台

http://412887952-qq-com.iteye.com/blog/2321532

需求缘起：

在前面的文章中已经实现了群聊，这里也简单介绍下单聊。这里使用session.getId()中的id作为唯一的消息通道（这里我们称为通讯的频道号）， session.getId()是一个递增的数字，从0开始，递增1,2,3… 实际中并不会使用这个id作为标识，这里只是为了讲解方便。

效果展示：

先看下最终实现的效果，如下图：

悟空消息：

师傅消息：

八戒消息：

一、服务端调整

1.1 创建一个Socket消息对象SocketMsg

这里我们就不能使用简单的文本消息进行消息的发送了，我们使用json进行消息的发送。所以需要先创建一个消息对象，里面包含了消息发送者，消息接受者，消息类型（单聊还是群聊），还是就是消息，如下：

com.kfit.socket.SocketMsg：

package com.kfit.socket;
 
public class SocketMsg {
       private int type;//聊天类型0：群聊，1：单聊.
       private String fromUser;//发送者.
       private String toUser;//接受者.
       private String msg;//消息
       public int getType() {
              return type;
       }
       public void setType(inttype) {
              this.type = type;
       }
       public String getFromUser() {
              return fromUser;
       }
       public void setFromUser(String fromUser) {
              this.fromUser = fromUser;
       }
       public String getToUser() {
              returntoUser;
       }
       public void setToUser(String toUser) {
              this.toUser = toUser;
       }
       public String getMsg() {
              returnmsg;
       }
       public void setMsg(String msg) {
              this.msg = msg;
       }
}

1.2 调整建立连接的方法（MyWebSocket）

这里主要是要使用一个map对象保存频道号和session之前的关系，之后就可以通过频道号获取session，然后使用session进行消息的发送。

定义一个map对象：

//用来记录sessionId和该session进行绑定 
 private static Map<String,Session> map = new HashMap<String, Session>();

修改连接的方法onOpen：

在建立连接的时候，就保存频道号（这里使用的是session.getId()作为频道号）和session之间的对应关系：

    @OnOpen
    public void onOpen(Session session,@PathParam("nickname") String nickname) {
        this.session = session;
        this.nickname = nickname;
        map.put(session.getId(), session);
       
        webSocketSet.add(this);     //加入set中
        System.out.println("有新连接加入！当前在线人数为" + webSocketSet.size());
        this.session.getAsyncRemote().sendText(this.nickname+"上线了"+"（他的频道号是"+session.getId()+"）");
    }

修改消息发送的方法 onMessage：

从客户端传过来的数据是json数据，所以这里使用jackson进行转换为SocketMsg对象，然后通过socketMsg的type进行判断是单聊还是群聊，进行相应的处理：

@OnMessage
    public void onMessage(String message, Session session,@PathParam("nickname") String nickname) {
        System.out.println("来自客户端的消息:" + message);
 
        ObjectMapper objectMapper = new ObjectMapper();
        SocketMsg socketMsg;
              try {
                     socketMsg = objectMapper.readValue(message, SocketMsg.class);
                     if(socketMsg.getType() == 1){
                            //单聊.需要找到发送者和接受者.
                           
                            socketMsg.setFromUser(session.getId());//发送者.
                            Session fromSession = map.get(socketMsg.getFromUser());
                            Session toSession = map.get(socketMsg.getToUser());
                            //发送给接受者.
                            if(toSession != null){
                                   //发送给发送者.
                                   fromSession.getAsyncRemote().sendText(nickname+"："+socketMsg.getMsg());
                                   toSession.getAsyncRemote().sendText(nickname+"："+socketMsg.getMsg());
                            }else{
                                   //发送给发送者.
                                   fromSession.getAsyncRemote().sendText("系统消息：对方不在线或者您输入的频道号不对");
                            }
                     }else{
                            //群发消息
                      broadcast(nickname,socketMsg);
                     }
              } catch (JsonParseException e) {
                     // TODO Auto-generated catch block
                     e.printStackTrace();
              } catch (JsonMappingException e) {
                     // TODO Auto-generated catch block
                     e.printStackTrace();
              } catch (IOException e) {
                     // TODO Auto-generated catch block
                     e.printStackTrace();
              }
    }

二、客户端调整

2.1 加入频道号输入框

提供用户输入频道号进行单聊：

消息：<input id="text" type="text" />
频道号<input id="toUser" type="text" />
<button onclick="send()">发送消息</button>

2.2 修改消息发送方法

这里使用了js对象进行消息的传递，这里使用JSON.stringify将json对象转换为json字符串，如下代码：

//发送消息
       function send() {
              //获取输入的文本信息进行发送
              var message = document.getElementById('text').value;
              var toUser = document.getElementById('toUser').value;
              var socketMsg = {msg:message,toUser:toUser};
              if(toUser == ''){
                     //群聊.
                     socketMsg.type = 0;
              }else{
                     //单聊.
                     socketMsg.type = 1;
              }
             
              websocket.send(JSON.stringify(socketMsg));
       }

好了，到这里就可以实现了单聊+群聊的效果。

三、新问题的提出

上面虽然可以实现单聊的方式，但是在具体的实际场景中，想要知道对方的频道号好像不是那么容易的哦，那么这个要怎么解决呢？大家在玩QQ群的时候，应该都用过聊天界面中的右边的群成员吧，对头，就是要实现一个在线群成员列表的功能，这样用户在操作的时候就可以直接通过点击某个在线的用户进行聊天了。博主，你会实现嘛？^_^，博主还暂时没有这个计划，其实看懂了上面的代码之后，要实现在线群成员列表也不是很难的事情了。

四、源代码

最后奉上源代码。大家可以下载源代码玩玩！

访问地址：https://gitee.com/happyangellxq520/spring-boot 找到spring-boot-websocket-2017，直接下载即可运行。