uni.connectSocket(OBJECT)

您所在的位置：网站首页 › 小程序无法连接 › uni.connectSocket(OBJECT)

uni.connectSocket(OBJECT)

2023-08-05 19:36| 来源: 网络整理| 查看: 265

# uni.connectSocket(OBJECT)

创建一个 WebSocket 连接。

在各个小程序平台运行时，网络相关的 API 在使用前需要配置域名白名单。

OBJECT 参数说明

参数名类型必填说明平台差异说明 url String 是服务器接口地址小程序中必须是 wss:// 协议 multiple Boolean 否是否多实例。传入 true 时，将返回一个包含 SocketTask 实例。仅支付宝小程序支持 header Object 否 HTTP Header , header 中不能设置 Referer 小程序、App 2.9.6+ method String 否默认是GET，有效值：OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, CONNECT 仅微信小程序支持 protocols Array 否子协议数组 App、H5、微信小程序、百度小程序、抖音小程序、飞书小程序 success Function 否接口调用成功的回调函数 fail Function 否接口调用失败的回调函数 complete Function 否接口调用结束的回调函数（调用成功、失败都会执行）

示例代码

uni.connectSocket({ url: 'wss://www.example.com/socket', header: { 'content-type': 'application/json' }, protocols: ['protocol1'], method: 'GET' });

返回值

如果希望返回一个 socketTask 对象，需要至少传入 success / fail / complete 参数中的一个。例如：

var socketTask = uni.connectSocket({ url: 'wss://www.example.com/socket', //仅为示例，并非真实接口地址。 complete: ()=> {} });

如果没有传入 success / fail / complete 参数，则会返回封装后的 Promise 对象：Promise 封装

注意事项

网络请求的超时时间可以统一在 manifest.json 中配置 networkTimeout。 App平台，2.2.6以下的版本，不支持 ArrayBuffer 类型的数据收发。老版本不愿升级也可以使用 plus-websocket插件插件替代。 App平台2.2.6以下的版本，所有 vue 页面只能使用一个 websocket 连接。App下可以使用 plus-websocket 插件替代实现多连接。微信小程序平台1.7.0 及以上版本，最多可以同时存在5个WebSocket 连接。老版本只支持一个socket连接。百度小程序平台自基础库版本 1.9.4 及以后支持多个socket连接。老版本只支持一个socket连接。 QQ小程序、支付宝小程序平台最多支持同时存在5个socket连接。 # uni.onSocketOpen(CALLBACK)

监听WebSocket连接打开事件。

平台兼容性

抖音小程序不支持

CALLBACK 返回参数

属性类型说明 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

【本文地址】

uni.connectSocket(OBJECT)

uni.connectSocket(OBJECT)

今日新闻

推荐新闻