uniapp封装websokcet并全局使用

在使用uniapp开发一个IM即时通讯系统时,需要用到websocket协议,uniapp提供了websocket的api,但是使用还是有点不太方便,在网上查找一番之后发现没有符合自己预期的,因此借鉴网上的并修改成自己想要的。

具体代码如下:
ws.js

//是否已经连接上ws
let isOpenSocket = false
//心跳间隔,单位毫秒
let heartBeatDelay = 3000
let heartBeatInterval = null
//心跳时发送的消息文本
let heartBeatText = "PING"
//最大重连次数
let reconnectTimes = 10
let reconnectInterval = null
//重连间隔,单位毫秒
let reconnectDelay = 3000

let wsUrl = "你的后端wsUrl"

let socketTask = null

//这个参数是防止重连失败之后onClose方法会重复执行reconnect方法,导致重连定时器出问题
//连接并打开之后可重连,且只执行重连方法一次
let canReconnect = false

//封装的对象,最后以模块化向外暴露,
//init方法 初始化socketTask对象
//completeClose方法 完全将socketTask关闭(不重连)
//其他关于socketTask的方法与uniapp的socketTask api一致
let ws = {
	socketTask: null,
	init,
	completeClose
}

function init() {
	socketTask = uni.connectSocket({
		url: wsUrl,
		complete: ()=> {}
	})
	socketTask.onOpen((res) => {
		console.log("ws连接成功")
		clearInterval(heartBeatInterval)
		clearInterval(reconnectInterval)
		isOpenSocket = true
		canReconnect = true
		//开启心跳机制
		heartBeat()
	})
	socketTask.onMessage((res) => {
		//自定义处理onMessage方法
		console.log(res)
	})
	socketTask.onClose(() => {
		if(isOpenSocket){
			console.log("ws与服务器断开")
		}else{
			console.log("连接失败")
		}
		isOpenSocket = false
		if(canReconnect){
			reconnect()
			canReconnect = false
		}
	})
	ws.socketTask = socketTask
}

function heartBeat() {
	heartBeatInterval = setInterval(() => {
		console.log(heartBeatText)
		send(JSON.stringify(heartBeatText));
	}, heartBeatDelay)
}

function send(value) {
	ws.socketTask.send({
		data: value,
		async success() {
			console.log("消息发送成功")
		}
	});
}

function reconnect() {
	//停止发送心跳
	clearInterval(heartBeatInterval)
	//如果不是人为关闭的话,进行重连
	if (!isOpenSocket) {
		let count = 0;
		reconnectInterval = setInterval(() => {
			console.log("正在尝试重连")
			init();
			count++
			//重连一定次数后就不再重连
			if(count >= reconnectTimes){
				clearInterval(reconnectInterval)
				console.log("网络异常或服务器错误")
			}
		}, reconnectDelay)
	}
}
function completeClose(){
	//先将心跳与重连的定时器清除
	clearInterval(heartBeatInterval)
	clearInterval(reconnectInterval)
	canReconnect = false
	ws.socketTask.close()
}

module.exports = ws

使用时在main.js引入并绑定在Vue的prototype上,这样就可以做到全局变量了
main.js

import ws from 'ws.js' //找好自己的路径
Vue.prototype.$ws = ws

这个$ws并不是最终用来操作的对象,$ws内还有一个socketTask对象,并且$ws对象中还有两个方法,init方法用来初始化socketTask,以及completeClose方法,用来彻底关闭websocket连接(不会重连)

当你在某个vue页面需要使用socketTask的话,需要调用$ws.init(),因为已经将ws挂载到Vue上了,所以在vue页面可以使用this.$ws.init()

为什么不是在main.js就把socketTask对象初始化呢?

因为大部分情况下socketTask对象是需要在一定条件下才初始化的,比如在登录之后,才需要使用。而不是一打开APP就去连接后端的websocket服务器了。

当然,如果需要在main.js中把socketTask对象初始化,可以直接在main.js中调用init方法

关于socketTask的api具体可以去uniapp的官方文档找一找https://uniapp.dcloud.io/api/request/websocket

要在uniapp封装WebSocket全局使用,可以按照以下步骤操作: 1. 创建一个WebSocket.js文件,用于封装WebSocket的相关逻辑。在该文件中,可以定义WebSocket的连接、发送和关闭等方法。 ``` export default { socketTask: null, // 连接websocket connect(url) { this.socketTask = uni.connectSocket({ url: url, success: () => { console.log('WebSocket连接成功') } }) this.socketTask.onOpen(() => { console.log('WebSocket连接打开') }) this.socketTask.onMessage((res) => { console.log('WebSocket收到消息', res) }) this.socketTask.onError((res) => { console.log('WebSocket连接错误', res) }) this.socketTask.onClose((res) => { console.log('WebSocket连接关闭', res) }) }, // 发送消息 send(msg) { this.socketTask.send({ data: msg, success: () => { console.log('WebSocket发送消息成功', msg) } }) }, // 关闭连接 close() { this.socketTask.close({ success: () => { console.log('WebSocket连接关闭成功') } }) } } ``` 2. 在main.js中引入WebSocket.js,并将其挂载到Vue原型上,以便在全局使用。 ``` import Vue from 'vue' import App from './App' import WebSocket from './WebSocket' Vue.prototype.$socket = WebSocket Vue.config.productionTip = false App.mpType = 'app' const app = new Vue({ ...App }) app.$mount() ``` 3. 在需要使用WebSocket的页面或组件中,可以通过this.$socket来调用WebSocket的连接、发送和关闭等方法。 ``` export default { created() { this.$socket.connect('ws://localhost:8080') this.$socket.send('Hello, WebSocket!') }, beforeDestroy() { this.$socket.close() } } ``` 这样,我们就可以在uniapp封装WebSocket全局使用了。需要注意的是,WebSocket的连接地址应该根据实际情况进行修改。
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值