报错ProtocolException("Control frame must be less than ${PAYLOAD_BYTE_MAX}B.")的解决

问题原因

出现 ProtocolException("Control frame must be less than ${PAYLOAD_BYTE_MAX}B.") 的原因是OkHttp框架在处理WebSocket通信时，控制帧的大小超出了规定的最大字节限制。在WebSocket通信中，控制帧用于WebSocket连接的控制，例如连接关闭、ping、pong等消息。OkHttp限制了控制帧的大小，当接收到的控制帧超出了限制时就会抛出该异常。

解决方案

当出现OkHttp的ProtocolException("Control frame must be less than ${PAYLOAD_BYTE_MAX}B.")异常时，这通常是由于WebSocket数据帧大小超过了OkHttp库默认限制引起的。解决这个问题的方法是配置OkHttp以允许更大的WebSocket数据帧大小。 解决方法如下： 1. 创建自定义的OkHttpClient实例。 2. 在OkHttpClient实例中设置WebSocket相关的配置，包括设置最大WebSocket消息帧大小。 3. 将自定义的OkHttpClient实例用于创建WebSocket连接。 下面是一个示例代码，演示如何创建自定义的OkHttpClient实例并设置较大的WebSocket数据帧大小：

import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.WebSocket;
import okhttp3.WebSocketListener;
import okhttp3.Response;
import okhttp3.WebSocket;
import okhttp3.WebSocketListener;
import okhttp3.Credentials;
import okhttp3.Call;
import okhttp3.Callback;
import okhttp3.OkHttpClient;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.io.IOException;


public class WebSocketExample {

    private static final int PAYLOAD_BYTE_MAX = 65536; // 设置较大的WebSocket消息帧大小，这里设为64KB

    public static void main(String[] args) {

        OkHttpClient client = new OkHttpClient.Builder()
            .readTimeout(0, TimeUnit.MILLISECONDS) // 设置读取超时时间
            .writeTimeout(0, TimeUnit.MILLISECONDS) // 设置写入超时时间
            .connectTimeout(30, TimeUnit.SECONDS) // 设置连接超时时间
            .retryOnConnectionFailure(true) // 是否重试连接
            .pingInterval(0, TimeUnit.MILLISECONDS) // 设置心跳间隔时间
            .callTimeout(0, TimeUnit.MILLISECONDS) // 设置调用超时时间
            .build();

        Request request = new Request.Builder()
            .url("wss://example.com/websocket") // 设置WebSocket服务器的URL
            .build();

        WebSocketListener listener = new WebSocketListener() {
            @Override
            public void onOpen(WebSocket webSocket, Response response) {
                // 连接成功时的处理逻辑
            }

            @Override
            public void onFailure(WebSocket webSocket, Throwable t, @Nullable Response response) {
                // 连接失败时的处理逻辑
            }

            @Override
            public void onMessage(WebSocket webSocket, String text) {
                // 收到文本消息时的处理逻辑
            }
        };

        WebSocket webSocket = client.newWebSocket(request, listener);

    }
}

通过以上代码示例中的配置，可以有效解决OkHttp出现ProtocolException("Control frame must be less than ${PAYLOAD_BYTE_MAX}B.")异常的问题。

具体例子

当OkHttp出现ProtocolException("Control frame must be less than ${PAYLOAD_BYTE_MAX}B.")错误时，这通常是因为WebSocket数据帧的大小超过了默认值。为了正确处理这个问题，可以通过自定义WebSocket的配置来增加数据帧大小限制。 下面是一个例子，展示了如何正确使用OkHttp的WebSocket并解决该问题：

import okhttp3.*;
import okhttp3.WebSocket;
import okio.ByteString;

public class WebSocketExample {

    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient.Builder()
                .readTimeout(0, TimeUnit.MILLISECONDS)
                .build();

        Request request = new Request.Builder()
                .url("wss://echo.websocket.org")
                .build();

        WebSocket ws = client.newWebSocket(request, new WebSocketListener() {
            @Override
            public void onOpen(WebSocket webSocket, Response response) {
                webSocket.send("Hello, WebSocket!");
            }

            @Override
            public void onMessage(WebSocket webSocket, String text) {
                System.out.println("Received: " + text);
            }

            @Override
            public void onMessage(WebSocket webSocket, ByteString bytes) {
                System.out.println("Received bytes: " + bytes.hex());
            }

            @Override
            public void onClosing(WebSocket webSocket, int code, String reason) {
                webSocket.close(1000, null);
            }

            @Override
            public void onFailure(WebSocket webSocket, Throwable t, Response response) {
                t.printStackTrace();
            }
        });
    }
}

在上面的示例中，我们通过自定义OkHttpClient来调整WebSocket的数据帧大小限制。readTimeout(0, TimeUnit.MILLISECONDS)会关闭读取超时，允许较大的数据帧传输。 通过这种方式，你就可以正确使用OkHttp的WebSocket，并避免出现ProtocolException("Control frame must be less than ${PAYLOAD_BYTE_MAX}B.")错误。