SpringBoot结合WebSocket实现聊天功能

更新时间：2024年11月01日 10:09:28 作者：小李大魔王

本文介绍了如何使用SpringBoot和WebSocket实现一个简单的聊天功能,包括导入依赖、配置类、创建消息实体、指定ServerEndpoint、创建客户端等步骤,通过具体示例,演示了如何发送个人消息和群发消息,实现了基本的聊天功能,适合需要在项目中实现实时通讯功能的开发者参考

一、导入依赖

<!--    父依赖 -->
  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.3.10.RELEASE</version>
  </parent>
  <dependencies>
    <!--    websocket依赖 -->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-websocket</artifactId>
    </dependency>
    <!--      websocket客户端  -->
    <dependency>
      <groupId>org.java-websocket</groupId>
      <artifactId>Java-WebSocket</artifactId>
      <version>1.5.3</version>
    </dependency>
    <!--    lombok  -->
    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
    </dependency>
    <!--      JSON转换器   -->
    <dependency>
      <groupId>com.alibaba</groupId>
      <artifactId>fastjson</artifactId>
      <version>1.2.83</version>
    </dependency>
  </dependencies>

二、导入配置类

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;
@Configuration
public class WebSocketConfig {
    /**
     *   创建 websocket 的服务器
     */
    @Bean
    public ServerEndpointExporter serverEndpointExporter(){
        return new ServerEndpointExporter();
    }
}

三、创建传递消息的实体

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
@AllArgsConstructor
@NoArgsConstructor
@Builder
@Data
public class Message {
    /**
     * 消息的发送者
     */
    private String sender;
    /**
     * 消息的接收者
     */
    private String receiver;
    /**
     * 消息的内容
     */
    private String content;
}

四、指定ServerEndpoint

import com.alibaba.fastjson.JSON;
import com.chat.entity.Message;
import org.springframework.web.bind.annotation.RestController;
import javax.websocket.*;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
@RestController
@ServerEndpoint("/{name}")
public class WsServer {
    /**
     * 记录所有的在线用户
     */
    private static Map<String, WsServer> clients = new HashMap<>();
    /**
     * 当前用户的名称
     */
    private String name;
    /**
     * 本地会话
     */
    private Session session;
    /**
     *  建立新的链接时调用
     */
    @OnOpen
    public void onOpen(@PathParam("name")String name, Session session){
        //  判断名称是否使用了关键字
        if (name.equals("all")){
            session.getAsyncRemote().sendText("不允许使用all作为名称");
            try {
                session.close();
            } catch (IOException e) {
                throw new RuntimeException(e);
            }
            return;
        }
        //  判断该名称是否被使用
        WsServer client = clients.get(name);
        if (client!=null){
            session.getAsyncRemote().sendText(name + "名称已经被使用，请重新取名");
            try {
                session.close();
            } catch (IOException e) {
                throw new RuntimeException(e);
            }
            return;
        }
        this.name = name;
        this.session = session;
        //  记录当前用户
        clients.put(name, this);
        // 欢迎新用户
        String msg = "欢迎用户 '" + name + "' 来到小阳交友平台"+"\t在线人数为：" + clients.size() + "\n" + "请选择你要发送的好友：\n";
        int count = 0;
        for (String tName : clients.keySet()) {
            msg += tName + '\t';
            count++;
            if (count % 8 == 0){
                msg += '\n';
            }
        }
        if (msg.charAt(msg.length()-1)!='\n'){
            msg += '\n';
        }
        msg += "请以 receiver(all发送给所有人) content 的格式发送消息\n";
        Message message = new Message();
        message.setContent(msg);
        message.setSender("通知");
        for (WsServer wsServer : clients.values()) {
            wsServer.session.getAsyncRemote().sendText(JSON.toJSONString(message));
        }
    }
    @OnClose
    public void onClose(){
        // 去除下线用户
        clients.remove(name);
        Message message = new Message();
        message.setSender("通知");
        message.setContent("用户 '" + name + "已下线");
        //  通知所有用户该用户已下线
        for (WsServer wsServer : clients.values()) {
            wsServer.session.getAsyncRemote().sendText(JSON.toJSONString(message));
        }
        System.out.println("用户 '" + name + "已下线");
    }
    @OnError
    public void  onError(Session session, Throwable error){
        System.out.println("发生错误" + error.getMessage());
    }
    @OnMessage
    public void onMessage(String message,Session session){
        Message userMessage = JSON.parseObject(message, Message.class);
        //  判断该消息是发给谁的
        if (userMessage.getReceiver().equals("all")){
            // 发给所有人
            for (WsServer wsServer : clients.values()) {
                if (clients.get(userMessage.getSender())!=wsServer){
                    wsServer.session.getAsyncRemote().sendText(JSON.toJSONString(userMessage));
                }
            }
            return;
        }
        WsServer wsServer = clients.get(userMessage.getReceiver());
        wsServer.session.getAsyncRemote().sendText(JSON.toJSONString(userMessage));
    }
}

