网络 – 第 5 页 – 微信小程序开发指南

wx.startLocalServiceDiscovery(Object object)

基础库 2.4.0 开始支持，低版本需做兼容处理。

以 Promise 风格调用：支持

微信小程序插件：支持，需要微信小程序基础库版本不低于 2.15.0

微信鸿蒙 OS 版：支持

相关文档: 局域网通信

功能描述

开始搜索局域网下的 mDNS 服务。搜索的结果会通过 wx.onLocalService* 事件返回。

参数

Object object

属性	类型	必填	说明
serviceType	string	是	要搜索的服务类型
success	function	否	接口调用成功的回调函数
fail	function	否	接口调用失败的回调函数
complete	function	否	接口调用结束的回调函数（调用成功、失败都会执行）

object.fail 回调函数

参数

Object res

属性

类型

说明

errMsg

string

错误信息

合法值	说明
invalid param	serviceType 为空
scan task already exist	在当前 startLocalServiceDiscovery 发起的搜索未停止的情况下，再次调用 startLocalServiceDiscovery

示例代码


    wx.startLocalServiceDiscovery({
      // 当前手机所连的局域网下有一个 _http._tcp. 类型的服务
      serviceType: '_http._tcp.',
      success: console.log,
      fail: console.log
    })

注意

由于操作系统相关能力变更，iOS 微信客户端 7.0.18 及以上版本无法使用 mDNS 相关接口，安卓版本不受影响
wx.startLocalServiceDiscovery 是一个消耗性能的行为，开始 30 秒后会自动 stop 并执行 wx.onLocalServiceDiscoveryStop 注册的回调函数。
在调用 wx.startLocalServiceDiscovery 后，在这次搜索行为停止后才能发起下次 wx.startLocalServiceDiscovery。停止本次搜索行为的操作包括调用 wx.stopLocalServiceDiscovery 和 30 秒后系统自动 stop 本次搜索。

wx.stopLocalServiceDiscovery(Object object)

基础库 2.4.0 开始支持，低版本需做兼容处理。

以 Promise 风格调用：支持

微信小程序插件：支持，需要微信小程序基础库版本不低于 2.15.0

微信鸿蒙 OS 版：支持

相关文档: 局域网通信

功能描述

停止搜索 mDNS 服务

参数

Object object

属性	类型	必填	说明
success	function	否	接口调用成功的回调函数
fail	function	否	接口调用失败的回调函数
complete	function	否	接口调用结束的回调函数（调用成功、失败都会执行）

object.fail 回调函数

参数

Object res

属性

类型

说明

errMsg

string

错误信息

合法值	说明
task not found	在当前没有处在搜索服务中的情况下调用 stopLocalServiceDiscovery

SocketTask.send(Object object)

以 Promise 风格调用：不支持

微信小程序插件：支持

微信 Windows 版：支持

微信 Mac 版：支持

微信鸿蒙 OS 版：支持

相关文档: 网络使用说明、局域网通信

功能描述

通过 WebSocket 连接发送数据

参数

Object object

属性	类型	必填	说明
data	string/ArrayBuffer	是	需要发送的内容
success	function	否	接口调用成功的回调函数
fail	function	否	接口调用失败的回调函数
complete	function	否	接口调用结束的回调函数（调用成功、失败都会执行）

SocketTask.onOpen(function listener)

微信小程序插件：支持

微信 Windows 版：支持

微信 Mac 版：支持

微信鸿蒙 OS 版：支持

相关文档: 网络使用说明、局域网通信

功能描述

监听 WebSocket 连接打开事件

参数

function listener

WebSocket 连接打开事件的监听函数

参数

Object res

属性

类型

说明

最低版本

header

object

连接成功的 HTTP 响应 Header

2.0.0

profile

Object

网络请求过程中一些调试信息

2.10.4

结构属性	类型	说明
fetchStart	number	组件准备好使用 SOCKET 建立请求的时间，这发生在检查本地缓存之前
domainLookUpStart	number	DNS 域名查询开始的时间，如果使用了本地缓存（即无 DNS 查询）或持久连接，则与 fetchStart 值相等
domainLookUpEnd	number	DNS 域名查询完成的时间，如果使用了本地缓存（即无 DNS 查询）或持久连接，则与 fetchStart 值相等
connectStart	number	开始建立连接的时间，如果是持久连接，则与 fetchStart 值相等。注意如果在传输层发生了错误且重新建立连接，则这里显示的是新建立的连接开始的时间
connectEnd	number	完成建立连接的时间（完成握手），如果是持久连接，则与 fetchStart 值相等。注意如果在传输层发生了错误且重新建立连接，则这里显示的是新建立的连接完成的时间。注意这里握手结束，包括安全连接建立完成、SOCKS 授权通过
rtt	number	单次连接的耗时，包括 connect ，tls
handshakeCost	number	握手耗时
cost	number	上层请求到返回的耗时

