WebSocket协议详解及代码示例

以你之姓@ 2023-10-11 23:31 24阅读 0赞

## 介绍 ##

WebSocket是一种在Web浏览器和服务器之间进行全双工通信的协议，它提供了一种实时交互的方式，允许服务器主动向客户端推送数据，而不需要客户端不断地发送请求。

以下是WebSocket的一些重要特点和详解：

1.  建立握手：WebSocket协议通过HTTP进行初始握手，使用标准的HTTP请求和响应头部。客户端发送一个特殊的HTTP请求，包含Upgrade头部字段为"websocket"，服务器收到请求后返回一个特殊的HTTP响应，表明连接已升级为WebSocket。
2.  全双工通信：一旦WebSocket连接建立成功，客户端和服务器之间的通信就变为全双工的，双方可以同时发送和接收数据，而不需要依赖于传统的请求-响应模式。
3.  长连接：WebSocket连接会保持持久性，与传统的HTTP请求-响应模式不同，它不会在每次通信后关闭连接。这样可以避免频繁的连接建立和关闭操作，减少网络开销和延迟。
4.  低开销：WebSocket协议使用轻量级的数据帧进行通信，减少了额外的网络开销。相比于HTTP请求-响应模式，WebSocket在数据传输时的开销更小。
5.  数据格式：WebSocket协议支持传输多种数据格式，包括文本数据和二进制数据。可以根据应用的需要选择合适的数据格式。
6.  事件驱动：WebSocket使用事件驱动的模型，可以通过监听事件来处理客户端和服务器之间的消息传递。常见的事件包括连接建立、消息接收、错误发生等。
7.  跨域支持：WebSocket允许在浏览器中进行跨域通信，通过服务器的设置，可以实现不同域之间的实时数据传输。

WebSocket协议的引入使得Web应用程序可以更加实时、高效地进行双向通信，常见的应用包括在线聊天、实时数据展示、协同编辑等。WebSocket不仅可以在Web浏览器中使用，还可以在其他平台和技术栈上进行使用，提供了一种便捷的实时通信机制。

## 代码示例 ##

一个简单的Maven工程结构示例，包含WebSocket服务器和客户端的代码。

首先，创建一个Maven项目，并添加以下依赖项到pom.xml文件中：

<dependencies>
        <dependency>
            <groupId>javax.websocket</groupId>
            <artifactId>javax.websocket-api</artifactId>
            <version>1.1</version>
        </dependency>
        <dependency>
            <groupId>org.glassfish.tyrus</groupId>
            <artifactId>tyrus-server</artifactId>
            <version>1.17</version>
        </dependency>
        <dependency>
            <groupId>org.glassfish.tyrus</groupId>
            <artifactId>tyrus-client</artifactId>
            <version>1.17</version>
        </dependency>
    </dependencies>

接下来，创建一个WebSocket服务器类：

import javax.websocket.*;
    import javax.websocket.server.ServerEndpoint;
    
    @ServerEndpoint("/websocket")
    public class WebSocketServer {
        
    
        @OnOpen
        public void onOpen(Session session) {
        
            System.out.println("WebSocket connection opened: " + session.getId());
        }
    
        @OnMessage
        public void onMessage(String message, Session session) {
        
            System.out.println("Received message from client: " + message);
    
            // 回复消息给客户端
            String replyMessage = "Server received: " + message;
            session.getAsyncRemote().sendText(replyMessage);
        }
    
        @OnClose
        public void onClose(Session session) {
        
            System.out.println("WebSocket connection closed: " + session.getId());
        }
    
        @OnError
        public void onError(Session session, Throwable throwable) {
        
            System.err.println("WebSocket error occurred: " + session.getId());
            throwable.printStackTrace();
        }
    }

上述代码定义了一个WebSocket服务器端，通过@ServerEndpoint注解指定了WebSocket的端点URL为"/websocket"。当有客户端连接到该端点时，onOpen方法会被调用，可以在该方法中执行连接建立后的逻辑。

当客户端发送消息时，onMessage方法会被调用，并传入接收到的消息和与客户端的会话（Session）。在该方法中，可以处理客户端发送的消息，并通过会话的getAsyncRemote().sendText()方法将回复消息发送给客户端。

要运行该WebSocket服务器，可以使用Java WebSocket API的实现，如Tomcat WebSocket或Jetty WebSocket等，将服务器端代码部署到相应的容器中。

在客户端使用WebSocket时，可以使用JavaScript的WebSocket API或其他WebSocket客户端库来连接到该WebSocket服务器，并发送和接收消息。

然后，创建一个WebSocket客户端类：

import javax.websocket.*;
    
    @ClientEndpoint
    public class WebSocketClient {
        
    
        @OnOpen
        public void onOpen(Session session) {
        
            System.out.println("WebSocket connection opened: " + session.getId());
    
            // 发送消息给服务器
            String message = "Hello, Server!";
            session.getAsyncRemote().sendText(message);
        }
    
        @OnMessage
        public void onMessage(String message, Session session) {
        
            System.out.println("Received message from server: " + message);
        }
    
        @OnClose
        public void onClose(Session session) {
        
            System.out.println("WebSocket connection closed: " + session.getId());
        }
    
        @OnError
        public void onError(Session session, Throwable throwable) {
        
            System.err.println("WebSocket error occurred: " + session.getId());
            throwable.printStackTrace();
        }
    }

最后，创建一个启动类来启动WebSocket服务器和客户端：

import org.glassfish.tyrus.server.Server;
    
    public class App {
        
    
        public static void main(String[] args) {
        
            // 启动WebSocket服务器
            Server server = new Server("localhost", 8080, "/websocket", WebSocketServer.class);
            try {
        
                server.start();
                System.out.println("WebSocket server started.");
    
                // 创建WebSocket客户端并连接到服务器
                WebSocketContainer container = ContainerProvider.getWebSocketContainer();
                Session session = container.connectToServer(WebSocketClient.class, URI.create("ws://localhost:8080/websocket"));
            } catch (Exception e) {
        
                e.printStackTrace();
            }
        }
    }

以上代码示例中，WebSocket服务器通过`@ServerEndpoint`注解指定了WebSocket的端点URL为"/websocket"。WebSocket客户端使用`@ClientEndpoint`注解，通过WebSocket容器的`connectToServer()`方法连接到服务器。

请注意，这只是一个简单的示例，WebSocket服务器和客户端在实际应用中可能需要更复杂的逻辑和处理。您可以根据您的实际需求和业务逻辑来扩展和修改这些代码。