springboot+websocket构建在线聊天室（群聊+单聊）

本系列文章：

1、springboot+websocket构建在线聊天室（群聊+单聊）

2、SpringBoot+STOMP 实现聊天室（单聊+多聊）及群发消息详解

3、websocket stomp+rabbitmq实现消息推送

---

目录

1、群聊+显示昵称

1.1、原理

1.2、编码分析

1.3、群聊 功能实现

1.3.1、引入依赖

1.3.2、注入ServerEndpointExporter

1.3.3、websocket的具体实现类

1.3.4、编写客户端webSocketTest.html(放到static目录下)

1.3.5测试

1.4、群聊+昵称

1.4.1、效果展示：

4.4.2、对代码进行改造

1.4.3、测试

1.5、单聊

1.5.1、创建消息对象socketMsg

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

1.5.3、修改连接的方法onOpen（MyWebSocket）:

1.5.5、客户端调整

4.5.6、测试

---

1、群聊+显示昵称

 

1.1、原理

可参考：

http://www.cnblogs.com/fuqiang88/p/5956363.html

http://412887952-qq-com.iteye.com/category/356333?page=2

1.2、编码分析

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

1.3、群聊 功能实现

1.3.1、引入依赖

   org.springframework.boot
   spring-boot-starter-websocket

1.3.2、注入ServerEndpointExporter

/**  * @Auther: zj  * @Date: 2018/8/16 17:21  * @Description: 编写一个WebSocketConfig配置类，注入对象ServerEndpointExporter，  *      这个bean会自动注册使用了@ServerEndpoint注解声明的Websocket endpoint  */ @Configuration public class WebSocketConfig {     @Bean     public ServerEndpointExporter serverEndpointExporter() {         return new ServerEndpointExporter();     } }

 

1.3.3、websocket的具体实现类

