欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

Springboot如何集成websocket

 更新時(shí)間：2024年07月02日 15:30:28   作者：為什么要做囚徒  
這篇文章主要介紹了Springboot如何集成websocket問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教

1. WebSocket概述

我們?cè)偃粘５膚eb應(yīng)用開(kāi)發(fā)過(guò)程中，常見(jiàn)的是前端向后端發(fā)起請(qǐng)求，但有的時(shí)候需要后端主動(dòng)給前端發(fā)送消息，這個(gè)時(shí)候全雙工的websocket即時(shí)通訊就閃亮登場(chǎng)了。

  • 全雙工通訊模式允許雙方同時(shí)進(jìn)行雙向通訊，如手機(jī)通話。
  • 半雙工通訊模式允許雙方交替發(fā)送和接收信息，但不能同時(shí)通訊，如對(duì)講機(jī)。
  • 單工通訊模式只能單向傳輸信息，不能回復(fù)，如廣播電臺(tái)。

2. WebSocket原理

WebSocket是一種在單個(gè)TCP連接上進(jìn)行全雙工通信的協(xié)議。

它通過(guò)一個(gè)簡(jiǎn)單的握手過(guò)程來(lái)建立連接，然后在連接上進(jìn)行雙向數(shù)據(jù)傳輸。

與傳統(tǒng)的HTTP請(qǐng)求不同，WebSocket連接一旦建立，就可以在客戶端和服務(wù)器之間保持打開(kāi)狀態(tài)，直到被任何一方關(guān)閉。

WebSocket協(xié)議的核心特點(diǎn)包括：

  • 全雙工通信：客戶端和服務(wù)器可以同時(shí)發(fā)送和接收消息。
  • 持久連接：一旦建立連接，就可以持續(xù)進(jìn)行數(shù)據(jù)交換，無(wú)需像HTTP那樣頻繁地建立新的連接。
  • 低延遲：由于連接是持久的，數(shù)據(jù)可以幾乎實(shí)時(shí)地發(fā)送和接收。
  • 輕量級(jí)協(xié)議：WebSocket協(xié)議的頭部信息非常簡(jiǎn)單，減少了數(shù)據(jù)傳輸?shù)拈_(kāi)銷(xiāo)。

3. Spring Boot集成WebSocket

在Spring Boot中集成WebSocket非常簡(jiǎn)單，Spring提供了對(duì)WebSocket的原生支持。

以下是一個(gè)基本的集成步驟：

3.1 添加依賴

在pom.xml中添加Spring Boot的WebSocket依賴：

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

3.2 創(chuàng)建WebSocket配置類

創(chuàng)建一個(gè)配置類來(lái)啟用和配置WebSocket：

package com.jiayuan.common.config;

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

/**
 * @Title: WebSocketConfig
 * @Package: com.jiayuan.common.config
 * @Description: websocket配置
 * @Author: xmc
 * @Date: 創(chuàng)建時(shí)間 2024-04-24
 */
@Configuration
public class WebSocketConfig {

    /**
     * 自動(dòng)注冊(cè)使用了@ServerEndpoint注解聲明的Websocket endpoint
     *
     * @return
     */

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

    /**
     * 通信文本消息和二進(jìn)制緩存區(qū)大小
     * 避免對(duì)接 第三方 報(bào)文過(guò)大時(shí)，Websocket 1009 錯(cuò)誤
     *
     * @return
     */

    @Bean
    public ServletServerContainerFactoryBean createWebSocketContainer() {
        ServletServerContainerFactoryBean container = new ServletServerContainerFactoryBean();
        // 在此處設(shè)置bufferSize
        container.setMaxTextMessageBufferSize(10240000);
        container.setMaxBinaryMessageBufferSize(10240000);
        container.setMaxSessionIdleTimeout(15 * 60000L);
        return container;
    }
}

3.3 創(chuàng)建消息處理器

package com.jiayuan.common.config;

import cn.hutool.core.collection.CollectionUtil;
import cn.hutool.extra.spring.SpringUtil;
import cn.hutool.json.JSONUtil;
import com.alibaba.fastjson2.JSON;
import com.alibaba.fastjson2.JSONObject;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
import com.jiayuan.common.redis.RedisCache;
import com.jiayuan.modules.critical.dto.CvRecordExtraDTO;
import com.jiayuan.modules.critical.dto.SyncRecordDTO;
import com.jiayuan.modules.critical.service.CvRecordService;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import javax.annotation.Resource;
import javax.websocket.*;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.ConcurrentHashMap;

/**
 * @Title: WebSocketServer
 * @Package: com.jiayuan.common.config
 * @Description: websocket的服務(wù)端
 * @Author: xmc
 * @Date: 創(chuàng)建時(shí)間 2024-04-24
 */
@Component
@Slf4j
@ServerEndpoint("/api/pushMessage/{userId}")
public class WebSocketServer {

    /**
     * 靜態(tài)變量，用來(lái)記錄當(dāng)前在線連接數(shù)。應(yīng)該把它設(shè)計(jì)成線程安全的。
     */
    private static int onlineCount = 0;
    /**
     * concurrent包的線程安全Set，用來(lái)存放每個(gè)客戶端對(duì)應(yīng)的WebSocket對(duì)象。
     */
    private static ConcurrentHashMap<String, WebSocketServer> webSocketMap = new ConcurrentHashMap<>();
    /**
     * 與某個(gè)客戶端的連接會(huì)話，需要通過(guò)它來(lái)給客戶端發(fā)送數(shù)據(jù)
     */
    private Session session;
    /**
     * 接收userId
     */
    private String userId = "";

