STOMP 客户端 API 整理
来源:互联网 发布:mac air电脑壁纸 高清 编辑:程序博客网 时间:2024/06/13 06:13
参考教程:http://jmesnil.net/stomp-websocket/doc/
在使用 stomp.js 时,能找到的较完整的 API 说明基本都是英文,中文资料比较少,因此,参考上边的教程做了以下的笔记和总结
介绍
STOMP(Simple Text-Orientated Messaging Protocol) 面向消息的简单文本协议
WebSocket是一个消息架构,不强制使用任何特定的消息协议,它依赖于应用层解释消息的含义;
与处在应用层的HTTP不同,WebSocket处在TCP上非常薄的一层,会将字节流转换为文本/二进制消息,因此,对于实际应用来说,WebSocket的通信形式层级过低,因此,可以在 WebSocket 之上使用 STOMP协议,来为浏览器 和 server间的 通信增加适当的消息语义。
如何理解 STOMP 与 WebSocket 的关系:
1) HTTP协议解决了 web 浏览器发起请求以及 web 服务器响应请求的细节,假设 HTTP 协议 并不存在,只能使用 TCP 套接字来 编写 web 应用,你可能认为这是一件疯狂的事情;
2) 直接使用 WebSocket(SockJS) 就很类似于 使用 TCP 套接字来编写 web 应用,因为没有高层协议,就需要我们定义应用间所发送消息的语义,还需要确保连接的两端都能遵循这些语义;
3) 同 HTTP 在 TCP 套接字上添加请求-响应模型层一样,STOMP 在 WebSocket 之上提供了一个基于帧的线路格式层,用来定义消息语义;
STOMP帧
STOMP帧由命令,一个或多个头信息、一个空行及负载(文本或字节)所组成;
其中可用的COMMAND 包括:
CONNECT、SEND、SUBSCRIBE、UNSUBSCRIBE、BEGIN、COMMIT、ABORT、ACK、NACK、DISCONNECT;
例:
发送消息
SEND
destination:/queue/trade
content-type:application/json
content-length:44
{“action”:”BUY”,”ticker”:”MMM”,”shares”,44}^@
订阅消息
SUBSCRIBE
id:sub-1
destination:/topic/price.stock.*
^@
服务器进行广播消息
MESSAGE
message-id:nxahklf6-1
subscription:sub-1
destination:/topic/price.stock.MMM
{“ticker”:”MMM”,”price”:129.45}^@
客户端 API
引入stomp.js
<script type="application/javascript" src="http://cdn.bootcss.com/stomp.js/2.3.3/stomp.min.js"></script>
发起连接
客户端可以通过使用Stomp.js和sockjs-client连接
// 建立连接对象(还未发起连接)var socket=new SockJS("/spring-websocket-portfolio/portfolio");// 获取 STOMP 子协议的客户端对象var stompClient = Stomp.over(socket);// 向服务器发起websocket连接并发送CONNECT帧stompClient.connect( {},function connectCallback (frame) { // 连接成功时(服务器响应 CONNECTED 帧)的回调方法 document.getElementById("state-info").innerHTML = "连接成功"; console.log('已连接【' + frame + '】'); stompClient.subscribe('/topic/getResponse', function (response) { showResponse(response.body); }); },function errorCallBack (error) { // 连接失败时(服务器响应 ERROR 帧)的回调方法 document.getElementById("state-info").innerHTML = "连接失败"; console.log('连接失败【' + error + '】'); });
说明:
1) socket连接对象也可通过WebSocket(不通过SockJS)连接
var socket=new WebSocket("/spring-websocket-portfolio/portfolio");
2) stompClient.connect()方法签名:
client.connect(headers, connectCallback, errorCallback);
其中
headers表示客户端的认证信息,如:
var headers = { login: 'mylogin', passcode: 'mypasscode', // additional header 'client-id': 'my-client-id'};
若无需认证,直接使用空对象 “{}” 即可;
connectCallback 表示连接成功时(服务器响应 CONNECTED 帧)的回调方法;
errorCallback 表示连接失败时(服务器响应 ERROR 帧)的回调方法,非必须;
断开连接
若要从客户端主动断开连接,可调用 disconnect() 方法
client.disconnect(function () { alert("See you next time!");};
该方法为异步进行,因此包含了回调参数,操作完成时自动回调;
心跳机制
若使用STOMP 1.1 版本,默认开启了心跳检测机制,可通过client对象的heartbeat field进行配置(默认值都是10000 ms):
client.heartbeat.outgoing = 20000; // client will send heartbeats every 20000msclient.heartbeat.incoming = 0; // client does not want to receive heartbeats from the server// The heart-beating is using window.setInterval() to regularly send heart-beats and/or check server heart-beats
发送信息
连接成功后,客户端可使用 send() 方法向服务器发送信息:
client.send(destination url[, headers[, body]]);
其中
destination url 为服务器 controller中 @MessageMapping 中匹配的URL,字符串,必须参数;
headers 为发送信息的header,JavaScript 对象,可选参数;
body 为发送信息的 body,字符串,可选参数;
例:
client.send("/queue/test", {priority: 9}, "Hello, STOMP");client.send("/queue/test", {}, "Hello, STOMP");
订阅、接收信息
STOMP 客户端要想接收来自服务器推送的消息,必须先订阅相应的URL,即发送一个 SUBSCRIBE 帧,然后才能不断接收来自服务器的推送消息;
订阅和接收消息通过 subscribe() 方法实现:
subscribe(destination url, callback[, headers])
其中
destination url 为服务器 @SendTo 匹配的 URL,字符串;
callback 为每次收到服务器推送的消息时的回调方法,该方法包含参数 message;
headers 为附加的headers,JavaScript 对象;什么作用?
该方法返回一个包含了id属性的 JavaScript 对象,可作为 unsubscribe() 方法的参数;
例:
var headers = {ack: 'client', 'selector': "location = 'Europe'"};var callback = function(message) { if (message.body) { alert("got message with body " + message.body) } else { alert("got empty message"); }});var subscription = client.subscribe("/queue/test", callback, headers);
取消订阅
var subscription = client.subscribe(...);subscription.unsubscribe();
JSON 支持
STOMP 帧的 body 必须是 string 类型,若希望接收/发送 json 对象,可通过 JSON.stringify() and JSON.parse() 实现;
例:
var quote = {symbol: 'APPL', value: 195.46};client.send("/topic/stocks", {}, JSON.stringify(quote));client.subcribe("/topic/stocks", function(message) {var quote = JSON.parse(message.body);alert(quote.symbol + " is at " + quote.value);});
事务支持
STOMP 客户端支持在发送消息时用事务进行处理:
举例说明:
// start the transaction// 该方法返回一个包含了事务 id、commit()、abort() 的JavaScript 对象var tx = client.begin();// send the message in a transaction// 最关键的在于要在 headers 对象中加入事务 id,若没有添加,则会直接发送消息,不会以事务进行处理client.send("/queue/test", {transaction: tx.id}, "message in a transaction");// commit the transaction to effectively send the messagetx.commit();// tx.abort();
Debug 信息
STOMP 客户端默认将传输过程中的所有 debug 信息以 console.log() 形式输出到客户端浏览器中,也可通过以下方式输出到 DOM 中:
client.debug = function(str) { // str 参数即为 debug 信息// append the debug log to a #debug div somewhere in the page using JQuery:$("#debug").append(str + "\n");};
认证
这一部分内容看的不是很理解,因此直接将原文放在这里了,待补充。
By default, STOMP messages will be automatically acknowledged by the server before the message is delivered to the client.
The client can chose instead to handle message acknowledgement by subscribing to a destination and specify a ack header set to client or client-individual.
In that case, the client must use the message.ack() method to inform the server that it has acknowledge the message.
var subscription = client.subscribe("/queue/test", function(message) { // do something with the message ... // and acknowledge it message.ack(); }, {ack: 'client'});
The ack() method accepts a headers argument for additional headers to acknowledge the message. For example, it is possible to acknowledge a message as part of a transaction and ask for a receipt when the ACK STOMP frame has effectively be processed by the broker:
var tx = client.begin();
message.ack({ transaction: tx.id, receipt: ‘my-receipt’ });
tx.commit();
The nack() method can also be used to inform STOMP 1.1 brokers that the client did not consume the message. It takes the same arguments than the ack() method.
- STOMP 客户端 API 整理
- STOMP
- delphi Stomp客户端连接 RabbitMQ(1)
- HBase客户端API(整理 修改一下)
- stomp.min.js(stomp协议的客户端脚本)、sockjs.min.js(SockJS的客户端脚本)以及jQuery
- 关于c++(客户端)和JAVA(服务端)的TCP通讯(基于stomp协议)(一)
- 关于c++(客户端)和JAVA(服务端)的TCP通讯(基于stomp协议)(二)
- 关于c++(客户端)和JAVA(服务端)的TCP通讯(基于stomp协议)(三)
- stomp协议
- STOMP Protocol
- stomp与rabbitmq stomp插件
- libevent 客户端,简单整理
- 电话客户端扩展API
- ASPxGridView 客户端API
- Redis C客户端API
- Redis C客户端API
- Photon客户端API
- Memcached客户端API
- java并行程序设计模式
- 第一次写博客
- 前端2017面试题汇总
- MRUnit使用实例
- ubuntu下搭建vpn
- STOMP 客户端 API 整理
- ThinkPHP中View页面 if,switch:case的不同使用
- X-pack破解
- PAT 1053. Path of Equal Weight (30)
- 用Python和Pygame写游戏-从入门到精通(9) Vector2d
- 树莓派3b连接GPS+BD模块并用python获取数据(串口版)
- 数据库连接工具Navicat Premium_11.2.7简体中文版
- CUDA 学习笔记 1
- BZOJ4537:[Hnoi2016]最小公倍数 (分块+并查集+启发式合并)