Java中實現WebSocket方法詳解

更新時間：2023年07月19日 08:37:07 作者：硬件人某某某

這篇文章主要介紹了Java中實現WebSocket方法詳解,WebSocket?是一種新型的網絡協(xié)議，它允許客戶端和服務器之間進行雙向通信，可以實現實時數據交互,需要的朋友可以參考下

WebSocket 簡介

WebSocket 是一種新型的網絡協(xié)議，它允許客戶端和服務器之間進行雙向通信，可以實現實時數據交互。

WebSocket 協(xié)議是基于 HTTP 協(xié)議的，使用標準的 TCP 連接，可以在客戶端和服務器之間建立一條持久化的連接，而不需要像 HTTP 協(xié)議那樣每次請求都需要重新建立連接。

WebSocket 協(xié)議的優(yōu)點包括：

實時性：WebSocket 協(xié)議可以在客戶端和服務器之間實現實時數據交互。
性能：WebSocket 協(xié)議使用標準的 TCP 連接，可以在客戶端和服務器之間建立一條持久化的連接，不需要像 HTTP 協(xié)議那樣每次請求都需要重新建立連接。這可以提高網絡性能，并減少網絡帶寬的消耗。
跨域支持：WebSocket 協(xié)議支持跨域請求，可以在不同的域名之間進行數據交互。

Java 中的 WebSocket 實現

Java 中的 WebSocket 實現主要是通過 JSR 356 規(guī)范來實現的，該規(guī)范定義了 Java 中的 WebSocket API，包括客戶端和服務端兩部分。

WebSocket 客戶端

Java 中的 WebSocket 客戶端可以通過 javax.websocket 包中的 Session 類來實現。

以下是一個簡單的 WebSocket 客戶端示例代碼：

@ClientEndpoint
public class MyClient {
    @OnOpen
    public void onOpen(Session session) {
        System.out.println("連接成功");
    }
    @OnMessage
    public void onMessage(String message) {
        System.out.println("收到消息：" + message);
    }
    @OnClose
    public void onClose() {
        System.out.println("連接關閉");
    }
    public static void main(String[] args) throws Exception {
        WebSocketContainer container = ContainerProvider.getWebSocketContainer();
        Session session = container.connectToServer(MyClient.class, URI.create("ws://localhost:8080/websocket"));
        session.getBasicRemote().sendText("Hello, WebSocket");
    }
}

上面的代碼實現了一個簡單的 WebSocket 客戶端，使用 @ClientEndpoint 注解來標識該類是一個 WebSocket 客戶端，使用 @OnOpen、@OnMessage 和 @OnClose 注解來定義客戶端的行為。

可以使用 WebSocketContainer 類來創(chuàng)建一個 WebSocket 客戶端，并使用 Session 類來操作連接。

WebSocket 服務端

Java 中的 WebSocket 服務端可以通過 javax.websocket 包中的 Endpoint 類來實現。以下是一個簡單的 WebSocket 服務端示例代碼：

@ServerEndpoint("/websocket")
public class MyServer {
    @OnOpen
    public void onOpen(Session session) {
        System.out.println("連接成功");
    }
    @OnMessage
    public void onMessage(String message, Session session) throws IOException {
        System.out.println("收到消息：" + message);
        session.getBasicRemote().sendText("你好，客戶端");
    }
    @OnClose
    public void onClose() {
        System.out.println("連接關閉");
    }
    public static void main(String[] args) throws Exception {
        ServerEndpointConfig config = ServerEndpointConfig.Builder.create(MyServer.class, "/websocket").build();
        WebSocketServerContainer container = (WebSocketServerContainer) ContainerProvider.getWebSocketContainer();
        container.addEndpoint(config);
        System.out.println("服務端啟動成功");
        Thread.currentThread().join();
    }
}