    /**
     * 連接建立成
     * 功調(diào)用的方法
     */
    @OnOpen
    public void onOpen(Session session, @PathParam("userId") String userId) {
        this.session = session;
        this.userId = userId;
        if (webSocketMap.containsKey(userId)) {
            webSocketMap.remove(userId);
            //加入set中
            webSocketMap.put(userId, this);
        } else {
            //加入set中
            webSocketMap.put(userId, this);
            //在線數(shù)加1
            addOnlineCount();
        }
        log.info("用戶連接:" + userId + ",當(dāng)前在線人數(shù)為:" + getOnlineCount());
        sendMessage("連接成功");
    }

    /**
     * 連接關(guān)閉
     * 調(diào)用的方法
     */
    @OnClose
    public void onClose() {
        if (webSocketMap.containsKey(userId)) {
            webSocketMap.remove(userId);
            //從set中刪除
            subOnlineCount();
        }
        log.info("用戶退出:" + userId + ",當(dāng)前在線人數(shù)為:" + getOnlineCount());
    }

    /**
     * 收到客戶端消
     * 息后調(diào)用的方法
     *
     * @param message 客戶端發(fā)送過(guò)來(lái)的消息
     **/
    @OnMessage
    public void onMessage(String message, Session session) {
        log.info("用戶消息:" + userId + ",報(bào)文:" + message);
        //可以群發(fā)消息
        //消息保存到數(shù)據(jù)庫(kù)、redis
        if (StringUtils.isNotBlank(message)) {
            try {
                //解析發(fā)送的報(bào)文
                JSONObject jsonObject = JSON.parseObject(message);
                //追加發(fā)送人(防止串改)
                jsonObject.put("fromUserId", this.userId);
                String toUserId = jsonObject.getString("toUserId");
                //傳送給對(duì)應(yīng)toUserId用戶的websocket
                if (StringUtils.isNotBlank(toUserId) && webSocketMap.containsKey(toUserId)) {
                    webSocketMap.get(toUserId).sendMessage(message);
                } else {
                    //否則不在這個(gè)服務(wù)器上，發(fā)送到mysql或者redis
                    log.error("請(qǐng)求的userId:" + toUserId + "不在該服務(wù)器上");
                }
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }


    /**
     * @param session
     * @param error
     */
    @OnError
    public void onError(Session session, Throwable error) {

        log.error("用戶錯(cuò)誤:" + this.userId + ",原因:" + error.getMessage());
        error.printStackTrace();
    }

    /**
     * 實(shí)現(xiàn)服務(wù)
     * 器主動(dòng)推送
     */
    public void sendMessage(String message) {
        try {
            this.session.getBasicRemote().sendText(message);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    /**
     * 發(fā)送自定
     * 義消息
     **/
    public static void sendInfo(String message, String userId) {
        log.info("發(fā)送消息到:" + userId + "，報(bào)文:" + message);
        if (StringUtils.isNotBlank(userId) && webSocketMap.containsKey(userId)) {
            webSocketMap.get(userId).sendMessage(message);
        } else {
            log.error("用戶" + userId + ",不在線！");
        }
    }

    /**
     * 獲得此時(shí)的
     * 在線人數(shù)
     *
     * @return
     */
    public static synchronized int getOnlineCount() {
        return onlineCount;
    }

    /**
     * 在線人
     * 數(shù)加1
     */
    public static synchronized void addOnlineCount() {
        WebSocketServer.onlineCount++;
    }

    /**
     * 在線人
     * 數(shù)減1
     */
    public static synchronized void subOnlineCount() {
        WebSocketServer.onlineCount--;
    }

}

上述代碼可能會(huì)有疑問(wèn)：session和userId兩個(gè)字段是不是安全的？

多人連接，后面的會(huì)不會(huì)覆蓋掉前面session和userId。

答案是不會(huì)的，關(guān)于處理器WebSocketServer我們要明確以下幾點(diǎn)：

  • 1.websocket是原型模式，@ServerEndpoint每次建立雙向通信的時(shí)候都會(huì)創(chuàng)建一個(gè)實(shí)例
  • 2.為什么每次都@OnOpen都要檢查webSocketMap.containsKey(userId) ，實(shí)際使用的時(shí)候發(fā)現(xiàn)偶爾會(huì)出現(xiàn)重連失敗或者其他原因?qū)е轮暗?code>session還存在，這時(shí)候就需要一個(gè)清除動(dòng)作

3.4 服務(wù)器主動(dòng)給客戶端發(fā)送消息

WebSocketServer.sendInfo("服務(wù)器主動(dòng)給客戶端發(fā)送消息test", "zhangsan");

4. 使用ApiPost測(cè)試WebSocket

以下是如何使用ApiPost進(jìn)行測(cè)試的步驟：

1.新建一個(gè)websocket測(cè)試

2.填寫(xiě)URL

ws://localhost:8080/cvms-api/api/pushMessage/3

注意以下幾點(diǎn)：

  • 協(xié)議是ws，加密方式請(qǐng)選擇wss
  • 選擇Raw
  • URL的拼接公式如下
# servlet.context-path 這個(gè)是application.yml中的配置
ws://ip:port//${servlet.context-path}/注解@ServerEndpoint的值
  • 有權(quán)限驗(yàn)證的，比如說(shuō)shiro權(quán)限驗(yàn)證，URL就需要加入白名單
 filterMap.put("/api/pushMessage/*", "anon");

總結(jié)

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

相關(guān)文章

最新評(píng)論