webSockets
是一种创建持久性的连接,并进行双向数据传输的 HTTP 通信协议。Weex 提供了 webSockets
模块方便用户在 H5/iOS/Android 环境下与服务端创建 webSockets 链接进行通信。
::: warning 注意 h5 提供 WebSockets 的 protocol 默认实现,iOS 和 Android 需要自定义实现,Android 可参考:
创建 WebSockets,并连接服务器。
const ws = weex.requireModule('webSocket'); ws.WebSocket('ws://echo.websocket.org','');
通过 WebSockets 连接向服务器发送数据。
const ws = weex.requireModule('webSocket'); ws.WebSocket('ws://echo.websocket.org',''); ws.send('some message.');
关闭 WebSockets 的链接。
const ws = weex.requireModule('webSocket'); ws.WebSocket('ws://echo.websocket.org',''); ws.close();
一个用于连接打开事件的事件监听器,该事件表明这个连接已经准备好接受和发送数据。onopen
接受一个函数作为 EventListener,这个监听器会接受一个 type
为 “open” 的事件对象。
标准 event 对象,无特殊属性。
const ws = weex.requireModule('webSocket') ws.WebSocket('ws://echo.websocket.org',''); ws.onopen = function(event) { console.log('onopen', event); }
一个用于消息事件的事件监听器,当有消息到达的时触发。onmessage
接受一个函数作为 EventListener,这个监听器会接受一个 type
为 “message” 的事件对象。
data
, string, 监听器接收的到的消息const ws = weex.requireModule('webSocket') ws.WebSocket('ws://echo.websocket.org',''); ws.onmessage = function(event) { console.log('onmessage', event); }
一个用于连接关闭事件的事件监听器,当连接关闭时触发。onclose
接受一个函数作为 EventListener,这个监听器会接受一个 type
为 “close” 的事件对象。
code
, number, 服务器返回关闭的状态码reason
, string, 服务器返回的关闭原因wasClean
, boolen, 是否完全关闭const ws = weex.requireModule('webSocket') ws.WebSocket('ws://echo.websocket.org',''); ws.onclose = function(event) { console.log('onclose', event); }
一个用于 error 事件的事件监听器,当错误发生时触发。onerror
接受一个函数作为 EventListener,这个监听器会接受一个 type
为 “error” 的事件对象。
data
, string, 监听器接收的到的消息const ws = weex.requireModule('webSocket') ws.WebSocket('ws://echo.websocket.org',''); ws.onerror = function(event) { console.log('onerror', event); }
Demos