《项目Github地址》:https://github.com/jingzhanwu/flutter_jstomp
《项目pub地址》:https://pub.dev/packages/jstomp
之前项目上有使用到Stomp协议封装的websocket,端上使用订阅通道的形式,支持ws与http,支持订阅多个通道, JStomp是我基于当前项目中的使用和总结开发的一个FLutter 插件,一般中小型的项目中有消息推送,IM等业务场 景增加进入,下面具体看一下怎么接入。
一、提供的能力
1、支持ws方式连接
2、支持http方式连接
3、支持连接时的自定义验证参数,如token等
4、支持同时订阅多个点对点通道
5、支持同时订阅多个广播通道
6、提供连接、消息、发送等回调监听
7、支持发送消息时的自定义消息头
8、JStomp为单例设计,避免多次初始化和订阅
9、可不手动断开连接,程序重新进入重新初始化处理,不会多次订阅
10、轻量级接入,使用简单
11、自动管理心跳,无需使用者自己发送心跳维持长连接
12、支持AndroidX
13、连接失败或者断开连接后默认重试15分钟,重试间隔10秒
二、使用
1、引用
当前稳定版本为1.1.0,具体版本可以不pub官网地址:https://pub.dev/packages/jstomp
2、stomp初始化,JStomp类本身是单例,
获取JStomp实例对象,或者直接使用JStomp.instance,或者JStomp()都是可以
String userId = "1044521635390701569";
///初始化连接url
String url =
"ws://192.168.1.222:9999/message/websocket?personId=" + userId;
///开始初始化,参数senUrl:为发送消息的url
bool b =
await stomp.init(url: url, sendUrl: "/groupMessage/sendMessage");
初始化成功会返回true,失败则false,根据初始化结果做下面的几部操作
3、打开stomp连接
if (b) {
///打开stomp连接
await stomp.connection((open) {
///连接成功打开回调
print("连接打开了...$open");
}, onError: (error) {
///打开错误回调
print("连接打开错误了...$error");
}, onClosed: (closed) {
///连接关闭时回调
print("连接打开错误了...$closed");
});
}
有三个回调方法,可以在对应的回调方法中处理相应的逻辑:
open:连接打开成功时回调,参数为bool类型,值为true或者false
error:打开连接错误时回调,参数为String类型,表示错误信息
closed:连接关闭时回调,参数为bool类型,值为true或者false
4、订阅消息通道,可以订阅点对点或者广播通道,都支持同时订阅多个地址
///点对点订阅地址
final String p2p = "/groupMessage/" + userId;
///开始订阅点对点通道
await stomp.subscribP2P([p2p]);
///订阅广播通道
await stomp.subscribBroadcast(["广播通道1...", "广播通道2..."]);
5 、添加消息监听器,在消息监听器中监听消息的接收
///添加消息监听器
await stomp.onMessageCallback((message) {
///点对点消息回调
print("收到p2p新消息:" + message.toString());
}, onBroadCast: (cast) {
///广播消息回调
print("收到新广播消息:" + cast.toString());
});
回调过来的参数message和cast是一个json格式的字符串,根据返回的结果进行解析即可。
6、添加消息发送监听器,发送消息结果回调
///添加发送消息监听器
await stomp.onSendCallback((status, sendMsg) {
///消息发送结果回调,不管发送失败还是成功都会回调,
///参数 status:代表发送状态,是个枚举类型
print("消息发送完毕:$status :msg=" + sendMsg.toString());
});
同样的回调结果的sendMsg为json格式的字符串。
7、发送消息
///
/// 发送消息
///
Future<String> sendMsg() async {
///构造消息体,这里为一个Map
Map<String, dynamic> msg = {
"content": "flutter消息",
"createId": "1143077861691756546",
"createName": "牛不二",
"createTime": "2019-06-27 17:03:51",
"id": "1046324312976343042",
"microGroupId": "1143049991384731649",
"microGroupName": "flutter讨论群",
"type": 0
};
///stomp消息头,默认不需要,这里自定义一个
Map<String, dynamic> head = {
"userId": "p123456",
"token": "MgjkjkdIdkkDkkjkfdjfdkjfk",
};
///开始发送
return await stomp.sendMessage(json.encode(msg), header: head);
}
发送消息的方法为:sendMessage(),包含两个参数,第一个参数是必选参数,为消息体(json格式字串);第二个参数为可选参数,根据业务需要可以自定义stomp头,比如token,user验证等。
8、stomp断开连接,并销毁资源
///
/// 断开连接,并销毁资源
///
Future<bool> _destroy() async {
if (stomp == null) {
return true;
}
bool b = await stomp.destroy();
stomp = null;
return b;
}
destroy方法不但会断开stomp的连接,停止stomp服务,并且会销毁stomp的客户端与相关资源,所以一般是在程序退出或者确定要销毁服务的地方调用。
《Flutter 中sqlite使用》:https://blog.csdn.net/qq_19979101/article/details/93030803
《Flutter 状态管理之Redux》:https://blog.csdn.net/qq_19979101/article/details/92645385