微信小程序WebSocket怎么连 微信小程序实现实时聊天功能【案例】

大晨同学_6772

大晨同学_6772

2026-05-27

693人浏览

原创

微信小程序WebSocket必须用wx.connectSocket,不支持new WebSocket();需配置wss合法域名、正确监听onSocketOpen/onSocketMessage,且header与protocols须匹配服务端要求。

微信小程序websocket怎么连 微信小程序实现实时聊天功能【案例】

微信小程序 WebSocket 连接必须用 wx.connectSocket,不能用 new WebSocket()

小程序环境不支持浏览器原生 WebSocket 构造函数,直接写 new WebSocket('wss://...') 会报 ReferenceError: WebSocket is not defined。必须使用微信提供的 wx.connectSocket API,它才是唯一合法入口。

常见错误现象:

  • 在开发者工具里能连上,真机断连 —— 很可能没配合法域名或用了 ws://(必须 wss://)
  • 调用 wx.connectSocket 后没反应 —— 忘了监听 onOpen,或把监听写在了 success 回调里(已废弃)
  • 连接成功但收不到消息 —— 没正确绑定 wx.onSocketMessage,且该监听必须在连接建立前注册(推荐在 onLoad 就设好)

实操建议:

  • url 参数必须是 wss:// 开头,且域名需在「微信公众平台 → 开发管理 → 开发设置 → socket 合法域名」中提前备案并添加
  • 不要在 connectSocket 的 success 或 fail 里处理业务逻辑,它们只表示 API 调用是否发起成功,不反映连接状态
  • 所有事件监听(onOpen、onMessage、onClose、onError)必须用 wx.onSocketXXX 全局方法注册,且建议在页面 onLoad 阶段一次性完成

wx.connectSocket 的 header 和 protocols 怎么用

这两个参数不是摆设,尤其在需要身份透传或协议协商时很关键。

使用场景:

  • header:常用于携带用户 token 或设备信息,比如 { 'X-User-ID': '123', 'X-Auth-Token': 'abc' },服务端可在握手阶段校验,避免连接后还要额外鉴权
  • protocols:数组类型,如 ['chat-v2', 'json'],服务端可据此选择子协议(subprotocol),比如区分聊天、通知、心跳等不同用途的连接通道

注意点:

  • header 中的 key 不支持下划线(_),部分服务器(如 Nginx 反向代理)会自动过滤带下划线的 header,建议用短横线(X-User-Id)
  • protocols 必须和服务端返回的 Sec-WebSocket-Protocol 响应头完全匹配,否则连接会被关闭
  • 微信开发者工具对 header 支持较全,但某些安卓低版本真机可能忽略自定义 header,建议服务端同时支持 query 参数 fallback(如 wss://api.example.com/chat?uid=123&token=abc)

消息收发必须区分 wx.sendSocketMessage 和 wx.onSocketMessage 的生命周期

很多人以为发消息就是调一次 wx.sendSocketMessage,收消息靠 onSocketMessage 监听 —— 这没错,但容易忽略两个致命前提:

微信创作
微信创作

自动将 Markdown 文章转为适配微信公众号格式的 HTML,并批量发布至公众号草稿箱,支持封面图生成与专题管理。

下载
  • 发送前必须确保连接已就绪(readyState === 1),否则会静默失败;建议加一层状态判断:if (wx.getStorageSync('wsReady')) { wx.sendSocketMessage(...) }
  • onSocketMessage 是全局监听,只要页面没销毁就会持续生效,但它的回调参数 res.data 类型不固定:文本消息是 string,二进制消息是 ArrayBuffer,务必用 typeof res.data === 'string' 判断后再 JSON.parse

典型错误:

  • 在 onSocketOpen 回调里立刻发登录消息,但此时连接刚建立,服务端可能还没完成 session 初始化,导致消息被丢弃
  • 收到消息后直接 this.setData({ messages: [...this.data.messages, res.data] }),如果 res.data 是 ArrayBuffer,会触发渲染异常
  • 频繁调用 sendSocketMessage 且不节流,遇到网络抖动时堆积大量未发送任务,最终连接被服务端踢出

建议做法:

  • 连接成功后先发一条轻量 auth 消息,服务端验证通过再返回 {"type":"auth_ok"},客户端收到后再允许 UI 交互
  • 对发送操作做简单队列封装,避免并发冲突;对大消息(如图片 base64)拆包或改走 HTTP 上传

真机调试连不上?重点查这三处配置

开发者工具能通 ≠ 真机能通,90% 的真机连接失败卡在这三个地方:

  • 域名未备案或未填入「socket 合法域名」:必须是完整域名(如 api.example.com),不能带路径或端口;国内服务器必须有 ICP 备案号,且备案主体需与小程序主体一致
  • 证书问题:服务端 wss:// 使用的 SSL 证书必须由可信 CA 签发(Let’s Encrypt 可以),自签名证书、过期证书、域名不匹配都会导致 iOS/Android 拒绝连接
  • 防火墙或反向代理拦截:Nginx 配置里漏了 proxy_http_version 1.1 和 proxy_set_header Upgrade $http_upgrade,会导致 WebSocket 握手失败,错误日志里常出现 101 Switching Protocols 缺失

调试技巧:

  • 在手机微信「发现 → 小程序 → 右上角… → 设置 → 切换调试基础库版本」,选最低兼容版(如 2.28.0)测试兼容性
  • 用 wx.getNetworkType 确认当前是 wifi 还是 4G/5G,部分运营商会对非 443 端口的 wss 流量限速或拦截
  • 服务端开启详细日志,重点关注 WebSocket 握手阶段的请求头(尤其是 Sec-WebSocket-Key 和 Origin)是否被篡改或丢失

最常被忽略的是:小程序的「开发版」「体验版」「正式版」对应三套独立的「socket 合法域名」配置,切版本后必须重新检查,不能只配一个。

相关文章

微信app下载
微信app下载

微信是一款手机通信软件,支持通过手机网络发送语音短信、视频、图片和文字。微信可以单聊及群聊,还能根据地理位置找到附近的人,带给大家全新的移动沟通体验,有需要的小伙伴快来保存下载体验吧!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3429

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2388

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1320

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1278

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1396

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2278

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3720

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

17255

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
秒哒微信小程序发布
秒哒微信小程序发布

共0课时 | 0人学习

微信小程序开发之API篇
微信小程序开发之API篇

共15课时 | 1.8万人学习