mobile wallpaper 1mobile wallpaper 2mobile wallpaper 3mobile wallpaper 4mobile wallpaper 5mobile wallpaper 6
1073 字
3 分钟
Websocket
2025-12-22
无标签

一、为什么需要 WebSocket?#

在传统的 Web 开发中,客户端与服务器之间主要通过 HTTP 协议进行通信。HTTP 是一种请求—响应模型,通信只能由客户端发起,服务器被动响应,这在以下场景中存在明显不足:

  • 实时聊天
  • 消息通知
  • 在线协作
  • 实时数据推送(如订单状态、弹幕)

为了解决“服务器无法主动推送数据”的问题,WebSocket 协议应运而生。

二、什么是 WebSocket?#

WebSocket 是 HTML5 提出的一种全双工通信协议,它在客户端和服务器之间建立一条持久连接,连接建立后,双方可以随时相互发送数据。

WebSocket 的特点#

  • 全双工通信:客户端和服务器可以同时发送消息
  • 长连接:一次握手,持续通信
  • 低延迟:适合实时应用
  • 节省资源:避免频繁创建 HTTP 连接

三、WebSocket 与 HTTP 的对比#

对比项HTTPWebSocket
连接方式短连接长连接
通信方向单向双向
实时性较差很强
适用场景普通网页实时通信

四、Java 中的 WebSocket 实现思路#

Java 提供了标准的 JSR-356(Java WebSocket API),可以通过注解方式快速开发 WebSocket 应用,常见运行环境有:

  • Tomcat
  • Spring Boot(内置 Tomcat)

下面演示一个最简单的 Java WebSocket 服务端实现


1、项目结构概览#

在本示例中,我们使用 Spring Boot 构建后端,并使用 HTML + JavaScript 实现前端 WebSocket 客户端。服务端通过 WebSocket 向客户端发送实时消息,客户端则可以发送消息到服务器。系统还支持服务端定时向客户端推送消息。

项目结构如下:

- src
- main
- java
- com.websocket
- WebSocketServer.java // WebSocket 服务器端
- WebSocketTask.java // 定时任务,向客户端发送消息
- WebSocketConfiguration.java // WebSocket 配置
- resources
- application.properties // Spring Boot 配置文件
- webapp
- index.html // WebSocket 客户端

2、后端代码实现#

1. WebSocketServer.java#

首先,我们需要创建一个 WebSocketServer 类,处理 WebSocket 的连接、消息接收与群发。

package com.websocket;
import javax.websocket.*;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
@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);
}
// 收到客户端消息后调用的方法
@OnMessage
public void onMessage(String message, @PathParam("sid") String sid) {
System.out.println("收到来自客户端:" + sid + "的信息:" + message);
}
// 连接关闭时调用的方法
@OnClose
public void onClose(@PathParam("sid") String sid) {
System.out.println("连接断开:" + sid);
sessionMap.remove(sid);
}
// 群发消息
public void sendToAllClient(String message) {
Collection<Session> sessions = sessionMap.values();
for (Session session : sessions) {
try {
session.getBasicRemote().sendText(message);
} catch (IOException e) {
e.printStackTrace();
}
}
}
}

代码说明:

  • @ServerEndpoint("/ws/{sid}")@ServerEndpoint 注解标记这是 WebSocket 服务器端,{sid} 是客户端的唯一标识符。
  • sessionMap 用于存储所有连接的客户端会话(Session)。
  • @OnOpen@OnMessage@OnClose 用于处理 WebSocket 连接的建立、消息接收与连接关闭。
  • sendToAllClient 方法用于向所有连接的客户端群发消息。

2. WebSocketTask.java#

为了模拟服务端定时向客户端推送消息,我们使用 Spring 的 @Scheduled 注解创建一个定时任务,周期性地向客户端发送消息。

