若依(ruoyi)使用websocket推送數(shù)據(jù)到前端

系統(tǒng)基礎(chǔ)框架使用了若依的微服務(wù)版旗唁,接到一個(gè)需求枫吧,一個(gè)大數(shù)據(jù)量的審核任務(wù)的審核進(jìn)度要在頁(yè)面上實(shí)時(shí)展示出來(lái)豆拨≈狈埽基于此需求迅速想到最簡(jiǎn)單粗暴的解決方式:前端定時(shí)輪詢(xún)。但是僅靠前端輪詢(xún)肯定是不靠譜的施禾,因?yàn)槊看握?qǐng)求都是一次Http脚线,會(huì)大量消耗資源,,因此綜合分析后決定使用websocket建立長(zhǎng)連接進(jìn)行數(shù)據(jù)推送的方式弥搞。

以下為簡(jiǎn)單的消息推送示例邮绿,使用時(shí)需要根據(jù)自身業(yè)務(wù)集成具體業(yè)務(wù)實(shí)現(xiàn)。

一攀例、后端改造

1船逮、pom增加websocket依賴(lài)

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

2、配置websocketconfig

@Configuration
@EnableWebSocket
public class WebSocketConfig {

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

}

3肛度、 編寫(xiě)WebSocket服務(wù)類(lèi)

@Component
@ServerEndpoint(value = "/system/websocket")
public class WebSocket {
    private static Map<String , Session> clientMap = new ConcurrentHashMap<>();

    /**
     * 客戶(hù)端與服務(wù)端連接成功
     * @param session
     */
    @OnOpen
    public void onOpen(Session session){
        clientMap.put(session.getId(),session);
    }

    /**
     * 客戶(hù)端與服務(wù)端連接關(guān)閉
     * @param session
     */
    @OnClose
    public void onClose(Session session){
        clientMap.remove(session.getId());
    }

    /**
     * 客戶(hù)端與服務(wù)端連接異常
     * @param error
     * @param session
     */
    @OnError
    public void onError(Throwable error,Session session) {
        error.printStackTrace();
    }

    /**
     * 客戶(hù)端向服務(wù)端發(fā)送消息
     * @param message
     * @throws IOException
     */
    @OnMessage
    public void onMsg(Session session,String message) throws IOException {
        //以下為模擬發(fā)送消息
        sendMessage();
    }

    @Scheduled(cron = "0/10 * * * * ?")
    private void sendMessage(){
        //獲得Map的Key的集合
        Set<String> sessionIdSet = clientMap.keySet();
        // 此處相當(dāng)于一個(gè)廣播操作//迭代Key集合
        for (String sessionId : sessionIdSet) {
            //根據(jù)Key得到value
            Session session = clientMap.get(sessionId);
            //發(fā)送消息給客戶(hù)端傻唾,每10s給前端推送一個(gè)UUI
            session.getAsyncRemote().sendText(IdUtils.simpleUUID());
        }
    }

}

二、前端改造

websocket連接工具類(lèi)

/**
 * 參數(shù)說(shuō)明:
 *  webSocketURL:String    webSocket服務(wù)地址    eg: ws://127.0.0.1:8080/websocket (后端接口若為restful風(fēng)格可以帶參數(shù))
 *  callback:為帶一個(gè)參數(shù)的回調(diào)函數(shù)
 *  message:String 要傳遞的參數(shù)值(不是一個(gè)必要的參數(shù))
 */
export default {
  // 初始化webSocket
  webSocketInit (webSocketURL) { // ws://127.0.0.1:8080/websocket
    this.webSocket = new WebSocket(webSocketURL)
    this.webSocket.onopen = this.onOpenwellback
    this.webSocket.onmessage = this.onMessageCallback
    this.webSocket.onerror = this.onErrorCallback
    this.webSocket.onclose = this.onCloseCallback
  },

  // 自定義回調(diào)函數(shù)
  setOpenCallback (callback) { //  與服務(wù)端連接打開(kāi)回調(diào)函數(shù)
    this.webSocket.onopen = callback
  },
  setMessageCallback (callback) { //  與服務(wù)端發(fā)送消息回調(diào)函數(shù)
    this.webSocket.onmessage = callback
  },
  setErrorCallback (callback) { //  與服務(wù)端連接異吵泄ⅲ回調(diào)函數(shù)
    this.webSocket.onerror = callback
  },
  setCloseCallback (callback) { //  與服務(wù)端連接關(guān)閉回調(diào)函數(shù)
    this.webSocket.onclose = callback
  },

  close () { // 關(guān)閉連接
    this.webSocket.close()
  },
  sendMessage (message) { // 發(fā)送消息函數(shù)
    this.webSocket.send(message)
  }
}

2、示例頁(yè)面

