【Java】已解决：UnexpectedFrameException

屿小夏

发布于 2024-07-27 10:48:54

1130

发布于 2024-07-27 10:48:54

文章被收录于专栏：IT杂谈学习

一、分析问题背景

在使用WebSocket进行网络通信时，开发者可能会遇到UnexpectedFrameException报错。此异常通常发生在接收或处理WebSocket帧时，具体场景包括处理非预期类型的帧、帧格式错误等情况。下面是一个典型的代码片段，用于建立一个简单的WebSocket连接：

import java.net.URI;
import java.nio.ByteBuffer;
import java.util.concurrent.CountDownLatch;
import javax.websocket.*;

@ClientEndpoint
public class WebSocketClient {

    private static CountDownLatch latch;

    @OnOpen
    public void onOpen(Session session) {
        System.out.println("Connected to server");
        try {
            session.getBasicRemote().sendText("Hello Server");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    @OnMessage
    public void onMessage(String message) {
        System.out.println("Received message: " + message);
    }

    @OnError
    public void onError(Session session, Throwable throwable) {
        System.out.println("Error occurred: " + throwable.getMessage());
    }

    @OnClose
    public void onClose(Session session, CloseReason closeReason) {
        System.out.println("Session closed: " + closeReason);
        latch.countDown();
    }

    public static void main(String[] args) {
        latch = new CountDownLatch(1);
        WebSocketContainer container = ContainerProvider.getWebSocketContainer();
        try {
            container.connectToServer(WebSocketClient.class, new URI("ws://localhost:8080/websocket"));
            latch.await();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

二、可能出错的原因

导致UnexpectedFrameException报错的原因有多种，常见的包括：

帧类型错误：客户端或服务器发送的帧类型与预期不符，例如发送文本帧时接收方期望的是二进制帧。
数据格式错误：帧中的数据格式不正确，导致解析失败。
协议不一致：客户端和服务器之间的WebSocket协议版本不一致或实现不兼容。

三、错误代码示例

以下是一个可能导致该报错的代码示例，并解释其错误之处：

@ClientEndpoint
public class WebSocketClient {

    @OnMessage
    public void onMessage(ByteBuffer message) {
        // 假设期望接收到的是文本帧，但收到的是二进制帧
        String textMessage = new String(message.array());
        System.out.println("Received message: " + textMessage);
    }
}

错误分析：

帧类型错误：在onMessage方法中，期望接收到的是二进制帧（ByteBuffer），但实际发送的是文本帧（String），导致解析错误。

四、正确代码示例

为了解决该报错问题，我们需要确保帧类型匹配，并正确处理不同类型的帧。以下是正确的代码示例：

@ClientEndpoint
public class WebSocketClient {

    @OnOpen
    public void onOpen(Session session) {
        System.out.println("Connected to server");
        try {
            session.getBasicRemote().sendText("Hello Server");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    @OnMessage
    public void onTextMessage(String message) {
        System.out.println("Received text message: " + message);
    }

    @OnMessage
    public void onBinaryMessage(ByteBuffer message) {
        System.out.println("Received binary message");
    }

    @OnError
    public void onError(Session session, Throwable throwable) {
        System.out.println("Error occurred: " + throwable.getMessage());
    }

    @OnClose
    public void onClose(Session session, CloseReason closeReason) {
        System.out.println("Session closed: " + closeReason);
    }

    public static void main(String[] args) {
        CountDownLatch latch = new CountDownLatch(1);
        WebSocketContainer container = ContainerProvider.getWebSocketContainer();
        try {
            container.connectToServer(WebSocketClient.class, new URI("ws://localhost:8080/websocket"));
            latch.await();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

通过上述代码，我们定义了两个不同的@OnMessage方法来分别处理文本帧和二进制帧，确保帧类型匹配，从而避免UnexpectedFrameException异常。