uniapp使用uni自带websocket进行即时通讯

最近再办一个uniapp做的即时通讯,把其中思路记载一下。

技术栈采用uniapp+uview+vue2进行开发。

一、使用uni封装好的websocket。

下面的从uniapp官网截图的Api

 uni.connectSocket() :这个方法可以让我们创建一个webSocket的连接,里面包含几个参数,url是写ws的连接地址,没有的话肯定是连接不上服务器,其他的没用过。用的时候再看。

// 创建webSocket
this.webSocketTask = uni.connectSocket({
	url: '这里面写的是连接地址',
	header: {
	    'content-type': 'application/json'
	},
	success(res) {
		console.log('成功', res);
	},
})

我们在data中定义一个webSocket:null,然后把websocket对象赋给他,以供下面的方法使用。

 uni.onSocketOpen()是用来监听websocket连接成功的事件,方法里面跟一个回调函数,可以通过res参数拿到响应头。

//监听WebSocket连接打开事件
this.webSocketTask.onOpen((res) => {
	console.info("监听WebSocket连接打开事件", res)
});

 这个没用过,过!!!

 通过uni.onSocketMessag()可以接收到服务器返回的消息。

//接收websocket消息及处理
this.webSocketTask.onMessage((res) => {
	let data = JSON.parse(res.data);
//判断服务器返回的type类型
	switch (data.type){
		//如果返回的ping,说明服务端ping客户端
		case 'ping':
            //我们要给服务器说一个pong告诉服务器我还活着
			this.webSocketTask.send({
				data: JSON.stringify({
					type: 'pong'
				})
			});
			break;
		//登录更新用户列表
        //如果type是init,说明服务器知道我们活着,给我们传一个标识,我们通过这个标识去请求接口,                            
          建立唯一链接。
		case 'init':
			uni.setStorageSync('client_id', data.client_id);
			this.$u.post('common/pub/bindUid',{
				client_id: data.client_id,
				user_id: this.userId
			}).then(res => {
				this.webSocketTask.send({
					data: JSON.stringify({
						type: 'bindUid',
						user_id:2
					})
				});
			});
			break;
		case 'simple':
			this.userList.push(data.data)
			this.scrollToBottom()
			break;
		case 'group':
			this.userList.push(data.data)
			this.scrollToBottom()
			break
	}

这个的话按官方文档说的就是需要卸载uni。onSocketOpen回调里面才行。但是我直接通过实例对象发也可以。

this.webSocketTask.send({
	data: JSON.stringify({type: 'pong'})
});

注意:websocket只能接收字符串,记得转换类型

这个就是关闭连接,写在onUnload钩子中就行

onUnload(){
	uni.closeSocket({
		success:() => {
			console.info("退出成功")
		},
	})
},

 最后一个就是监听websocket是否关闭。

uniapp官网文档:uni.connectSocket(OBJECT) | uni-app官网 (dcloud.net.cn)https://uniapp.dcloud.net.cn/api/request/websocket.html

uni-app官网 (dcloud.net.cn)https://uniapp.dcloud.net.cn/api/request/socket-task.html完整代码:

onLoad(){
    this.socket()
};


methods:{
    socket(){
    //创建webSocket
    this.webSocketTask = uni.connectSocket({
	    url: 'ws地址',
		header: {
			'content-type': 'application/json'
		},
		success(res) {
			console.log('成功', res);
		},
	})

	// 监听WebSocket连接打开事件
	this.webSocketTask.onOpen((res) => {
		console.info("监听WebSocket连接打开事件", res)
	});

	// 监听WebSocket错误
	uni.onSocketError((res) => {
		console.info("监听WebSocket错误" + res)
	});
}

onShow(){
    // 接收websocket消息及处理
    this.webSocketTask.onMessage((res) => {
		let data = JSON.parse(res.data);
		switch (data.type) {
			// 服务端ping客户端
			case 'ping':
				this.webSocketTask.send({
					data: JSON.stringify({
						type: 'pong'
					})
				});
				break;
			// 登录 更新用户列表
			case 'init':
				uni.setStorageSync('client_id', data.client_id);
				this.$u.post('接口', {
					client_id: data.client_id,
					user_id: this.userId
				}).then(res => {
					this.webSocketTask.send({
						data: JSON.stringify({
							type: 'bindUid',
							user_id: this.userId
						})
					});
				});
				break;
			case 'simple':
				this.userList.push(data.data)
				this.scrollToBottom()
				break;
			case 'group':
				// this.groupMenuList()
				this.userList.push(data.data)
				this.scrollToBottom()
				break
		}

	});
}

onUnload() {
	uni.closeSocket({
		success: () => {
			console.info("退出成功")
		},
	})
},

只是个人简单记录!!!

### 实现 UniApp 中的 WebSocket 通信 #### 创建 WebSocket 连接 为了在 UniApp 页面中建立 WebSocket 连接,可以利用 `uni.connectSocket` 方法,在页面加载时即启动此过程。当尝试连接至指定 URL 的 WebSocket 服务端点时,如果操作成功,则会触发成功的回调函数;反之则执行错误处理逻辑[^2]。 ```javascript // 在页面 onLoad 或 created 生命周期内调用 connectSocket 方法 uni.connectSocket({ url: 'wss://your-websocket-server.com', success() { console.log('WebSocket连接已成功建立'); }, fail(err) { console.error('WebSocket连接遇到问题:', err); } }); ``` #### 处理消息接收 对于实时数据交互而言,监听来自服务器的消息至关重要。这可通过设置 `onMessage` 回调来完成,每当有新消息传入时都会激活它,并允许开发者对接收到的信息做进一步处理[^1]。 ```javascript // 设置 onMessage 监听器用于捕获并响应从服务器发来的信息 this.socketTask.onMessage(function(res){ const receivedData = res.data; // 对获取的数据进行解析和展示更新等操作... }); ``` #### 断开 WebSocket 连接 考虑到资源的有效管理和用户体验优化,适时关闭不再需要的 WebSocket 链接显得尤为重要。为此可借助于 `close` 函数实现这一目标。 ```javascript // 关闭当前 WebSocket 连接 if (this.socketTask) { this.socketTask.close(); } ``` #### 使用混入模块简化状态管理 针对较为复杂的场景下频繁开启/关闭 WebSockets 及其关联的状态跟踪需求,构建一个专门负责这些工作的 Vue 混入可能是明智的选择。这样不仅有助于保持代码整洁度,还能促进功能复用性提升[^3]。 ```javascript const websocketMixin = { data(){ return { socketOpen: false, socketMsgQueue:[] }; }, methods:{ initWebsocket(){ /* 初始化逻辑 */}, sendSocketMessage(msg){/* 发送消息 */} } }; export default websocketMixin; ```
评论 11
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值