Spring Boot WebSocket：构建实时通信应用程序
各位看官，大家好！今天咱们聊聊一个能让你的应用程序瞬间“活”起来的技术——WebSocket。想象一下，你的网页应用不再需要吭哧吭哧地轮询服务器，才能知道发生了什么，而是像有千里眼顺风耳一样，服务器主动推送消息过来，实时更新，是不是感觉瞬间高大上了？
而 Spring Boot，这个开发界的瑞士军刀，为我们提供了构建 WebSocket 应用的利器。所以，今天我们就来深入浅出地聊聊如何用 Spring Boot 玩转 WebSocket，打造一个实时通信应用程序。
一、WebSocket 究竟是个啥？
在深入代码之前，我们先来简单了解一下 WebSocket。 传统的 HTTP 协议是“请求-响应”模式，客户端发起请求，服务器响应请求，一次请求对应一次响应。 如果客户端需要实时获取服务器的信息，就不得不使用轮询或者长连接等技术。 轮询就是客户端定时向服务器发送请求，询问是否有新的数据。 长连接则是在客户端和服务器之间建立一个长期的连接，服务器有新的数据就通过这个连接推送给客户端。
WebSocket 协议的出现，就是为了解决 HTTP 协议在实时通信方面的不足。 它是一种全双工通信协议，允许客户端和服务器之间进行双向数据传输。 也就是说，客户端和服务器都可以主动向对方发送消息，而不需要像 HTTP 协议那样必须由客户端发起请求。
你可以把 HTTP 协议比作送信，每次都要写信、装信封、贴邮票，然后邮递员才能把信送到。 而 WebSocket 就像是直接拉了一条电话线，想说什么直接说，省去了很多麻烦。
WebSocket 的优点：
- 实时性高: 服务器可以主动推送消息，无需客户端轮询。
- 双向通信: 客户端和服务器可以互相发送消息。
- 开销小: 只需要建立一次连接，后续通信开销小。
二、Spring Boot 对 WebSocket 的支持
Spring Boot 提供了强大的 WebSocket 支持，简化了 WebSocket 应用的开发。 通过 Spring Boot，我们可以轻松地创建 WebSocket 服务端和客户端。
Spring Boot WebSocket 的核心组件：
@ServerEndpoint: 用于标注一个类为 WebSocket 服务端。@ClientEndpoint: 用于标注一个类为 WebSocket 客户端。javax.websocket.Session: 表示一个 WebSocket 会话，用于发送和接收消息。TextMessage和BinaryMessage: 分别表示文本消息和二进制消息。
三、构建一个简单的 WebSocket 服务端
接下来，我们就用 Spring Boot 来创建一个简单的 WebSocket 服务端。 我们的目标是创建一个简单的聊天室，客户端可以连接到服务端，发送消息，服务端会将消息广播给所有连接的客户端。
1. 添加依赖
首先，我们需要在 pom.xml 文件中添加 WebSocket 的依赖。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>2. 创建 WebSocket 服务端
创建一个名为 WebSocketServer 的类，并使用 @ServerEndpoint 注解将其标注为 WebSocket 服务端。 @ServerEndpoint 注解需要指定一个 URI，用于客户端连接到服务端。
import org.springframework.stereotype.Component;
import javax.websocket.*;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.concurrent.CopyOnWriteArraySet;
@ServerEndpoint("/chat")
@Component
public class WebSocketServer {
//concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。
private static CopyOnWriteArraySet<WebSocketServer> webSocketSet = new CopyOnWriteArraySet<>();
//与某个客户端的连接会话，需要通过它来给客户端发送数据
private Session session;
/**
* 连接建立成功调用的方法*/
@OnOpen
public void onOpen(Session session) {
this.session = session;
webSocketSet.add(this); //加入set中
System.out.println("有新连接加入！当前在线人数为" + webSocketSet.size());
try {
sendMessage("欢迎加入聊天室！");
} catch (IOException e) {
System.out.println("IO异常");
}
}
/**
* 连接关闭调用的方法
*/
@OnClose
public void onClose() {
webSocketSet.remove(this); //从set中删除
System.out.println("有一连接关闭！当前在线人数为" + webSocketSet.size());
}
/**
* 收到客户端消息后调用的方法
*
* @param message 客户端发送过来的消息*/
@OnMessage
public void onMessage(String message, Session session) {
System.out.println("收到来自客户端的消息:" + message);
//群发消息
for (WebSocketServer item : webSocketSet) {
try {
item.sendMessage(message);
} catch (IOException e) {
e.printStackTrace();
}
}
}
/**
* 发生错误时调用
*
* @param session
* @param error
*/
@OnError
public void onError(Session session, Throwable error) {
System.out.println("发生错误");
error.printStackTrace();
}
/**
* 这个方法与上面几个方法不一样。没有用注解，是根据自己需要添加的方法。
* @param message
* @throws IOException
*/
public void sendMessage(String message) throws IOException {
this.session.getBasicRemote().sendText(message);
//this.session.getAsyncRemote().sendText(message);
}
/**
* 群发自定义消息
* */
public static void sendInfo(String message) throws IOException {
for (WebSocketServer item : webSocketSet) {
try {
item.sendMessage(message);
} catch (IOException e) {
continue;
}
}
}
public static synchronized int getOnlineCount() {
return webSocketSet.size();
}
}代码解释：
@ServerEndpoint("/chat"): 指定 WebSocket 服务端的 URI 为/chat。 客户端可以通过ws://localhost:8080/chat连接到服务端。@Component: 将WebSocketServer类注册为 Spring Bean，方便 Spring 管理。webSocketSet: 用于存储所有连接到服务端的 WebSocket 连接。 使用CopyOnWriteArraySet保证线程安全。session: 表示一个 WebSocket 会话，用于发送和接收消息。@OnOpen: 当客户端连接到服务端时，该方法会被调用。 我们可以在该方法中记录客户端连接信息，并发送欢迎消息。@OnClose: 当客户端断开连接时，该方法会被调用。 我们可以在该方法中移除客户端连接信息。@OnMessage: 当服务端收到客户端发送的消息时，该方法会被调用。 我们可以在该方法中处理客户端发送的消息，并将消息广播给所有连接的客户端。@OnError: 当发生错误时，该方法会被调用。 我们可以在该方法中处理错误信息。sendMessage(String message): 用于向客户端发送消息。sendInfo(String message): 用于向所有客户端广播消息。getOnlineCount(): 用于获取当前在线人数。
3. 编写 Spring Boot 启动类
创建一个 Spring Boot 启动类，用于启动 Spring Boot 应用。
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class WebSocketApplication {
public static void main(String[] args) {
SpringApplication.run(WebSocketApplication.class, args);
}
}4. 配置 WebSocket
在 Spring Boot 中，我们需要配置 WebSocket。 我们可以通过 @EnableWebSocket 注解来启用 WebSocket。 但是，Spring Boot 已经默认启用了 WebSocket，所以我们不需要手动添加 @EnableWebSocket 注解。
5. 运行应用
运行 Spring Boot 应用，WebSocket 服务端就会启动。
四、编写 WebSocket 客户端
接下来，我们需要编写一个 WebSocket 客户端，用于连接到服务端，并发送和接收消息。 为了方便测试，我们可以使用 JavaScript 编写一个简单的 WebSocket 客户端。
1. 创建 HTML 页面
创建一个名为 index.html 的 HTML 页面。
<!DOCTYPE html>
<html>
<head>
<title>WebSocket Chat</title>
</head>
<body>
<h1>WebSocket Chat</h1>
<textarea id="messageArea" rows="10" cols="50" readonly></textarea><br>
<input type="text" id="messageInput" size="50">
<button id="sendButton">Send</button>
<script>
var websocket = new WebSocket("ws://localhost:8080/chat");
websocket.onopen = function(event) {
console.log("Connected to WebSocket server.");
}
websocket.onmessage = function(event) {
var message = event.data;
document.getElementById("messageArea").value += message + "n";
}
websocket.onclose = function(event) {
console.log("Disconnected from WebSocket server.");
}
document.getElementById("sendButton").onclick = function(event) {
var message = document.getElementById("messageInput").value;
websocket.send(message);
document.getElementById("messageInput").value = "";
}
</script>
</body>
</html>代码解释：
new WebSocket("ws://localhost:8080/chat"): 创建 WebSocket 对象，连接到 WebSocket 服务端。 注意，这里的 URI 必须和@ServerEndpoint注解中指定的 URI 一致。websocket.onopen: 当连接建立成功时，该函数会被调用。websocket.onmessage: 当收到服务端发送的消息时，该函数会被调用。 我们将收到的消息显示在messageArea文本框中。websocket.onclose: 当连接断开时，该函数会被调用。document.getElementById("sendButton").onclick: 当点击 "Send" 按钮时，该函数会被调用。 我们将messageInput文本框中的内容发送给服务端。
2. 打开 HTML 页面
使用浏览器打开 index.html 页面。 你可以打开多个浏览器窗口，模拟多个客户端连接到服务端。
3. 测试聊天室
在不同的浏览器窗口中输入消息，点击 "Send" 按钮，你会发现所有浏览器窗口都会收到消息，实现了简单的聊天室功能。
五、更高级的 WebSocket 应用
上面的例子只是一个简单的 WebSocket 应用，我们可以利用 WebSocket 构建更复杂的实时通信应用，例如：
- 实时股票行情: 服务端可以实时推送股票行情数据给客户端，客户端可以实时显示股票行情。
- 在线游戏: 客户端可以通过 WebSocket 连接到游戏服务器，进行实时游戏。
- 在线协作: 多个用户可以通过 WebSocket 连接到协作服务器，进行实时文档编辑、代码编写等。
- 监控系统: 服务端可以实时推送监控数据给客户端，客户端可以实时显示监控数据。
六、WebSocket 的一些坑和注意事项
- 跨域问题: 如果 WebSocket 服务端和客户端不在同一个域名下，可能会出现跨域问题。 可以通过配置 CORS 解决跨域问题。
- 安全问题: WebSocket 连接也需要考虑安全问题。 可以使用 WSS (WebSocket Secure) 协议进行加密通信。
- 性能问题: 如果 WebSocket 连接数量过多，可能会影响服务器性能。 可以使用负载均衡、消息队列等技术来提高服务器性能。
- 连接断开重连: 由于网络不稳定等原因，WebSocket 连接可能会断开。 客户端需要实现自动重连机制。
- 消息格式: WebSocket 消息可以是文本消息或者二进制消息。 需要根据实际需求选择合适的消息格式。 建议使用 JSON 格式来传输结构化数据。
七、总结
WebSocket 是一种强大的实时通信技术，Spring Boot 提供了强大的 WebSocket 支持，简化了 WebSocket 应用的开发。 通过 Spring Boot，我们可以轻松地构建各种实时通信应用。 但是，在使用 WebSocket 时，也需要注意一些坑和注意事项，例如跨域问题、安全问题、性能问题等。
希望本文能够帮助你更好地理解和使用 Spring Boot WebSocket，构建更加优秀的实时通信应用程序。 记住，技术只是工具，真正的价值在于如何利用技术解决实际问题，创造价值。 祝大家编程愉快！