SocketTask.onMessage(function listener)

微信小程序插件：支持

微信 Windows 版：支持

微信 Mac 版：支持

微信鸿蒙 OS 版：支持

相关文档: 网络使用说明、局域网通信

功能描述

监听 WebSocket 接收到服务器的消息事件

参数

function listener

WebSocket 接收到服务器的消息事件的监听函数

参数

Object res

属性	类型	说明
data	string/ArrayBuffer	服务器返回的消息

SocketTask.onError(function listener)

微信小程序插件：支持

微信 Windows 版：支持

微信 Mac 版：支持

微信鸿蒙 OS 版：支持

相关文档: 网络使用说明、局域网通信

功能描述

监听 WebSocket 错误事件

参数

function listener

WebSocket 错误事件的监听函数

参数

Object res

属性	类型	说明
errMsg	string	错误信息

SocketTask.onClose(function listener)

微信小程序插件：支持

微信 Windows 版：支持

微信 Mac 版：支持

微信鸿蒙 OS 版：支持

相关文档: 网络使用说明、局域网通信

功能描述

监听 WebSocket 连接关闭事件

参数

function listener

WebSocket 连接关闭事件的监听函数

参数

Object res

属性	类型	说明
code	number	一个数字值表示关闭连接的状态号，表示连接被关闭的原因。
reason	string	一个可读的字符串，表示连接被关闭的原因。

SocketTask.close(Object object)

以 Promise 风格调用：不支持

微信小程序插件：支持

微信 Windows 版：支持

微信 Mac 版：支持

微信鸿蒙 OS 版：支持

相关文档: 网络使用说明、局域网通信

功能描述

关闭 WebSocket 连接

参数

Object object

属性	类型	默认值	必填	说明
code	number	1000（表示正常关闭连接）	否	一个数字值，表示关闭连接的状态号，用于说明连接被关闭的原因。
reason	string		否	一个可读的字符串，表示连接被关闭的原因。这个字符串必须是不长于 123 字节的 UTF-8 文本（不是字符）。
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

SocketTask

基础库 1.7.0 开始支持，低版本需做兼容处理。

相关文档: 网络使用说明、局域网通信

WebSocket 任务，可通过 wx.connectSocket() 接口创建返回

方法

SocketTask.send(Object object)

通过 WebSocket 连接发送数据

SocketTask.close(Object object)

关闭 WebSocket 连接

SocketTask.onOpen(function listener)

监听 WebSocket 连接打开事件

SocketTask.onClose(function listener)

监听 WebSocket 连接关闭事件

SocketTask.onError(function listener)

监听 WebSocket 错误事件

SocketTask.onMessage(function listener)

监听 WebSocket 接收到服务器的消息事件

wx.closeSocket(Object object)

推荐使用 SocketTask 的方式来管理 WebSocket 连接，每一条链路的生命周期都更加可控。同时存在多个 WebSocket 连接的情况下，使用 wx 前缀的方法可能会带来一些和预期不一致的情况。

以 Promise 风格调用：支持

微信小程序插件：不支持

微信 Windows 版：支持

微信 Mac 版：支持

微信鸿蒙 OS 版：支持

相关文档: 网络使用说明、局域网通信

功能描述

关闭 WebSocket 连接。

参数

Object object

属性	类型	默认值	必填	说明
code	number	1000（表示正常关闭连接）	否	一个数字值，表示关闭连接的状态号，用于说明连接被关闭的原因。
reason	string		否	一个可读的字符串，表示连接被关闭的原因。这个字符串必须是不长于 123 字节的 UTF-8 文本（不是字符）。
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）

示例代码

wx.connectSocket({
  url: 'test.php'
})

//注意这里有时序问题，
//如果 wx.connectSocket 还没回调 wx.onSocketOpen，而先调用 wx.closeSocket，那么就做不到关闭 WebSocket 的目的。
//必须在 WebSocket 打开期间调用 wx.closeSocket 才能关闭。
wx.onSocketOpen(function() {
  wx.closeSocket()
})

wx.onSocketClose(function(res) {
  console.log('WebSocket 已关闭！')
})