<template>
  <div>
    <el-button type="primary" @click="sendMessage">發(fā)送消息</el-button>
    <el-button type="primary" @click="closeMessage">關(guān)閉消息</el-button>
    <p v-for="(content, index) in text">{{index}}.{{ content }}</p>
  </div>
</template>
<script>
import websocket from '@/api/websocket'
import request from '@/utils/request'
export default {
  name: "WebSocketDemo",
  data () {
    return {
      text: [],
      webSocketObject: null
    }
  },
  created() {
    websocket.webSocketInit('ws://localhost:9250/system/websocket')
    websocket.setOpenCallback(res => {
      console.log('建立連接成功',res);
    })
    websocket.setMessageCallback(res => {
      this.text.push(res.data) ;
      console.log('發(fā)送消息成功',res);
    })
    websocket.setErrorCallback(res => {
      console.log('接收失敗消息',res);
    })
    websocket.setCloseCallback(res => {
      console.log('連接關(guān)閉',res);
    })
    websocket.setCloseCallback(res => {
      console.log('連接關(guān)閉',res);
    })

  },
  methods: {
    sendMessage () {
      // 使用websocket交互
      // websocket.sendMessage("123");
      // 常規(guī)接口伪煤,通過(guò)http交互
      request({
        url : '/system/websocket/send?msg=123',
        method : 'post'
      }).then((res) => {
          this.text.push(res.data) ;
          console.log(this.text)
      })
    },

//關(guān)閉websocket連接(若后臺(tái)依然有定時(shí)任務(wù)加袋,建議使用http的方式刪除后臺(tái)的定時(shí)任務(wù)執(zhí)行)
    closeMessage(){
      websocket.close()
    }
  }
}
</script>

三、示例效果

定時(shí)推送uuid并在頁(yè)面展示抱既,可根據(jù)實(shí)際業(yè)務(wù)职烧,修改為返回需要的審核狀態(tài)即可。


image.png

其他大佬推薦可以使用MQTT、comet(長(zhǎng)輪詢(xún))蚀之、SSE(長(zhǎng)連接)等方式實(shí)現(xiàn)以上需求蝗敢,待有時(shí)間再做一篇各種方式的對(duì)比。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末足删,一起剝皮案震驚了整個(gè)濱河市寿谴,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌失受,老刑警劉巖讶泰,帶你破解...
    沈念sama閱讀 207,113評(píng)論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異拂到,居然都是意外死亡痪署,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,644評(píng)論 2 381
  • 文/潘曉璐 我一進(jìn)店門(mén)兄旬,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)狼犯,“玉大人,你說(shuō)我怎么就攤上這事领铐」纪酰” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 153,340評(píng)論 0 344
  • 文/不壞的土叔 我叫張陵罐孝,是天一觀的道長(zhǎng)呐馆。 經(jīng)常有香客問(wèn)我,道長(zhǎng)莲兢,這世上最難降的妖魔是什么汹来? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 55,449評(píng)論 1 279
  • 正文 為了忘掉前任,我火速辦了婚禮改艇,結(jié)果婚禮上收班,老公的妹妹穿的比我還像新娘。我一直安慰自己谒兄,他們只是感情好摔桦,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,445評(píng)論 5 374
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著承疲,像睡著了一般邻耕。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上燕鸽,一...
    開(kāi)封第一講書(shū)人閱讀 49,166評(píng)論 1 284
  • 那天兄世,我揣著相機(jī)與錄音,去河邊找鬼啊研。 笑死御滩,一個(gè)胖子當(dāng)著我的面吹牛鸥拧,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播削解,決...
    沈念sama閱讀 38,442評(píng)論 3 401
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼富弦,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了氛驮?” 一聲冷哼從身側(cè)響起腕柜,我...
    開(kāi)封第一講書(shū)人閱讀 37,105評(píng)論 0 261
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎柳爽,沒(méi)想到半個(gè)月后媳握,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,601評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡磷脯,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,066評(píng)論 2 325
  • 正文 我和宋清朗相戀三年蛾找,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片赵誓。...
    茶點(diǎn)故事閱讀 38,161評(píng)論 1 334
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡打毛,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出俩功,到底是詐尸還是另有隱情幻枉,我是刑警寧澤,帶...
    沈念sama閱讀 33,792評(píng)論 4 323
  • 正文 年R本政府宣布诡蜓,位于F島的核電站熬甫,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏蔓罚。R本人自食惡果不足惜椿肩,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,351評(píng)論 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望豺谈。 院中可真熱鬧郑象,春花似錦、人聲如沸茬末。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 30,352評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)丽惭。三九已至击奶,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間吐根,已是汗流浹背正歼。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 31,584評(píng)論 1 261
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留拷橘,地道東北人局义。 一個(gè)月前我還...
    沈念sama閱讀 45,618評(píng)論 2 355
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像冗疮,于是被迫代替她去往敵國(guó)和親萄唇。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,916評(píng)論 2 344

推薦閱讀更多精彩內(nèi)容