快捷導(dǎo)航

springboot整合websocket實(shí)現(xiàn)群聊思路代碼詳解

更新時(shí)間：2021年05月28日 15:05:11 作者：叁滴水

通過(guò)springboot引入websocket，實(shí)現(xiàn)群聊，通過(guò)在線websocket測(cè)試進(jìn)行展示。本文重點(diǎn)給大家介紹springboot整合websocket實(shí)現(xiàn)群聊功能，代碼超級(jí)簡(jiǎn)單，感興趣的朋友跟隨小編一起學(xué)習(xí)吧

實(shí)現(xiàn)思路

發(fā)送者向服務(wù)器發(fā)送大家早上好。其它客戶(hù)端可以收到對(duì)應(yīng)消息。

項(xiàng)目展示

通過(guò)springboot引入websocket，實(shí)現(xiàn)群聊，通過(guò)在線websocket測(cè)試進(jìn)行展示。

核心代碼

pom引入jar

<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.10.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.12</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-websocket</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.62</version>
        </dependency>
    </dependencies>

使用springboot 2.3.10.RELEASE版本；java8

WebSocketConfig配置類(lèi)

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

websocket有4個(gè)注解，解釋如下

@OnOpen 有新連接
@OnMessage 有新消息時(shí)
@OnClose 關(guān)閉連接
@OnError 連接異常

對(duì)于這個(gè)4個(gè)注解，配置在方法上即可。

WebsocketServerEndpoint接收類(lèi)

@Slf4j
@Controller
@ServerEndpoint ("/")
public class WebsocketServerEndpoint
{
   @OnOpen
   public void onOpen(Session session, EndpointConfig config) {
      log.info("[onOpen][session({}) 接入]", session);
      WebSocketUtil.broadcast (session.getId ()+"上線了");
      WebSocketUtil.addSession (session);
   }
   @OnMessage
   public void onMessage(Session session, String message) {
      WebSocketUtil.broadcast (message);
      log.info("[onOpen][session({}) 接收到一條消息({})]", session, message); // 生產(chǎn)環(huán)境下，請(qǐng)?jiān)O(shè)置成 debug 級(jí)別
   }
   @OnClose
   public void onClose(Session session, CloseReason closeReason) {
      WebSocketUtil.removeSession (session);
      WebSocketUtil.broadcast (session.getId ()+"下線了");
      log.info("[onClose][session({}) 連接關(guān)閉。關(guān)閉原因是({})}]", session, closeReason);
   }
   @OnError
   public void onError(Session session, Throwable throwable) {
      log.info("[onClose][session({}) 發(fā)生異常]", session, throwable);
   }
}

WebSocketUtil工具類(lèi)

@Slf4j
public class WebSocketUtil
{


    // ========== 會(huì)話(huà)相關(guān) ==========

    /**
     * Session 與用戶(hù)的映射
     */
    private static final Map<String, Session> SESSION_USER_MAP = new ConcurrentHashMap<> ();

    /**
     * 添加 Session 。在這個(gè)方法中，會(huì)添加用戶(hù)和 Session 之間的映射
     *
     * @param session Session
     */
    public static void addSession(Session session) {
        // 更新 SESSION_USER_MAP
        SESSION_USER_MAP.put(session.getId (), session);
    }

    /**
     * 移除 Session 。
     *
     * @param session Session
     */
    public static void removeSession(Session session) {
        // 從 SESSION_USER_MAP 中移除
          SESSION_USER_MAP.remove(session.getId ());

    }

    // ========== 消息相關(guān) ==========

    /**
     * 廣播發(fā)送消息給所有在線用戶(hù)
     *
     * @param message 消息體
     * @param <T> 消息類(lèi)型
     */
    public static <T extends Message> void broadcast(String message) {
        // 創(chuàng)建消息
//        String messageText = buildTextMessage(type, message);
        // 遍歷 SESSION_USER_MAP ，進(jìn)行逐個(gè)發(fā)送
        for (String sessionId : SESSION_USER_MAP.keySet()) {
            sendTextMessage(SESSION_USER_MAP.get (sessionId), message);
        }
    }

    /**
     * 發(fā)送消息給單個(gè)用戶(hù)的 Session
     *
     * @param session Session
     * @param type 消息類(lèi)型
     * @param message 消息體
     * @param <T> 消息類(lèi)型
     */
    public static <T extends Message> void send(Session session, String type, T message) {
        // 創(chuàng)建消息
        String messageText = buildTextMessage(type, message);
        // 遍歷給單個(gè) Session ，進(jìn)行逐個(gè)發(fā)送
        sendTextMessage(session, messageText);
    }


    /**
     * 構(gòu)建完整的消息
     *
     * @param type 消息類(lèi)型
     * @param message 消息體
     * @param <T> 消息類(lèi)型
     * @return 消息
     */
    private static <T extends Message> String buildTextMessage(String type, T message) {
        JSONObject messageObject = new JSONObject();
        messageObject.put("type", type);
        messageObject.put("body", message);
        return messageObject.toString();
    }

    /**
     * 真正發(fā)送消息
     *
     * @param session Session
     * @param messageText 消息
     */
    private static void sendTextMessage(Session session, String messageText) {
        if (session == null) {
            log.error("[sendTextMessage][session 為 null]");
            return;
        }
        RemoteEndpoint.Basic basic = session.getBasicRemote();
        if (basic == null) {
            log.error("[sendTextMessage][session 的  為 null]");
            return;
        }
        try {
            basic.sendText(messageText);
        } catch (IOException e) {
            log.error("[sendTextMessage][session({}) 發(fā)送消息{}) 發(fā)生異常",
                    session, messageText, e);
        }
    }

}

在線websocket調(diào)試輸入ws://localhost:8080/即可。

以上就是springboot整合websocket實(shí)現(xiàn)群聊思路代碼詳解的詳細(xì)內(nèi)容，更多關(guān)于springboot整合websocket的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: