创建一个 WebSocket 连接。
OBJECT 参数说明：
| 参数名 | 类型 | 必填 | 说明 | 最低版本 |
|---|---|---|---|---|
| url | String | 是 | 开发者服务器接口地址，必须是 wss 协议，且域名必须是后台配置的合法域名 | * |
| header | Object | 否 | HTTP Header , header 中不能设置 Referer | * |
| method | String | 否 | 默认是GET，有效值：OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, CONNECT | * |
| protocols | StringArray | 否 | 子协议数组 | * |
| success | Function | 否 | 接口调用成功的回调函数 | * |
| fail | Function | 否 | 接口调用失败的回调函数 | * |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | * |
示例代码：
uni.connectSocket({ url: 'wss://www.example.com/socket', data: { x: '', y: '' }, header: { 'content-type': 'application/json' }, protocols: ['protocol1'], method: "GET"});
uni.onSocketOpen(CALLBACK)
监听WebSocket连接打开事件。
callback 回调函数：
参数
res
| 属性 | 类型 | 说明 | 支持版本 |
|---|---|---|---|
| header | Object | 连接成功的 HTTP 响应 Header | * |
示例代码：
uni.connectSocket({ url: 'wss://www.example.com/socket'});uni.onSocketOpen(function (res) { console.log('WebSocket连接已打开！');});
uni.onSocketError(CALLBACK)
监听WebSocket错误。
示例代码：
uni.connectSocket({ url: 'wss://www.example.com/socket'});uni.onSocketOpen(function (res) { console.log('WebSocket连接已打开！');});uni.onSocketError(function (res) { console.log('WebSocket连接打开失败，请检查！');});
uni.sendSocketMessage(OBJECT)
通过 WebSocket 连接发送数据，需要先 uni.connectSocket，并在 uni.onSocketOpen 回调之后才能发送。
OBJECT 参数说明：
| 参数名 | 类型 | 必填 | 说明 | 最低版本 |
|---|---|---|---|---|
| data | String/ArrayBuffer | 是 | 需要发送的内容 | * |
| success | Function | 否 | 接口调用成功的回调函数 | * |
| fail | Function | 否 | 接口调用失败的回调函数 | * |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | * |
示例代码：
var socketOpen = false;var socketMsgQueue = []; uni.connectSocket({ url: 'wss://www.example.com/socket'}); uni.onSocketOpen(function (res) { socketOpen = true; for (var i = 0; i < socketMsgQueue.length; i++) { sendSocketMessage(socketMsgQueue[i]); } socketMsgQueue = [];}); function sendSocketMessage(msg) { if (socketOpen) { uni.sendSocketMessage({ data: msg }); } else { socketMsgQueue.push(msg); }}
uni.onSocketMessage(CALLBACK)
监听WebSocket接受到服务器的消息事件。
CALLBACK 返回参数：
| 参数 | 类型 | 说明 |
|---|---|---|
| data | String/ArrayBuffer | 服务器返回的消息 |
示例代码：
uni.connectSocket({ url: 'wss://www.example.com/socket'}); uni.onSocketMessage(function (res) { console.log('收到服务器内容：' + res.data);});
uni.closeSocket(OBJECT)
关闭 WebSocket 连接。
| 参数名 | 类型 | 必填 | 说明 | 最低版本 |
|---|---|---|---|---|
| code | Number | 否 | 一个数字值表示关闭连接的状态号，表示连接被关闭的原因。如果这个参数没有被指定，默认的取值是1000 （表示正常连接关闭） | * |
| reason | String | 否 | 一个可读的字符串，表示连接被关闭的原因。这个字符串必须是不长于123字节的UTF-8 文本（不是字符） | * |
| success | Function | 否 | 接口调用成功的回调函数 | * |
| fail | Function | 否 | 接口调用失败的回调函数 | * |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | * |
uni.onSocketClose(CALLBACK)
监听WebSocket关闭。
uni.connectSocket({ url: 'wss://www.example.com/socket'}); // 注意这里有时序问题，// 如果 uni.connectSocket 还没回调 uni.onSocketOpen，而先调用 uni.closeSocket，那么就做不到关闭 WebSocket 的目的。// 必须在 WebSocket 打开期间调用 uni.closeSocket 才能关闭。uni.onSocketOpen(function () { uni.closeSocket();}); uni.onSocketClose(function (res) { console.log('WebSocket 已关闭！');});
返回值：
返回一个 SocketTask。
</article>
网友评论