Socket.IO Java客户端连接JS服务器无输出的原因及解决方法

问题背景 #

我在工作项目中使用Socket.IO搭建测试服务端与客户端，已按官方示例实现可正常运行的JavaScript服务器，搭配JavaScript客户端时服务器能正常输出日志。但改用socket.io-client-java库编写Java客户端后，服务器无任何输出，尝试http和ws协议的地址均无效，需排查原因并解决。

现有代码 #

JavaScript服务端代码

import { Server } from "socket.io";

const io = new Server(3000);

io.on("connection", (socket) => {
  console.log("connection");

  // 向客户端发送消息
  socket.emit("hello from server", 1, "2", { 3: Buffer.from([4]) });

  // 接收客户端消息
  socket.on("hello from client", (...args) => {
    console.log("client says hi");
  });
});

可正常运行的JavaScript客户端代码

import { io } from "socket.io-client";

const socket = io("ws://localhost:3000");

// 向服务端发送消息
socket.emit("hello from client", 5, "6", { 7: Uint8Array.from([8]) });

// 接收服务端消息
socket.on("hello from server", (...args) => {
  // ...
});

无响应的Java客户端代码

// package + imports

public class Main
{
    public static void main(String[] args)
    {
        URI uri = URI.create("http://localhost:3000");
        IO.Options options = IO.Options.builder().build();
        Socket socket = IO.socket(uri, options);

        socket.emit("hello from client", "world");
    }
}

问题原因 #

1. 未主动发起连接：Java客户端创建Socket实例后，必须显式调用connect()方法才会向服务端发起连接请求，原代码直接调用emit时连接尚未建立，消息无法发送到服务端。
2. 缺少连接状态监听：没有监听连接成功、失败等事件，无法确认连接是否建立，也无法排查连接过程中的错误。

解决办法 #

修正Java客户端代码，添加连接触发逻辑和状态监听，确保在连接成功后再发送消息：

// 需导入socket.io-client-java相关包，例如：
// import io.socket.client.IO;
// import io.socket.client.Socket;
// import io.socket.emitter.Emitter;
// import java.net.URI;
// import java.util.Arrays;

public class Main {
    public static void main(String[] args) {
        try {
            URI uri = URI.create("http://localhost:3000");
            IO.Options options = IO.Options.builder().build();
            Socket socket = IO.socket(uri, options);

            // 监听连接成功事件，连接建立后再发送消息
            socket.on(Socket.EVENT_CONNECT, args -> {
                System.out.println("Java客户端已连接");
                socket.emit("hello from client", "world");
            });

            // 接收服务端发送的消息
            socket.on("hello from server", args -> {
                System.out.println("收到服务端消息：" + Arrays.toString(args));
            });

            // 监听连接错误事件，排查连接问题
            socket.on(Socket.EVENT_CONNECT_ERROR, args -> {
                System.err.println("连接失败：" + args[0]);
            });

            // 监听断开连接事件
            socket.on(Socket.EVENT_DISCONNECT, args -> {
                System.out.println("客户端已断开连接");
            });

            // 主动发起连接
            socket.connect();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

额外注意事项 #

• 版本兼容：确保socket.io-client-java的版本与服务端Socket.IO版本匹配，例如服务端为v4.x时，Java客户端建议使用v2.x版本。
• 消息发送时机：所有emit操作必须在EVENT_CONNECT事件触发后执行，否则消息会被客户端丢弃。
• 日志辅助排查：添加各类事件监听（如错误、断开连接），便于快速定位连接或通信过程中的问题。

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