如何用Spring Boot替换Node.js Socket客户端连接带认证的Node.js Socket服务端？

1. 引入 Socket.IO Java 客户端依赖 #

Spring Boot 中使用官方的 socket.io-client-java 库对接 Node.js Socket.IO 服务端，在 pom.xml（Maven）中添加以下依赖：

<dependency>
    <groupId>io.socket</groupId>
    <artifactId>socket.io-client</artifactId>
    <version>2.0.1</version>
</dependency>

如果使用 Gradle，添加到 build.gradle：

implementation 'io.socket:socket.io-client:2.0.1'

注意：请确保客户端版本与 Node.js 服务端的 Socket.IO 版本兼容，比如服务端为 4.x 版本时，客户端建议选 2.x 及以上。

2. 配置连接参数并建立连接 #

对应你原 Node.js 客户端的配置，Spring Boot 中通过 IO.Options 设置路径、认证参数等：

import io.socket.client.IO;
import io.socket.client.Socket;
import io.socket.emitter.Emitter;
import java.net.URISyntaxException;
import java.util.HashMap;
import java.util.Map;

@Service
public class SocketIoClientService {

    private Socket socket;

    public void connectToNodeServer() {
        try {
            // 初始化连接选项
            IO.Options options = new IO.Options();
            // 设置 Socket.IO 路径（对应 Node.js 中的 path 参数，仅需路径部分而非完整URL）
            options.path = "/socket.io";
            // 设置认证参数，对应 Node.js 客户端的 auth 对象
            Map<String, Object> auth = new HashMap<>();
            auth.put("username", "username");
            auth.put("token", "abcd");
            options.auth = auth;

            // 建立连接（替换为你的服务端实际地址）
            socket = IO.socket("https://localhost:3000", options);

            // 监听连接成功事件
            socket.on(Socket.EVENT_CONNECT, args -> {
                System.out.println("成功连接到 Node.js Socket.IO 服务端");
                // 连接成功后可发送消息示例
                socket.emit("client-message", "Hello from Spring Boot");
            });

            // 监听断开连接事件
            socket.on(Socket.EVENT_DISCONNECT, args -> System.out.println("与服务端断开连接"));

            // 监听连接错误事件
            socket.on(Socket.EVENT_CONNECT_ERROR, args -> System.out.println("连接错误：" + args[0].toString()));

            // 启动连接
            socket.connect();
        } catch (URISyntaxException e) {
            e.printStackTrace();
        }
    }

    // 可选：提供断开连接的方法
    public void disconnect() {
        if (socket != null && socket.connected()) {
            socket.disconnect();
        }
    }
}

3. 触发连接 #

可以在 Spring Boot 启动时自动建立连接，或者通过接口触发：

import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import javax.annotation.Resource;

@SpringBootApplication
public class SocketClientApplication implements CommandLineRunner {

    @Resource
    private SocketIoClientService socketIoClientService;

    public static void main(String[] args) {
        SpringApplication.run(SocketClientApplication.class, args);
    }

    @Override
    public void run(String... args) throws Exception {
        // 启动时自动建立连接
        socketIoClientService.connectToNodeServer();
    }
}

关键参数说明 #

• path 参数：原 Node.js 客户端中写了完整 URL，这是错误用法，正确的 path 应为 Socket.IO 服务端的路径（默认是 /socket.io），Java 客户端直接设置 options.path = "/socket.io" 即可。
• auth 参数：通过 options.auth 传入 Map 对象，对应 Node.js 客户端的 auth 配置，服务端可通过 socket.handshake.auth 获取这些参数。

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