五、创建客户端

如果你的项目指定了端口，记得把wsServerURL换成自己的

import com.alibaba.fastjson.JSON;
import com.chat.entity.Message;
import org.java_websocket.client.WebSocketClient;
import org.java_websocket.handshake.ServerHandshake;
import java.net.URI;
import java.util.Scanner;
public class WsClient {
    //  运行处理消息服务器WsServer主机的URL
    private static String wsServerURL = "ws://localhost:8080/";
    public static void main(String[] args) throws Exception {
        Scanner sc = new Scanner(System.in);
        String name;
        WebSocketClient client;
        while (true){
            // 获取用户身份   ( 不同用户的名字不能一样 )
            System.out.print("请输入你的名字： ");
            name = sc.next();
            //  建立连接
            client = new WebSocketClient(new URI(wsServerURL+name)) {
                @Override
                public void onOpen(ServerHandshake serverHandshake) {
                    System.out.println("客户端与服务端建立连接");
                }
                @Override
                public void onMessage(String s) {
                    Message message = JSON.parseObject(s, Message.class);
                    System.out.println("\n" + message.getSender() + ": " + message.getContent());
                }
                @Override
                public void onClose(int i, String s, boolean b) {
                    System.out.println("客户端与服务端断开连接");
                    System.exit(0);
                }
                @Override
                public void onError(Exception e) {
                    System.out.println("服务端发生错误");
                }
            };
            client.connect();
            Thread.sleep(1000);
            if (client.isOpen()){
                break;
            }
        }
        Message message = new Message();
        message.setSender(name);
        while (true){
           String toUser = sc.next();
           String content = sc.nextLine();
           message.setReceiver(toUser);
           message.setContent(content);
           client.send(JSON.toJSONString(message));
        }
    }
}

六、演示

① 通过输入名字指定自己的身份 （这里我没有做中文处理，所以名称不要用中文）

通过 receiver content 的格式向另一个用户发送消息，如向 xxx2 发送消息

xxx2 收到的消息：

群发消息通过 all 来指定所有人，如：

这样所有人都能收到消息

七、项目地址

springBoot结合WebSocket实现聊天: springBoot结合WebSocket实现聊天实现简单聊天

到此这篇关于SpringBoot结合WebSocket实现聊天功能的文章就介绍到这了,更多相关SpringBoot WebSocket聊天内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

mybatis-plus更新字段为null的处理方式
这篇文章主要介绍了mybatis-plus更新字段为null的处理方式，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-08-08
java分析html算法(java网页蜘蛛算法示例)
近来有些朋友在做蜘蛛算法，或者在网页上面做深度的数据挖掘,下面使用示例
2014-03-03
Java如何判断字符串中是否包含某个字符
这篇文章主要介绍了Java如何判断字符串中是否包含某个字符,可以使用String类的contains()方法，另一种方法使用String类的indexOf方法，本文结合示例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2023-02-02
SpringBoot+devtools实现热部署的示例代码
在软件项目的开发过程中,不可避免的会经常修改代码,每次修改代码,都需要手动停止然后再启动服务,最后验证代码的正确性,今天通过这篇文章,我们一起来学习一下如何使用Spring Boot + devtools 轻松搞定热部署,需要的朋友可以参考下
2024-08-08
详解JAVA的封装
Java面向对象的三大特性：封装、继承、多态。下面对三大特性之一封装进行了总结，需要的朋友可以参考下
2017-04-04
关于springboot集成swagger3时spring-plugin-core报错的问题
这篇文章主要介绍了关于springboot集成swagger3时spring-plugin-core报错的问题,本文给大家分享解决方法，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2021-09-09
Java构造器与传值学习总结
这篇文章主要为大家详细介绍了Java构造器与传值学习总结，文中示例介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-01-01
java教程之java注解annotation使用方法
这篇文章主要介绍了java注解annotation使用方法,注解可以定义到方法上，类上，一个注解相当与一个类，就相当于实例了一个对象，加上了注解，就相当于加了一个标志
2014-01-01
Java上传视频实例代码
本文通过实例代码给大家讲解了java上传视频功能，代码分为页面前台和后台，工具类，具体实例代码大家通过本文学习吧
2018-01-01
springcloud配置ssh的问题及解决方法
这篇文章主要介绍了springcloud配置ssh，本文给大家介绍在配置过程中遇到的问题及解决方法，通过结合实例给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
2022-03-03