使用uniapp+vuex搞定小程序端Socket服务
48 浏览2025年03月10日作者:zhuguangwei


因为小程序对接入Socket服务的链接有数量限制,所以不能在每个页面去调用。且防止接入过多的相同Socket服务对数据有影响或造成断连,为此可将Socket服务放在store中。

import Vue from 'vue';
import Vuex from 'vuex';
Vue.use(Vuex);

首先新建一个js文件引入Vuex,创建一个全局的Socket服务。

要想开始Socket服务首先得保证Socket服务连接成功。为了防止Socket在不确定因素下断连,可在Socket断开连接或连接异常时,进行重新连接。


也为了防止长时间未收到信息,导致Socket断开,可在连接成功后,加入心跳,每过一段时间(30-60s)发送一次心跳,心跳需要跟后端约定好具体内容。


以下代码是socket服务store文件,可以在页面中监听lastMessage的变化来获取收到的Socket信息。

其中我们可以在页面中调用sendMessage来发送消息,里面用到Promise写法,可方便开发时在发送消息时,拿到消息的发送状态

import Vue from 'vue';
import Vuex from 'vuex';
Vue.use(Vuex);
let heartbeatTimer
let latitude = '';
let longitude = '';
export default new Vuex.Store({
    state: {
        socketTask: null,
        isConnected: false, // 是否连接
        lastMessage: null, // 收到的消息
        reconnectAttempts: 0,  // 新增重连计数器
        heartbeatAttempts: 0, // 心跳次数
    },
    mutations: {
        SET_SOCKET(state, task) {
            state.socketTask = task;
        },
        SET_CONNECTED(state, status) {
            state.isConnected = status;
        },
        SET_MESSAGE(state, msg) {
            state.lastMessage = msg;
        },
        SET_RECONNECT_ATTEMPTS(state, count) {
            state.reconnectAttempts = count
        },
        SET_HEARTBEAT_ATTEMPTS (state, count) {
            state.heartbeatAttempts = count
        },
    },
    actions: {
        initWebSocket({ commit, state }) {
            // 关闭旧连接(防止重复连接)
            if (state.socketTask) {
                state.socketTask.close({})
                commit('SET_SOCKET', null)
            }
            let token = uni.getStorageSync('Authorization');
            if (!token) return;
            const task = uni.connectSocket({
                url:  'wss://********************' , // socket链接
                header: {
                    token: token || '',
                },
                complete: () => console.log('连接初始化完成')
            })
            commit('SET_SOCKET', task)
            // 监听事件
            uni.onSocketOpen(() => {
                commit('SET_CONNECTED', true)
                commit('SET_RECONNECT_ATTEMPTS', 0) // 重置重连计数器
                commit('SET_HEARTBEAT_ATTEMPTS', 0) // 重置心跳计数器
                console.log('WebSocket 连接成功')
                heartbeatTimer = setInterval(() => {
                    this.dispatch('sendMessage', { type: 'heartbeat'});
                }, 30000)
            })
            uni.onSocketMessage(res => {
                commit('SET_MESSAGE', res.data)
                // console.log('收到消息:', res.data)
            })
            uni.onSocketClose(() => {
                commit('SET_CONNECTED', false)
                clearInterval(heartbeatTimer);
                console.log('连接已关闭')
                this.dispatch('handleReconnect') // 触发自动重连
            })
            uni.onSocketError(error => {
                console.error('Socket 错误:', error)
                this.dispatch('handleReconnect')
            })
        },

        // 新增:自动重连(带指数退避)
        handleReconnect({ state, commit, dispatch }) {
            const maxAttempts = 5
            if (state.reconnectAttempts < maxAttempts) {
                const delay = Math.min(1000 * 2 ** state.reconnectAttempts, 10000)
                setTimeout(() => {
                    console.log(`尝试第 ${state.reconnectAttempts + 1} 次重连`)
                    dispatch('initWebSocket')
                    commit('SET_RECONNECT_ATTEMPTS', state.reconnectAttempts + 1)
                }, delay)
            }
        },

        // 新增:发送消息方法
        sendMessage({ state, commit  }, data) {
            return new Promise((resolve, reject) => {
                if (state.isConnected) {
                    uni.sendSocketMessage({
                        data: JSON.stringify(data),
                        success: (res) => {
                            if (data.type && data.type === 'heartbeat') {
                                console.log(`第 ${state.heartbeatAttempts + 1} 次心跳发送成功`, data);
                            } else {
                                console.log('消息发送成功');
                            }
                            commit('SET_HEARTBEAT_ATTEMPTS', state.heartbeatAttempts + 1)
                            resolve(res)
                        },
                        fail: (err) =>{
                            console.error('发送失败', err)
                            reject(err)
                        }
                    })
                } else {
                    console.warn('未连接时尝试发送:', data)
                    reject()
                }
            })
        }
    }
})

在main.js中引入并全局注册

import chatSocket from './store/chatSocket.js';

Vue.prototype.$chatSocket = chatSocket;

在页面中判断socket是否连接,如果没有连接,则调用initWebSocket进行连接

if (!this.$chatSocket.state.isConnected) {
  this.$chatSocket.dispatch('initWebSocket');
}

在页面中,可使用watch来监听socket收到的消息,哪个页面需要监听则哪个页面进行监听,需要在进入页面时调用上面的initWebSocket进行连接

watch: {
  // 监听最新消息
  '$chatSocket.state.lastMessage': {
    handler(newMsg) {
      if (newMsg) {
        this.getMessage(newMsg); // 这里进行获取到消息后的处理
      }
    },
      immediate: true
  },
},

页面中发送消息可调用this.$chatSocket.dispatch('sendMessage')之前在发送消息时,使用Promise,所以我们可以在发送消息后,拿到当前发送消息的状态

this.$chatSocket.dispatch('sendMessage', data).then(res=>{

}).catch(err => {
  
})

对此,整个Socket服务就写好了,有问题欢迎指出。

最后一次编辑于 2025 年 03 月 10 日
共 1 条评论

相关文章

专题推荐

热门文章

热门问答