Java-WebSocket 开源项目教程
项目介绍
Java-WebSocket 是一个用 100% Java 编写的 WebSocket 客户端和服务器实现。该项目实现了 RFC 6455 和 RFC 7692 协议版本,提供了非阻塞的事件驱动模型,类似于 Web 浏览器的 WebSocket API。
项目快速启动
引入依赖
首先,在你的项目中引入 Java-WebSocket 依赖。如果你使用 Gradle,可以在 build.gradle
文件中添加以下依赖:
implementation 'org.java-websocket:Java-WebSocket:1.5.3'
如果你使用 Maven,可以在 pom.xml
文件中添加以下依赖:
<dependency>
<groupId>org.java-websocket</groupId>
<artifactId>Java-WebSocket</artifactId>
<version>1.5.3</version>
</dependency>
创建 WebSocket 服务器
以下是一个简单的 WebSocket 服务器示例:
import org.java_websocket.WebSocket;
import org.java_websocket.handshake.ClientHandshake;
import org.java_websocket.server.WebSocketServer;
import java.net.InetSocketAddress;
public class MyWebSocketServer extends WebSocketServer {
public MyWebSocketServer(InetSocketAddress address) {
super(address);
}
@Override
public void onOpen(WebSocket conn, ClientHandshake handshake) {
System.out.println("New connection from " + conn.getRemoteSocketAddress());
}
@Override
public void onClose(WebSocket conn, int code, String reason, boolean remote) {
System.out.println("Closed connection to " + conn.getRemoteSocketAddress());
}
@Override
public void onMessage(WebSocket conn, String message) {
System.out.println("Message from " + conn.getRemoteSocketAddress() + ": " + message);
conn.send("Echo: " + message);
}
@Override
public void onError(WebSocket conn, Exception ex) {
ex.printStackTrace();
}
@Override
public void onStart() {
System.out.println("Server started!");
}
public static void main(String[] args) {
MyWebSocketServer server = new MyWebSocketServer(new InetSocketAddress("localhost", 8887));
server.start();
System.out.println("WebSocket server started on ws://localhost:8887");
}
}
创建 WebSocket 客户端
以下是一个简单的 WebSocket 客户端示例:
import org.java_websocket.client.WebSocketClient;
import org.java_websocket.handshake.ServerHandshake;
import java.net.URI;
import java.net.URISyntaxException;
public class MyWebSocketClient extends WebSocketClient {
public MyWebSocketClient(URI serverUri) {
super(serverUri);
}
@Override
public void onOpen(ServerHandshake handshakedata) {
System.out.println("Connected to server");
}
@Override
public void onMessage(String message) {
System.out.println("Received message: " + message);
}
@Override
public void onClose(int code, String reason, boolean remote) {
System.out.println("Disconnected from server");
}
@Override
public void onError(Exception ex) {
ex.printStackTrace();
}
public static void main(String[] args) throws URISyntaxException {
MyWebSocketClient client = new MyWebSocketClient(new URI("ws://localhost:8887"));
client.connect();
}
}
应用案例和最佳实践
应用案例
Java-WebSocket 可以用于构建实时通信应用,如在线聊天系统、实时数据推送服务等。以下是一个简单的在线聊天系统的示例:
- 服务器端:接收客户端消息并广播给所有连接的客户端。
- 客户端:连接到服务器并发送/接收消息。
最佳实践
- 错误处理:在
onError
方法中处理异常,确保服务器和客户端的稳定运行。 - **线