上面的代碼實現了一個簡單的 WebSocket 服務端，使用 @ServerEndpoint 注解來標識該類是一個 WebSocket 服務端，使用 @OnOpen、@OnMessage 和 @OnClose 注解來定義服務端的行為?？梢允褂?WebSocketServerContainer 類來創(chuàng)建一個 WebSocket 服務端，并使用 ServerEndpointConfig 類來配置服務端的連接。

WebSocket 實現示例

下面是一個完整的 WebSocket 實現示例，包括客戶端和服務端。該示例實現了一個簡單的聊天室，客戶端可以向服務端發(fā)送消息，并將消息廣播給所有在線用戶。

服務端```java

@ServerEndpoint(“/chat”) 
public class ChatServer { 
private static final Set sessions = Collections.synchronizedSet(new HashSet<>());
@OnOpen
public void onOpen(Session session) {
    System.out.println("新用戶加入");
    sessions.add(session);
}
@OnMessage
public void onMessage(String message, Session session) throws IOException {
    System.out.println("收到消息：" + message);
    broadcast(message);
}
@OnClose
public void onClose(Session session) {
    System.out.println("用戶離開");
    sessions.remove(session);
}
private void broadcast(String message) throws IOException {
    for (Session session : sessions) {
        session.getBasicRemote().sendText(message);
    }
}
public static void main(String[] args) throws Exception {
    ServerEndpointConfig config = ServerEndpointConfig.Builder.create(ChatServer.class, "/chat").build();
    WebSocketServerContainer container = (WebSocketServerContainer) ContainerProvider.getWebSocketContainer();
    container.addEndpoint(config);
    System.out.println("聊天室已啟動");
    Thread.currentThread().join();
    }
}

上面的代碼實現了一個簡單的聊天室，使用 `@ServerEndpoint` 注解來標識該類是一個 WebSocket 服務端，使用 `@OnOpen`、`@OnMessage` 和 `@OnClose` 注解來定義服務端的行為。在 `onOpen` 方法中，將新用戶加入到 `sessions` 集合中，表示該用戶已經加入聊天室。在 `onMessage` 方法中，將收到的消息廣播給所有在線用戶。在 `onClose` 方法中，將離開的用戶從 `sessions` 集合中移除，表示該用戶已經離開聊天室。在 `broadcast` 方法中，將消息廣播給所有在線用戶。
### 客戶端

@ClientEndpoint
public class ChatClient {
    private static final String SERVER_URL = "ws://localhost:8080/chat";
    private static final Scanner scanner = new Scanner(System.in);
    @OnOpen
    public void onOpen(Session session) {
        System.out.println("連接成功");
    }
    @OnMessage
    public void onMessage(String message) {
        System.out.println("收到消息：" + message);
    }
    @OnClose
    public void onClose() {
        System.out.println("連接關閉");
    }
    public static void main(String[] args) throws Exception {
        WebSocketContainer container = ContainerProvider.getWebSocketContainer();
        Session session = container.connectToServer(ChatClient.class, URI.create(SERVER_URL));
        System.out.print("請輸入您的昵稱：");
        String nickname = scanner.nextLine();
        while (true) {
            System.out.print("[" + nickname + "]: ");
            String message = scanner.nextLine();
            session.getBasicRemote().sendText("[" + nickname + "]: " + message);
        }
    }
}

上面的代碼實現了一個簡單的聊天室客戶端，使用 @ClientEndpoint 注解來標識該類是一個 WebSocket 客戶端，使用 @OnOpen、@OnMessage 和 @OnClose 注解來定義客戶端的行為。在 onOpen 方法中，表示連接成功。

在 onMessage 方法中，將收到的消息打印到控制臺。在 onClose 方法中，表示連接關閉。在 main 方法中，使用 WebSocketContainer 類來創(chuàng)建一個 WebSocket 客戶端，并使用 Session 類來操作連接。用戶需要輸入昵稱，并通過控制臺輸入消息發(fā)送給服務端。