WebSocket 基于OkHttps搭配Stomp实现客户端的监听

简介: WebSocket 基于OkHttps搭配Stomp实现客户端的监听

Stomp

添加依赖

要开启 Stomp 功能,需要添加以下依赖:


Maven

<dependency>
     <groupId>com.ejlchina</groupId>
     <artifactId>okhttps-stomp</artifactId>
     <version>3.4.5</version>
</dependency>

Gradle

implementation 'com.ejlchina:okhttps-stomp:3.4.5'

构建 Stomp 实例

类Stomp提供静态方法over来构建Stomp实例:


over(WHttpTask task) 基于 OkHttps 的 WebSocket 构建一个 Stomp 实例,并自动确认消息

over(WHttpTask task, boolean autoAck) 构建一个 Stomp 实例,并可指定是否自动确认消息

例如:

// 使用一个 Websocket 连接构建一个 Stomp 实例,同时设置心跳间隔为 20 秒
Stomp stomp = Stomp.over(OkHttps.webSocket("wss://...").heatbeat(20, 20));

以上代码构建了一个简单的 Stomp 客户端,并默认在收到消息时会自动确认,如果需要收到确认,可以使用下面的方式:

Stomp stomp = Stomp.over(
        OkHttps.webSocket("wss://...").heatbeat(20, 20),
        false       // 参数设置 autoAck 为 false,将需要手动确认消息
    );

连接 Stomp 服务

得到一个Stomp实例后,可使用以下两个方法连接 Stomp 服务器:


connect() 直接连接 Stomp 服务器

connect(List headers) 携带一些 Stomp 头信息连接 Stomp 服务器

例如:

stomp.connect();

如果服务器在连接时需要指令一些额外信息,比如连接 RabbitMQ 时需要指定login、passcode 和 vhost:

List<Header> headers = new ArrayList<>();
headers.add(new Header("login", "username"));
headers.add(new Header("passcode", "xxxxxxx"));
headers.add(new Header("host", "your_vhost"));
stomp.connect(headers);

连接状态监听

Stomp.over(OkHttps.webSocket("wss://...").heatbeat(20, 20))
    .setOnConnected(stomp -> {
        // 服务器连接成功回调
    })
    .setOnDisconnected(close -> {
        // 连接已断开回调
    })
    .setOnError(msg -> {
        // 错误监听(v2.4.1 新增)
        // 处理服务器发出的 ERROR 帧
    })
    .connect();

另外,你还可以直接使用isConnected()方法类判断连接是否已建立:

// 连接是否已建立
boolean connected = stomp.isConnected();

消息订阅与退订

订阅广播

stomp.topic("/your-topic", (Message msg) -> {
    // 得到消息负载
    String payload = msg.getPayload();
    // 如果需要手动确认消息,调用此方法确认
    stomp.ack(msg)
});

退订广播

stomp.untopic("/your-topic");

订阅队列

stomp.queue("/your-queue", (Message msg) -> {
    // 得到消息负载
    String payload = msg.getPayload();
    // 如果需要手动确认消息,调用此方法确认
    stomp.ack(msg)
});

退订队列

stomp.unqueue("/your-queue");

发送消息

// 发送到广播(since v2.5.0)
stomp.sendToTopic("/your-topic", "Hello World");
// 发送到队列(since v2.5.0)
stomp.sendToQueue("/your-queue", "Hello World");

在 v2.5.0 之前,可以使用以下方式`:


// 发送到广播
stomp.sendTo("/topic/your-topic", "Hello World");
// 发送到队列
stomp.sendTo("/queue/your-queue", "Hello World");

断开服务

stomp.disconnect();

默认的 disconnect 方法会先发送一个 DISCONNECT 消息给服务器,然后等到服务器的确认后再断开连接。这么做的目的是为了确保在真正断开之前,双方已发送的数据尽可能的被对方接收到。


如果由于网络等原因最终导致客户端收不到服务器的确认,那么客户端默认最长等待 10秒,10秒 后无论有无收到确认都会断开连接。当然这个 10 秒也是可以指定的:


// 参数指定客户端等待服务器确认的最大时间,since v3.1.0
stomp.disconnect(int maxWaitSeconds);

如果确实不需要服务器的确认,想直接断开连接,那么可以使用这个方法:

// 参数指定是否立即断开底层连接,since v3.1.0
stomp.disconnect(boolean immediate);
相关文章
|
2月前
|
JavaScript 前端开发 测试技术
前端全栈之路Deno篇(五):如何快速创建 WebSocket 服务端应用 + 客户端应用 - 可能是2025最佳的Websocket全栈实时应用框架
本文介绍了如何使用Deno 2.0快速构建WebSocket全栈应用,包括服务端和客户端的创建。通过一个简单的代码示例,展示了Deno在WebSocket实现中的便捷与强大,无需额外依赖,即可轻松搭建具备基本功能的WebSocket应用。Deno 2.0被认为是最佳的WebSocket全栈应用JS运行时,适合全栈开发者学习和使用。
139 7
|
7月前
|
网络协议 JavaScript 前端开发
WebSocket:实现客户端与服务器实时通信的技术
WebSocket:实现客户端与服务器实时通信的技术
|
7月前
|
存储 设计模式 JavaScript
第六篇 再谈观察者模式的具体应用,如监听一个class其中一个属性,如websocket中onmessage的实现
第六篇 再谈观察者模式的具体应用,如监听一个class其中一个属性,如websocket中onmessage的实现
|
4月前
|
前端开发 NoSQL JavaScript
Websocket 替代方案:如何使用 Firestore 监听实时事件
Websocket 替代方案:如何使用 Firestore 监听实时事件
|
7月前
|
移动开发 网络协议 JavaScript
web客户端websocket
web客户端websocket
165 1
|
7月前
|
JSON Java API
Java 编程问题:十三、HTTP 客户端和 WebSocket API
Java 编程问题:十三、HTTP 客户端和 WebSocket API
305 0
|
网络协议 Go API
php-websocket hyperf/websocket-server/client 客户端和服务器实时双向数据传输
php-websocket hyperf/websocket-server/client 客户端和服务器实时双向数据传输
362 0
|
存储 Java
WebSocket区分不同客户端方法
WebSocket区分不同客户端方法
461 0
使用WebSocket实现服务端和客户端的通信
使用WebSocket实现服务端和客户端的通信
96 0
|
前端开发 安全 Java
SpringBoot + WebSocket+STOMP指定推送消息
本文将简单的描述SpringBoot + WebSocket+STOMP指定推送消息场景,不包含信息安全加密等,请勿用在生产环境。
361 0