在Java中实现WebSocket是一项非常棒的技术，可以实现实时双向通信。下面我们将通过一个简单的示例来展示如何在Java中实现WebSocket。我们将使用Java EE的javax.websocket包，这个包是WebSocket API的一部分。
什么是WebSocket？
WebSocket是一种网络通信协议，提供了全双工通信通道，允许服务器和客户端之间进行实时数据传输。与传统的HTTP协议不同，WebSocket在建立连接后，可以保持连接状态，因此适合需要实时数据交换的应用，比如在线聊天、股票监控等场景。
环境准备
在开始之前，请确保您已经设置好了Java开发环境以及以下库： - Java EE 7 或更高版本 - Maven（可选但推荐）
为了方便演示，我们将创建一个简单的WebSocket服务器和客户端。
创建WebSocket服务器
首先，我们需要创建一个WebSocket服务器。使用@ServerEndpoint注解可以很容易地创建一个WebSocket服务端点。
import javax.websocket.OnClose;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.concurrent.CopyOnWriteArraySet;
@ServerEndpoint("/websocket")
public class WebSocketServer {
private static int onlineCount = 0; // 记录在线人数
private static CopyOnWriteArraySet<WebSocketServer> webSocketSet = new CopyOnWriteArraySet<>(); // 用于存储每一个客户端对应的WebSocketServer对象
private Session session;
@OnOpen
public void onOpen(Session session) {
this.session = session;
webSocketSet.add(this); // 将新连接的客户端添加到集合中
addOnlineCount(); // 在线人数加1
System.out.println("有新连接加入！当前在线人数为：" + getOnlineCount());
}
@OnMessage
public void onMessage(String message, Session session) throws IOException {
System.out.println("来自客户端的消息：" + message);
// 将消息通知给所有客户端
for (WebSocketServer webSocket : webSocketSet) {
webSocket.sendMessage(message);
}
}
@OnClose
public void onClose() {
webSocketSet.remove(this); // 连接关闭时，从集合中移除
subOnlineCount(); // 在线人数减1
System.out.println("有一连接关闭！当前在线人数为：" + getOnlineCount());
}
public void sendMessage(String message) throws IOException {
this.session.getBasicRemote().sendText(message);
}
public static synchronized int getOnlineCount() {
return onlineCount;
}
public static synchronized void addOnlineCount() {
WebSocketServer.onlineCount++;
}
public static synchronized void subOnlineCount() {
WebSocketServer.onlineCount--;
}
}
部署WebSocket服务器
WebSocket服务器端需要在一个Java EE容器中运行，如Apache Tomcat或Jetty。我们需要创建一个web.xml文件，以确保WebSocket能够正常工作。以下是一个示例：
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
version="3.1">
<servlet>
<servlet-name>WebSocket</servlet-name>
<servlet-class>org.eclipse.jetty.websocket.server.WebSocketServerContainer</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>WebSocket</servlet-name>
<url-pattern>/websocket</url-pattern>
</servlet-mapping>
</web-app>
创建WebSocket客户端
接下来，我们创建一个简单的HTML页面来作为WebSocket客户端。HTML页面可以通过JavaScript与WebSocket服务器进行通信。
<!DOCTYPE html>
<html>
<head>
<title>WebSocket Example</title>
</head>
<body>
<h1>WebSocket客户端</h1>
<input type="text" id="message" placeholder="请输入消息"/>
<button id="send">发送</button>
<ul id="messages"></ul>
<script>
var ws = new WebSocket("ws://localhost:8080/your-context-path/websocket");
ws.onopen = function() {
console.log("连接已打开");
};
ws.onmessage = function(event) {
var messagesList = document.getElementById("messages");
var li = document.createElement("li");
li.appendChild(document.createTextNode(event.data));
messagesList.appendChild(li);
};
document.getElementById("send").onclick = function() {
var messageInput = document.getElementById("message");
ws.send(messageInput.value);
messageInput.value = '';
};
</script>
</body>
</html>
运行与测试
- 将WebSocket服务器代码和HTML文件放入你的Java EE项目中。
- 启动你的Java EE容器（如Tomcat）。
- 访问HTML页面，打开多个浏览器选项卡以模拟多个客户端。
- 输入消息，观察如何在所有客户端之间即时更新。
小结
通过以上示例，我们基本完成了一个基于Java的WebSocket服务器和客户端的实现。WebSocket以其高效的双向通信能力，适用于需要实时交互的场景。希望这个简单的示例能够帮助您更好地理解和实现WebSocket。
