Ba-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 服务开启状态 |
开启 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 |
接收消息
属性名 | 类型 | 说明 |
---|---|---|
msg | String | 消息内容 |
发送消息
属性名 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
msg | String | true | ‘’ | 发送消息内容 |
监听 websocket 连接状态
属性名 | 类型 | 说明 |
---|---|---|
websocketStatus | Boolean | websocket 连接状态,true已连接,false已断开 |
获取 websocket 服务开启状态
属性名 | 类型 | 说明 |
---|---|---|
data | obj | 获取的内容,serviceStatus为服务开启状态,websocketStatus为websocket连接状态 |
图片选择插件 Ba-MediaPicker (文档)
图片编辑插件 Ba-ImageEditor (文档)
文件选择插件 Ba-FilePicker (文档)
应用消息通知插件 Ba-Notify(文档)
应用未读角标插件 Ba-Shortcut-Badge (文档)
应用开机自启插件 Ba-Autoboot(文档)
扫码原生插件(毫秒级、支持多码)Ba-Scanner-G(文档)
扫码原生插件 - 新(可任意自定义界面版本;支持连续扫码;支持设置扫码格式)Ba-Scanner(文档)
动态修改状态栏、导航栏背景色、字体颜色插件 Ba-AppBar(文档)
原生sqlite本地数据库管理 Ba-Sqlite(文档)
安卓保活插件(采用多种主流技术) Ba-KeepAlive(文档)
安卓快捷方式(桌面长按app图标) Ba-Shortcut(文档)
自定义图片水印(任意位置) Ba-Watermark(文档)
最接近微信的图片压缩插件 Ba-ImageCompressor(文档)
视频压缩、视频剪辑插件 Ba-VideoCompressor(文档)
动态切换应用图标、名称(如新年、国庆等) Ba-ChangeIcon(文档)
原生Toast弹窗提示(可穿透所有界面) Ba-Toast(文档)
图片涂鸦、画笔 Ba-ImagePaint(文档)
pdf阅读(手势缩放、显示页数) Ba-Pdf(文档)
声音提示、震动提示、语音播报 Ba-Beep(文档)
websocket原生服务(自动重连、心跳检测) Ba-Websocket(文档)