/**  * @Auther: zj  * @Date: 2018/8/16 17:55  * @Description: websocket的具体实现类  * 使用springboot的唯一区别是要@Component声明下，而使用独立容器是由容器自己管理websocket的，  * 但在springboot中连容器都是spring管理的。     虽然@Component默认是单例模式的，但springboot还是会为每个websocket连接初始化一个bean，     所以可以用一个静态set保存起来。  */ @ServerEndpoint(value = "/websocket") @Component public class MyWebSocket {     //用来存放每个客户端对应的MyWebSocket对象。     private static CopyOnWriteArraySet webSocketSet = new CopyOnWriteArraySet();     //与某个客户端的连接会话，需要通过它来给客户端发送数据     private Session session;     /**      * 连接建立成功调用的方法      */     @OnOpen     public void onOpen(Session session) {         this.session = session;         webSocketSet.add(this);     //加入set中         System.out.println("有新连接加入！当前在线人数为" + webSocketSet.size());         this.session.getAsyncRemote().sendText("恭喜您成功连接上WebSocket-->当前在线人数为："+webSocketSet.size());     }     /**      * 连接关闭调用的方法      */     @OnClose     public void onClose() {         webSocketSet.remove(this);  //从set中删除         System.out.println("有一连接关闭！当前在线人数为" + webSocketSet.size());     }     /**      * 收到客户端消息后调用的方法      *      * @param message 客户端发送过来的消息*/     @OnMessage     public void onMessage(String message, Session session) {         System.out.println("来自客户端的消息:" + message);         //群发消息         broadcast(message);     }     /**      * 发生错误时调用      *      */     @OnError     public void onError(Session session, Throwable error) {         System.out.println("发生错误");         error.printStackTrace();     }     /**      * 群发自定义消息      * */     public  void broadcast(String message){         for (MyWebSocket item : webSocketSet) {             //同步异步说明参考：http://blog.csdn.net/who_is_xiaoming/article/details/53287691             //this.session.getBasicRemote().sendText(message);             item.session.getAsyncRemote().sendText(message);//异步发送消息.         }     } }

 

1.3.4、编写客户端webSocketTest.html(放到static目录下)

连接WebSocket 断开连接 消息： 发送消息

 

1.3.5测试

打开chrome浏览器：

localhost:8080/webSocketTest.html

2）点击【连接WebSocket】,然后就可以发送消息了。

 

（3）打开另外一个浏览器或者直接打开一个TAB访问地址http://127.0.0.1:8080/webSocketTest.html

（4）点击【连接WebSocket】,然后就可以发送消息了。

（5）观察两边的信息打印，看是否可以接收到消息。

参考：http://412887952-qq-com.iteye.com/blog/2404851

1.4、群聊+昵称

上一部分已经可以群聊功能了，但是存在一个问题，就是无法显示消息是谁发送了，这样就会导致消息乱七八糟的无法解读，我们来解决这个问题

1.4.1、效果展示：

效果展示：

à悟空消息：

à师傅消息：

 

à八戒消息：

 

4.4.2、对代码进行改造

1、在连接的时候，让用户输入昵称

input type="text" id="nickname"/> 连接WebSocket

 

2、连接前的校验

var nickname = document.getElementById("nickname").value; if(nickname===""){     alert("请输入昵称");     return; }

 

3、昵称显示方法

 

首先修改客户端的连接方式：

Js代码  

1. websocket = new WebSocket("ws://localhost:8080/websocket/"+nickname);  

Java代码  

1. @ServerEndpoint(value = "/websocket/{nickname}")  
2. @Component  
3. public class MyWebSocket {}  

à服务端获取参数：

       这个在每个方法中都可以获取的，使用@PathParam("nickname") String nickname，比如在连接的时候：

修改MyWebSocket:

 

添加：

private String nickname;

 

/**  * 连接建立成功调用的方法  */ @OnOpen public void onOpen(Session session,@PathParam("nickname") String nickname) {     this.session = session;     this.nickname=nickname;     webSocketSet.add(this);     //加入set中     System.out.println("有新连接加入:"+nickname+",当前在线人数为" + webSocketSet.size());     this.session.getAsyncRemote().sendText("恭喜您成功连接上WebSocket-->当前在线人数为："+webSocketSet.size()); }

 

/**  * 收到客户端消息后调用的方法  *  * @param message 客户端发送过来的消息*/ @OnMessage public void onMessage(String message, Session session,@PathParam("nickname") String nickname) {     System.out.println("来自客户端的消息-->"+nickname+": " + message);     //群发消息     broadcast(nickname+": "+message); }

 

1.4.3、测试

如效果图一样

 

参考：http://412887952-qq-com.iteye.com/blog/2404898

 

1.5、单聊

1.5.1、创建消息对象socketMsg

package jit.hf.agriculture.vo; /**  * @Auther: zj  * @Date: 2018/8/16 23:29  * @Description:这里我们就不能使用简单的文本消息进行消息的发送了，我们使用json进行消息的发送。  * 所以需要先创建一个消息对象，里面包含了消息发送者，消息接受者，消息类型（单聊还是群聊），还是就是消息，如下：  */ 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(int type) {         this.type = type;     }     public String getFromUser() {         return fromUser;     }     public void setFromUser(String fromUser) {         this.fromUser = fromUser;     }     public String getToUser() {         return toUser;     }     public void setToUser(String toUser) {         this.toUser = toUser;     }     public String getMsg() {         return msg;     }     public void setMsg(String msg) {         this.msg = msg;     } }

 

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

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

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

 

1.5.3、修改连接的方法onOpen（MyWebSocket）:

 

在建立连接的时候，就保存频道号（这里使用的是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("有新连接加入:"+nickname+",当前在线人数为" + webSocketSet.size());
    this.session.getAsyncRemote().sendText("恭喜"+nickname+"成功连接上WebSocket(其频道号："+session.getId()+")-->当前在线人数为："+webSocketSet.size());
}

1.5.4、修改消息发送的方法 onMessage（MyWebSocket）：

/**
     * 收到客户端消息后调用的方法
     *
     * @param message 客户端发送过来的消息*/
    @OnMessage
    public void onMessage(String message, Session session,@PathParam("nickname") String nickname) {
        System.out.println("来自客户端的消息-->"+nickname+": " + message);

        //从客户端传过来的数据是json数据，所以这里使用jackson进行转换为SocketMsg对象，
        // 然后通过socketMsg的type进行判断是单聊还是群聊，进行相应的处理:
        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.getMsg);
            }

        } catch (JsonParseException e) {
            e.printStackTrace();
        } catch (JsonMappingException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        }


//        //群发消息
//        broadcast(nickname+": "+message);
    }

1.5.5、客户端调整

消息： 频道号： 发送消息

 

//发送消息 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)); }

 

4.5.6、测试

与预期一样

 

à悟空消息：

 

 

 

à师傅消息：

 

 

 

à八戒消息：

============

2019/03/27更新：

看完本文，是不是觉得websocket协议怎么这么麻烦，其实我们完全可以用它的子协议STOMP来实现本文所有的功能，因已封装的很好，用起来非常简单。当然本文还是有好处的，起码让大家了解了websocket底层是怎么实现：P

延伸：SpringBoot+STOMP 实现聊天室（单聊+多聊）及群发消息详解

 

参考：

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