SpringBoot 使用WebSocket功能(實現步驟)
更新時間：2024年02月05日 09:42:18 作者：清山博客
本文通過詳細步驟介紹了SpringBoot 使用WebSocket功能,首先需要導入WebSocket坐標,編寫WebSocket配置類,用于注冊WebSocket的Bean,結合示例代碼給大家介紹的非常詳細,感興趣的朋友跟隨小編一起看看吧
實現步驟：
1.導入WebSocket坐標。
在pom.xml中增加依賴項：
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> </dependency>
2.編寫WebSocket配置類，用于注冊WebSocket的Bean。
package com.rc114.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;
/**
* WebSocket配置類，用于注冊WebSocket的Bean
* @author Administrator
*/
@Configuration
public class WebSocketConfiguration {
@Bean
public ServerEndpointExporter serverEndpointExporter() {
return new ServerEndpointExporter();
}
}3.編寫WebSocketServer類。
package com.rc114.websocket;
import jakarta.websocket.OnClose;
import jakarta.websocket.OnMessage;
import jakarta.websocket.OnOpen;
import jakarta.websocket.Session;
import jakarta.websocket.server.PathParam;
import jakarta.websocket.server.ServerEndpoint;
import org.springframework.stereotype.Component;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
/**
* WebSocket服務
* @author Administrator
*/
@Component // 交給spring容器管理
@ServerEndpoint("/ws/{sid}") // 路徑請求
public class WebSocketServer {
//存放會話對象
private static Map<String, Session> sessionMap = new HashMap();
/**
* 連接建立成功調用的方法
*/
@OnOpen
public void onOpen(Session session, @PathParam("sid") String sid) {
System.out.println("客戶端：" + sid + "建立連接");
sessionMap.put(sid, session);
}
/**
* 收到客戶端消息后調用的方法
*
* @param message 客戶端發(fā)送過來的消息
*/
@OnMessage
public void onMessage(String message, @PathParam("sid") String sid) {
System.out.println("收到來自客戶端：" + sid + "的信息:" + message);
}
/**
* 連接關閉調用的方法
*
* @param sid
*/
@OnClose
public void onClose(@PathParam("sid") String sid) {
System.out.println("連接斷開:" + sid);
sessionMap.remove(sid);
}
/**
* 群發(fā)
*
* @param message
*/
public void sendToAllClient(String message) {
Collection<Session> sessions = sessionMap.values();
for (Session session : sessions) {
try {
//服務器向客戶端發(fā)送消息
session.getBasicRemote().sendText(message);
} catch (Exception e) {
e.printStackTrace();
}
}
}
}4.測試WebSocket
編寫一個測試WebSocket的html頁面：
<html>
<head>
<title>WebSocket測試頁面</title>
<style type="text/css">
* {
font-size: 14px;
line-height: 22px;
}
.main {
border: 0px solid #ccc;
width: 60%;
margin: 0 auto;
padding: 10px;
}
.main-table {
width: 100%;
border: 1px solid #ccc;
border-collapse: collapse;
}
.main-table td {
border: 1px solid #ccc;
padding: 5px;
}
.td-left {
text-align: right;
}
input[type="text"] {
border: 1px solid #ccc;
padding: 5px;
outline: none;
width: 200px;
}
input[type="button"] {
border: 1px solid #ccc;
padding: 3px 10px;
outline: none;
}
.green {
color: green;
}
.red {
color: red;
}
#msg {
font-size: 12px;
line-height: 22px;
}
</style>
</head>
<body>
<div class="main">
<table class="main-table">
<tr>
<td colspan="2" style=" text-align: center;font-weight: bold;">WebSocket測試</td>
</tr>
<tr>
<td style="width: 100px;" class="td-left">服務器地址</td>
<td><input type="text" id="server" value="ws://localhost:8080/ws/"></td>
</tr>
<tr>
<td class="td-left">客戶端名稱</td>
<td><input type="text" id="clientId">
<input type="button" value="隨機生成" onclick="GenerateClientId()" />
</td>
</tr>
<tr>
<td> </td>
<td>
<input type="button" value="連接" onclick="ConnectServer()" />
</td>
</tr>
<tr>
<td class="td-left">連接狀態(tài)</td>
<td> <span id="status"><span class='red'>未連接</span></span></td>
</tr>
<tr>
<td class="td-left">發(fā)送消息</td>
<td>
<input type="text" id="txt">
</td>
</tr>
<tr>
<td> </td>
<td>
<input type="button" value="發(fā)送" onclick="SendMsg()" />
<input type="button" value="清空" onclick="ClearLog()" />
</td>
</tr>
<tr>
<td class="td-left">日志</td>
<td>
<div id="msg"></div>
</td>
</tr>
</table>
<script type="text/javascript">
var websocket = null;
var clientId = "";
//隨機生成客戶端編號
function GenerateClientId() {
clientId = Math.random().toString().substr(2);
document.getElementById("clientId").value = clientId;
}
GenerateClientId();
//連接到服務器
function ConnectServer() {
var clientId = document.getElementById("clientId").value;
if (clientId == "") {
alert("客戶端編號不能為空!");
} else {
if ("WebSocket" in window) {
websocket = new WebSocket("ws://localhost:8080/ws/" + clientId);
websocket.onerror = function () {
ShowMsg("<span class='red'>ERROR</span>");
}
websocket.onopen = function () {
document.getElementById("status").innerHTML = "<span class='green'>已連接</span>";
ShowMsg("<span class='green'>連接成功！</span>");
}
websocket.onmessage = function (event) {
ShowMsg(event.data);
}
websocket.onclose = function () {
ShowMsg("<span class='red'>斷開連接</span>");
}
}
else {
alert("NOT SUPPORT WEBSOCKET!");
}
}
}
//網頁關閉時，斷開鏈接
window.onbeforeunload = function () {
websocket.close();
}
//顯示日志
function ShowMsg(msg) {
document.getElementById("msg").innerHTML += Now() + " " + msg + "<br/>";
}
//發(fā)送消息
function SendMsg() {
var txt = document.getElementById("txt").value;
websocket.send(txt);
ShowMsg("<span class='green'>發(fā)送消息：" + txt + "</span>");
}
//斷開鏈接
function closeWebSocket() {
websocket.close();
}
function Now() {
const date = new Date();
const year = date.getFullYear();
const month = (date.getMonth() + 1).toString().padStart(2, '0');
const day = date.getDate().toString().padStart(2, '0');
const hour = date.getHours().toString().padStart(2, '0');
const minute = date.getMinutes().toString().padStart(2, '0');
const second = date.getSeconds().toString().padStart(2, '0');
const format = year + "-" + month + "-" + day + " " + hour + ":" + minute + ":" + second;
return format;
}
//清空日志
function ClearLog() {
document.getElementById("msg").innerHTML = "";
}
</script>
</div>
</body>
</html>運行效果：
注意：
如果使用了Nginx轉發(fā)請求的，需在Nginx配置WebSocket的轉發(fā)規(guī)則。
到此這篇關于SpringBoot 使用WebSocket功能的文章就介紹到這了,更多相關SpringBoot 使用WebSocket內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
SpringBoot部署到外部Tomcat無法注冊到Nacos服務端的解決思路
這篇文章主要介紹了SpringBoot部署到外部Tomcat無法注冊到Nacos服務端,本文給大家分享完美解決思路，結合實例代碼給大家講解的非常詳細，需要的朋友可以參考下2023-03-03
這篇文章主要介紹了Java調用Shell命令和腳本的實現，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2021-02-02
這篇文章主要給大家介紹了關于java反射之Method的invoke方法的相關資料，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2021-01-01
這篇文章主要介紹了springboot項目如何設置時區(qū)問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2023-07-07
這篇文章主要介紹了IDEA中osgi的開發(fā)應用指南詳解，小編覺得挺不錯的，現在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2019-04-04
這篇文章主要介紹了SpringCloud-OpenFeign組件的使用,本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2020-12-12
這篇文章主要為大家介紹了Mapreduce分布式并行編程使用詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2022-08-08
這篇文章主要介紹了Spring之異步任務@Async，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2023-07-07
RestTemplate Get請求實現bean參數傳遞詳解
RestTemplate 是從 Spring3.0 開始支持的一個 HTTP 請求工具，也有的稱之為網絡框架，說白了就是Java版本的一個postman，這篇文章主要介紹了詳解RestTemplate 用法,需要的朋友可以參考下2022-11-11
本文主要介紹了MyBatis 動態(tài)SQL之where標簽,where 標簽主要用來簡化 SQL 語句中的條件判斷,可以自動處理 AND/OR 條件,下面就來具體介紹一下2024-01-01