更新记录

1.1.2（2021-08-24）

• 解决 * 事件无法监听
• 修正文档

1.1.1（2021-07-17）

修复严重问题，在源码1.1.0中，第46行handlers未被定义，在项目中会导致无法预料的严重问题

1.1.0.0（2021-04-29）

添加插件示例(npm包混入了demo)

平台兼容性

uni.socket 插件API文档

使用

需引入并创建一个socket实例，创建完成后你将得到一个uni.socket对象

import UniSocket from "utils/uni.socket.js"
const socket = new UniSocket({
    url: "wss://127.0.0.1/"
});

参数

方法

on

on方法是一个为uni.socket注册自定义事件的方法，该事件将通过你服务器传回的数据触发，因此，你服务器数据返回的格式必须遵守约定。

socket.on('event', Function(data){
    // .... 在此处理服务器发给你的邮件data          
})

服务器返回的数据必须遵守该格式才能保证正常使用：

{type: 'event', data: {}}

data未必是Object格式，它可以是任意格式，但必须拥有type和data，tyep是服务器与你的约定，它将去使用你注册的事件驱动，也就是说，uni.socket是通过type字段来进行触发你自定义的事件驱动的。

如果你的第三个参数为true，那么uni.socket则会检查该事件驱动是否已被注册，如果未被注册，则将它进行注册，默认false

socket.on('event', Function, true);

off

撤销注册的事件驱动，在uni.socket中，强制每个页面退出、关闭时调用此方法，因为uni.socket无法处理移除页面存在时注册过的事件驱动从而导致的内存泄漏。

socket.off('event', handler);

此方法支持连续注销驱动。

socket.off('event', handler1)('event', handler2)('event', handler3);

例如：

export default {
  methods: {
    hello() {
      ...
    }
    },
    onLoad() {
      socket.on('hello', this.hello);
    },
    onUnload() {
      // 监听页面卸载
      // 页面退出，撤销hello，释放资源
      socket.off('hello', this.hello);
    }
  }

removeEventByName

移除你自定义的事件，因为是危险操作，需要开发者进行二次提交

移除自定义事件包括任何给这个事件注册的驱动

socket.removeEventByName('event').then(commit => {
  commit();
});

addBuffer

给缓存池添加数据

socket.addBuffer({type: 'event', data: {}})

getBuffer

获取缓存池

const buffer = await socket.getBuffer();
// or
socket.getBuffer().then(buffer => {
    //  ...处理你的缓存池
});

getState

获取连接状态0 表示连接中，1表示连接成功，2表示重连中，3表示失败

const state = await socket.getState();
// or
socket.getState().then(state => {
    //  ...处理你状态
});

killApp

结束心跳，心跳结束后，uni.socket除了心跳发送，在下一次发送心跳时间内，其它功能正常使用，需要后端进行处理

socket.killApp();

close

关闭与服务器的连接，注意，它不会触发error事件

socket.close();

emit

给服务器发送消息

socket.emit('event', {msg: "hello world"});

关于心跳

uni.socket需向服务器定时发送一次心跳，其触发的事件为HEARTBEAT，默认心率为60000ms，服务器可根据该事件进行处理，可修改配置进行修改触发事件heartRateType：

new UniSocket({
    url: "wss://127.0.0.1/",
  heartRateType: "Your event name..."
});

关于心跳会触发两次的问题，因为uni.socket发送的时候会触发一次心跳事件，而接收到服务端心跳的时候也会触发一次心跳事件。

系统事件

虽然是系统事件，但它和你自定义的事件并无区别，只是uni.socket赋予了它们特别的使命

使用demo

若你需要查看示例，你需要启动client下的uniapp项目。项目主在main.js中使用uni.socket连接服务器，使用示例在src/pages/index/index.vue中

你如果没有测试服务器代码，你也可以使用node启动server文件夹下的app.js来启动一个WebSocket服务器，它监听了1200端口