0
点赞
收藏
分享

微信扫一扫

82,springboot+websocket构建在线聊天室

闲云困兽 2021-09-21 阅读 80

参考 https://blog.csdn.net/qq_41603102/article/details/82492040

1,群聊功能实现
1.1 引入websocket jar

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

1.2 注入ServerEndpointExporteer


package com.taotao.servicehi.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;


/**
 * 编写一个WebSocketConfig配置类,注入对象ServerEndpointExporter
 * 这个bean会自动注册使用了@ServerEndpoint注解声明的Websocket endpoint
 */
@Configuration
public class WebSocketConfig {

    @Bean
    public ServerEndpointExporter serverEndpointExporter(){
      return  new ServerEndpointExporter();
    }
}

1.3 websocket具体的实现类

package com.taotao.servicehi.config;

import org.springframework.stereotype.Component;

import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.ServerEndpoint;
import java.util.concurrent.CopyOnWriteArraySet;

@ServerEndpoint(value = "/websocket")
@Component
public class MyWebSocket {


    //用来存放每个客户端对应的MyWebSocket对象。
    private static CopyOnWriteArraySet<MyWebSocket> webSocketSet = new CopyOnWriteArraySet<MyWebSocket>();
    //与某个客户端的连接会话,需要通过它来给客户端发送数据
    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.4 编写客户端 webScoketTest.html放在static目录


<!DOCTYPE HTML>
<html>
<head>
    <meta charset="UTF-8">
    <title>My WebSocket</title>
    <style>
        #message{
            margin-top:40px;
            border:1px solid gray;
            padding:20px;
        }
    </style>
</head>
<body>
<button οnclick="conectWebSocket()">连接WebSocket</button>
<button οnclick="closeWebSocket()">断开连接</button>
<hr />
<br />
消息:<input id="text" type="text" />
<button οnclick="send()">发送消息</button>
<div id="message"></div>
</body>
<script type="text/javascript">
    var websocket = null;
    function conectWebSocket(){
        //判断当前浏览器是否支持WebSocket
        if ('WebSocket'in window) {
            websocket = new WebSocket("ws://localhost:8080/websocket");
        } else {
            alert('Not support websocket')
        }
        //连接发生错误的回调方法
        websocket.onerror = function() {
            setMessageInnerHTML("error");
        };
        //连接成功建立的回调方法
        websocket.onopen = function(event) {
            setMessageInnerHTML("Loc MSG: 成功建立连接");
        }
        //接收到消息的回调方法
        websocket.onmessage = function(event) {
            setMessageInnerHTML(event.data);
        }
        //连接关闭的回调方法
        websocket.onclose = function() {
            setMessageInnerHTML("Loc MSG:关闭连接");
        }
        //监听窗口关闭事件,当窗口关闭时,主动去关闭websocket连接,防止连接还没断开就关闭窗口,server端会抛异常。
        window.onbeforeunload = function() {
            websocket.close();
        }
    }
    //将消息显示在网页上
    function setMessageInnerHTML(innerHTML) {
        document.getElementById('message').innerHTML += innerHTML + '<br/>';
    }
    //关闭连接
    function closeWebSocket() {
        websocket.close();
    }
    //发送消息
    function send() {
        var message = document.getElementById('text').value;
        websocket.send(message);
    }
</script>
</html>
 

测试


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



对代码进行改造:
1,在连接的时候,让用户输入昵称

 昵称:<input type="text" id="nickname"/>
<button onclick="connectWebSocket()">连接webSocket</button>
<button onclick="closeWebSocket()">断开连接</button>

2,连接前的校验


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


3,昵称显示方法
首先修改客户端的连接方式:
js代码

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

java代码

@ServerEndpoint(value = "/websocket/{nickname}")  
@Component  
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中
   webSockets.add(this);//加入set 中
        System.out.println("有新的连接加入! 当前在线人数为" + webSockets.size());
        this.session.getAsyncRemote().sendText("恭喜您成功连接上WebSocket,当前在线连接人数为:" + webSockets.size());

    }


测试: 如效果图一样;

3 单聊:
3.1 创建消息对象:socketMsg

package com.taotao.servicehi.entity;

/**
 *
 */
public class SocketMsg {
    private  int type;//聊天类型0:群聊,1:单聊
    private String fromUser;//发送者
    private String toUser;//接受者
    private String msg;//消息
//省去set/get
}



3.2 调整建立连接的方法(MyWebSocket)
这里主要的是要用有个map对象保存频道号和session 之前的关系,之后就可以通过频道号获取session,然后使用session进行消息的发送

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

3.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());
}


3.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);
    }






3.5 客户端调整

消息:<input id="text" type="text" />
频道号:<input id="toUser" type="text" />
<button οnclick="send()">发送消息</button>
//发送消息
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));
}
 


3.6 测试:


在线开房间地址: http://www.javashitang.com:8090

举报

相关推荐

0 条评论