OkHttp3 WebSocket onPong方法缺失及Ping/Pong事件处理问询

一、OkHttp3 默认的 Ping/Pong 处理逻辑 #

OkHttp3 对 WebSocket 的 Ping/Pong 机制做了内置封装：

• 当通过 OkHttpClient.Builder().pingInterval(long interval, TimeUnit unit) 设置 Ping 间隔后，OkHttp 会自动定期向服务器发送 Ping 帧，并等待 Pong 响应。
• 若收到服务器发送的 Ping 帧，OkHttp 会自动回复 Pong 帧，无需开发者手动干预。
• 默认情况下，若发送 Ping 后在 readTimeout 时间内未收到 Pong 响应，OkHttp 会判定连接异常，主动关闭 WebSocket 连接。

二、连通异常场景的触发与回调 #

针对不同的连通问题，OkHttp 会通过 WebSocketListener 的回调方法通知开发者：

• 客户端发 Ping，服务器未响应/网络丢包：OkHttp 会在超时后触发 onFailure() 回调，异常类型通常为 SocketTimeoutException；同时 onClosed() 会被调用，传入对应的关闭码和原因。
• 服务器发 Ping，客户端未收到：客户端无法直接感知该事件，服务器会自行检测超时并断开连接，此时客户端会收到 onClosed() 或 onFailure() 回调，具体取决于服务器的断开方式。

三、自定义 Ping/Pong 事件处理逻辑 #

WebSocketListener 提供了 onPing() 和 onPong() 两个空实现方法，开发者可重写这些方法实现自定义逻辑：

1. 捕获并处理 Ping 帧 #

重写 onPing() 方法，可在收到服务器 Ping 时记录日志、发送内部通知：

@Override
public void onPing(WebSocket webSocket, ByteString payload) {
    super.onPing(webSocket, payload);
    // 记录Ping日志
    Log.d("WebSocket", "收到服务器Ping，Payload: " + payload.utf8());
    // 发送内部反馈，比如通过LiveData、EventBus通知上层模块
    // LiveDataBus.getInstance().post("websocket_ping", payload);
}

注意：OkHttp 会自动回复 Pong，无需手动调用 webSocket.sendPong()；若需要自定义 Pong 的 payload，可在此方法中调用该方法覆盖默认行为。

2. 捕获并处理 Pong 帧 #

重写 onPong() 方法，可在收到服务器 Pong 时更新连接状态、记录连通日志：

@Override
public void onPong(WebSocket webSocket, ByteString payload) {
    super.onPong(webSocket, payload);
    // 更新最后活跃时间，用于自定义超时检测
    lastActiveTime = System.currentTimeMillis();
    Log.d("WebSocket", "收到服务器Pong，Payload: " + payload.utf8());
}

3. 自定义 Ping 超时逻辑 #

若不满足 OkHttp 默认的超时规则，可自行维护连接活跃状态并实现超时检测：

public class CustomWebSocketListener extends WebSocketListener {
    private static final int PING_TIMEOUT = 10000; // 自定义10秒超时
    private long lastActiveTime;
    private ScheduledExecutorService scheduler = Executors.newSingleThreadScheduledExecutor();

    @Override
    public void onOpen(WebSocket webSocket, Response response) {
        lastActiveTime = System.currentTimeMillis();
        // 启动定时任务检查超时
        scheduler.scheduleAtFixedRate(() -> {
            if (System.currentTimeMillis() - lastActiveTime > PING_TIMEOUT) {
                // 超时未收到Pong，主动关闭连接
                webSocket.close(1008, "Ping超时");
                scheduler.shutdown();
            }
        }, 0, 1, TimeUnit.SECONDS);
    }

    // 重写onPing、onPong、onFailure等方法...

    @Override
    public void onClosed(WebSocket webSocket, int code, String reason) {
        scheduler.shutdown();
        Log.d("WebSocket", "连接关闭: " + code + ", " + reason);
    }
}

4. 手动发送 Ping 帧 #

除了自动定时 Ping，还可通过 webSocket.sendPing(ByteString payload) 手动触发 Ping，用于特定场景下的连通性检测：

// 主动发送Ping，Payload可选
webSocket.sendPing(ByteString.encodeUtf8("custom_ping_payload"));

内容的提问来源于stack exchange，提问作者DenverCoder