package com.task;
import com.websocket.WebSocketServer;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
@Component
public class WebSocketTask {
@Autowired
private WebSocketServer webSocketServer;
// 每隔5秒向客户端发送消息
@Scheduled(cron = "0/5 * * * * ?")
public void sendMessageToClient() {
String message = "这是来自服务端的消息:" + DateTimeFormatter.ofPattern("HH:mm:ss").format(LocalDateTime.now());
webSocketServer.sendToAllClient(message);
}
}

代码说明:

  • 使用 @Scheduled 注解设定定时任务,每隔 5 秒向客户端发送一条带时间戳的消息。

3. WebSocketConfiguration.java#

为了启用 WebSocket,我们需要配置一个 ServerEndpointExporter,它会自动扫描所有的 @ServerEndpoint 注解并注册 WebSocket 端点。

package com.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;
@Configuration
public class WebSocketConfiguration {
@Bean
public ServerEndpointExporter serverEndpointExporter() {
return new ServerEndpointExporter();
}
}

代码说明:

  • ServerEndpointExporter 是 Spring Boot 提供的自动配置类,负责 WebSocket 端点的注册。

3、前端代码实现#

1. HTML + JavaScript 客户端#

接下来是前端部分,使用 WebSocket 客户端连接服务端,并实现消息发送与接收。

<!DOCTYPE HTML>
<html>
<head>
<meta charset="UTF-8">
<title>WebSocket Demo</title>
</head>
<body>
<input id="text" type="text" />
<button onclick="send()">发送消息</button>
<button onclick="closeWebSocket()">关闭连接</button>
<div id="message">
</div>
</body>
<script type="text/javascript">
var websocket = null;
var clientId = Math.random().toString(36).substr(2); // 生成唯一客户端ID
// 判断当前浏览器是否支持WebSocket
if('WebSocket' in window){
// 连接WebSocket服务器
websocket = new WebSocket("ws://localhost:8080/ws/" + clientId);
} else {
alert('Not support websocket');
}
// 连接发生错误的回调方法
websocket.onerror = function(){
setMessageInnerHTML("error");
};
// 连接成功建立的回调方法
websocket.onopen = function(){
setMessageInnerHTML("连接成功");
}
// 接收到消息的回调方法
websocket.onmessage = function(event){
setMessageInnerHTML(event.data);
}
// 连接关闭的回调方法
websocket.onclose = function(){
setMessageInnerHTML("close");
}
// 监听窗口关闭事件,当窗口关闭时,主动去关闭websocket连接
window.onbeforeunload = function(){
websocket.close();
}
// 将消息显示在网页上
function setMessageInnerHTML(innerHTML){
document.getElementById('message').innerHTML += innerHTML + '<br/>';
}
// 发送消息
function send(){
var message = document.getElementById('text').value;
websocket.send(message);
}
// 关闭连接
function closeWebSocket() {
websocket.close();
}
</script>
</html>

代码说明:

  • WebSocket 对象连接到后端 WebSocket 服务器。
  • onopenonmessageonclose 等回调函数分别处理连接成功、消息接收和连接关闭。
  • 提供了 发送消息关闭连接 的按钮。
  • 消息会实时显示在页面上。

五、运行项目#

  1. 启动 Spring Boot 项目。
  2. 打开浏览器,访问前端 HTML 页面,输入消息并点击 “发送消息” 按钮。
  3. 后端每 5 秒向所有连接的客户端发送消息,客户端实时接收到这些消息。

六、总结#

本文展示了如何使用 Spring BootWebSocket 实现一个简单的实时消息系统。后端使用 @ServerEndpoint 注解提供 WebSocket 服务,前端通过 JavaScript 实现与服务端的实时通信。此外,还通过定时任务向客户端推送消息,增强了实时交互性。

WebSocket 作为一种高效的实时通信协议,在许多实时应用中具有广泛的应用前景。

分享

如果这篇文章对你有帮助,欢迎分享给更多人!

Websocket
https://csa.fur1na.top/posts/websocket/
作者
fur1na
发布于
2025-12-22
许可协议
CC BY-NC-SA 4.0

部分信息可能已经过时

封面
Sample Song
Sample Artist
封面
Sample Song
Sample Artist
0:00 / 0:00