uniapp websocket原生服务（自动重连、心跳检测） Ba-Websocket

最新推荐文章于 2024-05-27 12:07:52 发布

三杯五岳

最新推荐文章于 2024-05-27 12:07:52 发布

阅读量2.6k

点赞数 1

分类专栏： uni-app 文章标签： websocket 长链接原生插件消息 socket

本文链接：https://blog.csdn.net/u013164293/article/details/127987176

版权

uni-app 专栏收录该内容

65 篇文章 27 订阅

订阅专栏

简介（下载地址）

Ba-Websocket 是一款原生websocket服务插件，可在后台运行。支持自动重连、心跳检测；支持常驻通知保活。

支持开启服务、停止服务
支持发送消息、接收消息
支持自动重连、心跳检测
支持常驻通知保活
支持查询服务开启状态
支持监听websocket连接状态
支持多页面订阅消息
支持设置唯一标识，以区分设备

使用方法

引用

在 script 中引入组件

	const websocket = uni.requireNativePlugin('Ba-Websocket')

示例

可在页面 script 中调用（示例参考，可根据自己业务和调用方法自行修改）

<script>
	const websocket = uni.requireNativePlugin('Ba-Websocket')
	export default {
		data() {
			return {
				wsUrl: "ws://你的websocket地址",
				deviceId: "deviceId",
				heartBeatEate: 60,
				msg: '发送的消息',
				msgList: []
			}
		},
		onLoad() {
			this.receiveMsg();
			this.subStatus();
		},
		methods: {
			start() { //开启 websocket 服务
				websocket.start({
					wsUrl: this.wsUrl,//websocket地址
					deviceId: this.deviceId,//唯一标识，用于区分（注意，有值时，websocket的真实请求地址为：wsUrl+'/'+deviceId）
					heartBeatEate: this.heartBeatEate,//心跳，默认3分钟，单位秒
				}, res => {
					console.log(res);
					uni.showToast({
						title: res.msg,
						icon: "none",
						duration: 3000
					})
				});
			},
			stop() { //停止服务
				websocket.stop(res => {
					console.log(res);
					uni.showToast({
						title: res.msg,
						icon: "none",
						duration: 3000
					})
				});
			},
			receiveMsg() { //接收消息
				websocket.receiveMsg(res => {
					console.log(res);
					if (res.ok) {
						this.msgList.unshift(res.msg)
					}
				});
			},
			sendMsg() { //发送消息
				websocket.sendMsg({
					msg: this.msg
				}, res => {
					console.log(res);
					uni.showToast({
						title: res.msg,
						icon: "none",
						duration: 3000
					})
				});
			},
			subStatus() { //监听 websocket 连接状态
				websocket.subStatus(res => {
					console.log(res);
					if (res.ok) {
						let msg = res.msg +
							" service：" + res.serviceStatus +
							"； websocket：" + res.websocketStatus;
						this.msgList.unshift(msg)
					}
				});
			},
			getStatus() { //获取 websocket 服务开启状态
				websocket.getStatus(res => {
					console.log(res);
					if (res.ok) {
						let msg =
							" service：" + res.data.serviceStatus +
							"； websocket：" + res.data.websocketStatus;
						this.msgList.unshift(msg)
					}
				});
			},
		}
	}
</script>

方法清单

名称	说明
start	开启 websocket 服务
stop	停止服务
receiveMsg	接收消息
sendMsg	发送消息
subStatus	监听 websocket 连接状态
getStatus	获取 websocket 服务开启状态

start 方法参数

开启 websocket 服务

属性名	类型	必填	默认值	说明
wsUrl	String	true	‘’	websocket地址
deviceId	String	false	‘’	唯一标识，用于区分（注意，有值时，websocket的真实请求地址为：wsUrl+‘/’+deviceId）
heartBeatEate	Number	false	180	心跳，默认3分钟，单位秒
isNotification	Boolean	false	true	是否开启通知，建议开启，有一定保活作用，默认 true
channelId	String	false	‘com.ba.ws.N1’	通知渠道 id
channelName	String	false	‘WS’	通知渠道 name