快捷導(dǎo)航

Java?spring?MVC環(huán)境中實(shí)現(xiàn)WebSocket的示例代碼

更新時(shí)間：2023年09月28日 15:28:50 作者：深圳市有德者科技有限公司

這篇文章主要介紹了Java?spring?MVC環(huán)境中實(shí)現(xiàn)WebSocket,本文通過(guò)示例代碼給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下

我們先在項(xiàng)目 pom.xml 中注入websocket依賴(lài)

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

然后我們?cè)?nbsp;配置文件中加一下配置
我這里用的是yml
參考代碼如下

server:
  port: 80
spring:
  cors:
    allowed-origins: "*"
    allowed-headers: "*"
  websocket:
    enabled: true
    endpoint: /ws
    path: /websocket
    max-text-message-size: 256KB
    max-binary-message-size: 256KB

端口 80然后將請(qǐng)求源和請(qǐng)求頭信息設(shè)置為星號(hào) 表示不限制這樣就不會(huì)發(fā)生跨域然后打開(kāi)websocket配置限制信息大小

然后找到啟動(dòng)類(lèi) 目錄下面創(chuàng)建一個(gè) config文件夾用來(lái)寫(xiě)配置文件

然后在這個(gè)目錄下面創(chuàng)建一個(gè) MyWebSocketHandler.java參考代碼如下

import org.springframework.web.socket.CloseStatus;
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.stream.Collectors;

public class MyWebSocketHandler extends TextWebSocketHandler {
    private static final List<WebSocketSession> sessions = new ArrayList<>();

    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        // 建立連接時(shí)觸發(fā)
        sessions.add(session);
        System.out.println(sessions);
    }

    @Override
    protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        System.out.println(session.getId());
        // 處理收到的消息
        String payload = message.getPayload();
        System.out.println(payload);
        System.out.println(sessions);
        List<WebSocketSession> filteredSessions = sessions.stream()
                .filter(item -> session.getId() != item.getId())
                .collect(Collectors.toList());
        for (WebSocketSession webSocketSession : filteredSessions) {
            try {
                webSocketSession.sendMessage(new TextMessage(payload)); // 推送給前端的字符串
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        // ...
    }

    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
        // 關(guān)閉連接時(shí)觸發(fā)
        sessions.remove(session);
    }
}

這個(gè)類(lèi)中寫(xiě)了websocket的基本配置
首先是建立連接時(shí)觸發(fā) afterConnectionEstablished
這個(gè)函數(shù)接收一個(gè)參數(shù) 就是當(dāng)前連進(jìn)來(lái)的web應(yīng)用這個(gè)對(duì)象中就是 web端的url和websocket給的唯一連接id
然后我們用sessions 這個(gè)list集合將連接的信息存起來(lái)

然后handleTextMessage 當(dāng)web端發(fā)來(lái)數(shù)據(jù)時(shí)觸發(fā)
接收兩個(gè)參數(shù) session 告訴我們是誰(shuí)發(fā)的
message 發(fā)來(lái)的信息
我們通過(guò)

String payload = message.getPayload();

接收信息
然后輸出在控制臺(tái)
然后我們通過(guò)filter對(duì)sessions進(jìn)行過(guò)濾
簡(jiǎn)單說(shuō) 條件就是除了發(fā)信息的人其他都過(guò)濾出來(lái)

然后我們通過(guò)

for (WebSocketSession webSocketSession : filteredSessions) {
    try {
        webSocketSession.sendMessage(new TextMessage(payload)); // 推送給前端的字符串
    } catch (IOException e) {
        e.printStackTrace();
    }
}

首先我們循環(huán)過(guò)濾好的list集合
然后一個(gè)一個(gè)的去發(fā)送消息sendMessage
這個(gè)就是連接對(duì)象.sendMessage(new TextMessage(要發(fā)的信息))

然后 afterConnectionClosed 當(dāng)有應(yīng)用斷開(kāi)連接時(shí)觸發(fā) session 告訴你是誰(shuí)斷開(kāi)了

然后我們?cè)谶@個(gè)目錄下創(chuàng)建一個(gè) WebSocketConfig.java
參考代碼如下

import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;
@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(new MyWebSocketHandler(), "/websocket").setAllowedOrigins("*");
    }
}

這里我們實(shí)現(xiàn) WebSocketConfigurer 接口重寫(xiě)registerWebSocketHandlers
調(diào)用我們自己寫(xiě)的 MyWebSocketHandler配置

然后我們啟動(dòng)項(xiàng)目

在寫(xiě)個(gè)vue的WebSocket 來(lái)測(cè)試連接一下

這里我們看到前端建立連接成功

而java控制臺(tái) 也輸出了我們連接對(duì)象的格式一個(gè)連接id 和一個(gè)url

然后這是我的vue代碼

<template>
  <div>
       <input
        type="text"
        v-model="text"
        placeholder="請(qǐng)輸入內(nèi)容"
      ></input>
      <button @click = "sendData">發(fā)送消息</button>
      <div v-for = "(item,index) in list" :key = "index">{{ item }}</div>
  </div>
</template>
<script>
export default {
  data() {
    return {
      ws: null,
      text: "",
      list: []
    };
  },
  methods: {
    sendData() {
        this.ws.send(this.text)
    }
  },
  mounted() {
      this.ws = new WebSocket('ws://localhost/websocket');
      this.ws.onopen = () => {
        console.log('WebSocket連接已建立');
      };
      this.ws.onmessage = (event) => {
        this.list.push(event.data);
      };
      this.ws.onclose = () => {
        console.log('WebSocket連接已關(guān)閉');
      };
      this.ws.onerror = (error) => {
        console.log('WebSocket錯(cuò)誤:', error);
      };
  }
};
</script>

大家可以自己開(kāi)兩個(gè)創(chuàng)建試試這個(gè)聊天效果還是挺好玩的

到此這篇關(guān)于Java spring MVC環(huán)境中實(shí)現(xiàn)WebSocket的文章就介紹到這了,更多相關(guān)java實(shí)現(xiàn)WebSocket內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: