快捷導(dǎo)航

SpringBoot結(jié)合WebSocket實現(xiàn)聊天功能

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

本文介紹了如何使用SpringBoot和WebSocket實現(xiàn)一個簡單的聊天功能,包括導(dǎo)入依賴、配置類、創(chuàng)建消息實體、指定ServerEndpoint、創(chuàng)建客戶端等步驟,通過具體示例,演示了如何發(fā)送個人消息和群發(fā)消息,實現(xiàn)了基本的聊天功能,適合需要在項目中實現(xiàn)實時通訊功能的開發(fā)者參考

一、導(dǎo)入依賴

<!--    父依賴 -->
  <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轉(zhuǎn)換器   -->
    <dependency>
      <groupId>com.alibaba</groupId>
      <artifactId>fastjson</artifactId>
      <version>1.2.83</version>
    </dependency>
  </dependencies>

二、導(dǎo)入配置類

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;
@Configuration
public class WebSocketConfig {
    /**
     *   創(chuàng)建 websocket 的服務(wù)器
     */
    @Bean
    public ServerEndpointExporter serverEndpointExporter(){
        return new ServerEndpointExporter();
    }
}

三、創(chuàng)建傳遞消息的實體

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
@AllArgsConstructor
@NoArgsConstructor
@Builder
@Data
public class Message {
    /**
     * 消息的發(fā)送者
     */
    private String sender;
    /**
     * 消息的接收者
     */
    private String receiver;
    /**
     * 消息的內(nèi)容
     */
    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<>();
    /**
     * 當(dāng)前用戶的名稱
     */
    private String name;
    /**
     * 本地會話
     */
    private Session session;
    /**
     *  建立新的鏈接時調(diào)用
     */
    @OnOpen
    public void onOpen(@PathParam("name")String name, Session session){
        //  判斷名稱是否使用了關(guān)鍵字
        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 + "名稱已經(jīng)被使用，請重新取名");
            try {
                session.close();
            } catch (IOException e) {
                throw new RuntimeException(e);
            }
            return;
        }
        this.name = name;
        this.session = session;
        //  記錄當(dāng)前用戶
        clients.put(name, this);
        // 歡迎新用戶
        String msg = "歡迎用戶 '" + name + "' 來到小陽交友平臺"+"\t在線人數(shù)為：" + clients.size() + "\n" + "請選擇你要發(fā)送的好友：\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發(fā)送給所有人) content 的格式發(fā)送消息\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("發(fā)生錯誤" + error.getMessage());
    }
    @OnMessage
    public void onMessage(String message,Session session){
        Message userMessage = JSON.parseObject(message, Message.class);
        //  判斷該消息是發(fā)給誰的
        if (userMessage.getReceiver().equals("all")){
            // 發(fā)給所有人
            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));
    }
}

五、創(chuàng)建客戶端

如果你的項目指定了端口，記得把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 {
    //  運行處理消息服務(wù)器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("客戶端與服務(wù)端建立連接");
                }
                @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("客戶端與服務(wù)端斷開連接");
                    System.exit(0);
                }
                @Override
                public void onError(Exception e) {
                    System.out.println("服務(wù)端發(fā)生錯誤");
                }
            };
            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));
        }
    }
}