Java中基于netty-socketio的客户端

蔺霄
2023-12-01

websocket是html5最新的规范,主流浏览器均支持,但为了兼容全部浏览器,给程序员提供一致的编程体验,SocketIO将WebSocket、AJAX和其它的通讯方式均封装成了统一的通讯接口。
netty-socketio是一个开源的Socket.io服务器端的一个java实现,基于netty框架,可用于服务端推送消息给客户端。

socketio的服务端可以通过springboot集成netty-socketio进行实现,详细请看大佬相关博客。
socketio的客户端通常采用html的方式实现,通过socket.io.js建立长连接来监听指定事件的数据、请求指定事件的数据。

下面对基于socket.io-client依赖实现netty-socketio的客户端,可以建立长连接并进行通信。
socket.io-client-java项目是从基于JS版本的socket.io迁移过来的,和JS版本有相同的API。
初始化socket:

IO.Options options = new IO.Options();
options.transports = new String[]{"websocket"};
options.reconnectionAttempts = 2;
options.query = "user=" + loginUser;
//失败重连的时间间隔
options.reconnectionDelay = 1000;
//连接超时时间(ms)
options.timeout = 500;			
final Socket socket = IO.socket("http://localhost:9011", options);

其中,Options参数选项如下

参数	含义	备注
path	host、ip后的服务路径	
hostname		
host		
reconnection	重连	boolean
reconnectionAttempts	重连重试次数	
reconnectionDelay	失败重连的时间间隔	
reconnectionDelayMax		
autoConnect	自动连接	
query	url地址query参数格式,向服务端传递初始数据	
timeout	超时	
forceNew	重用连接时强制重新创建	
transportOptions		
transports		transports = [‘polling’, ‘websocket’]
upgrade		
secure		
callFactory		
webSocketFactory		
encoder		
decoder		

1、添加依赖

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

注意:socket.io-client依赖的版本,用最新版本连接失败。
2、socketio的配置类

@Slf4j
public class SocketIo {

    public static Socket socket = null;

    public static void init() {
        // 服务端socket.io连接通信地址
        String url = "http://127.0.0.1:9011";
        try {
            IO.Options options = new IO.Options();
            options.path = "/socket";
            options.transports = new String[]{"websocket","xhr-polling","jsonp-polling"};
            // 失败重试次数
            options.reconnectionAttempts = 3;
            // 失败重连的时间间隔
            options.reconnectionDelay = 1000;
            // 连接超时时间(ms)
            options.timeout = 500;
            //final Socket socket = IO.socket(url + "?userId=2", options);
            socket = IO.socket(url, options);

            // 自定义事件`connect` -> 接收服务端成功连接消息
            socket.on(Socket.EVENT_CONNECT, objects -> log.info("连接成功"));
            // 自定义事件`connecting` -> 接收服务端成功连接消息
            socket.on(Socket.EVENT_CONNECTING, objects -> log.info("连接中:" + Arrays.toString(objects)));
            // 自定义事件`disconnect` -> 接收服务端成功连接消息
            socket.on(Socket.EVENT_DISCONNECT, objects -> log.info("已下线:" + Arrays.toString(objects)));
            // 自定义事件`connect_error` -> 接收服务端成功连接消息
            socket.on(Socket.EVENT_CONNECT_ERROR, objects -> log.info("连接失败" + Arrays.toString(objects)));

            socket.connect();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

3、测试

public static void main(String[] args) {
        // 建立连接
        SocketIo.init();

        // 1主动监听类
        // 自定义事件`event1` -> 接收服务端广播消息
        SocketIo.socket.on("event1", objects -> log.info("收到event1:" + Arrays.toString(objects)));

        // 2主动请求无参类
        // 自定义事件`event2` -> 接收服务端广播消息
        SocketIo.socket.on("event2", objects -> log.info("收到event2:" + Arrays.toString(objects)));
        // 自定义事件提交
        SocketIo.socket.emit("event1");

        // 3主动请求有参类
        // 自定义事件`event3` -> 接收服务端广播消息
        SocketIo.socket.on("event3", objects -> log.info("收到event3:" + Arrays.toString(objects)));
        int i =1;
        while (true) {
            try {
                Thread.sleep(3000);
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
            i++;
            SocketIo.socket.emit("event3", "123", "name");
            System.out.println(i);
        }

    }
 类似资料: