小言_互联网的博客

微信小程序开发实战(23):WebSocket实战

367人阅读  评论(0)

WebSocket是一种在单个TCP 连接上进行全双工通讯的协议。 在WebSocket API 中,浏览器和服务器只需要完成一次握手,两者之间就直接可以建立持久性的连接,并进行双向数据传输。

HTML5支持WebSocket,使用方法和小程序的WebSocket基本是一样的。WebSocket API由若干个方法和若干个事件组成。这些方法和事件如下:

方法

  • wx.connectSocket:与服务端建立连接

  • wx.sendSocketMessage:向服务端发送数据

  • wx.closeSocket:关闭连接

事件

  • wx.onSocketOpen:成功与服务端建立连接后触发的事件

  • wx.onSocketError:与服务端建立连接失败后触发的事件

  • wx.onSocketMessage:服务端返回响应消息后触发的事件

  • wx.onSocketClose:成功关闭WebSocket连接后触发的事件

其中wx.connectSocket和wx.sendSocketMessage方法都有一个Object类型的参数,参数属性含义如下所示。

wx.connectSocket方法参数描述

  • url:String类型,必选,开发者服务器接口地址,必须是 wss 协议,且域名必须是后台配置的合法域名

  • data:Object类型,可选,请求的数据

  • header:Object类型,可选,HTTPS Header , header 中不能设置 Referer

  • method:       String类型,可选,默认是GET,有效值为: OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, CONNECT

  • success:Function类型,可选,接口调用成功的回调函数

  • fail:Function 类型,可选,接口调用失败的回调函数

  • complete:Function类型,可选, 接口调用结束的回调函数(调用成功、失败都会执行)

wx. sendSocketMessage方法参数描述

  • data:String或ArrayBuffer类型,必选,需要发送的内容

  • success:Function类型,可选,接口调用成功的回调函数

  • fail:Function 类型,可选,接口调用失败的回调函数

  • complete:Function类型,可选, 接口调用结束的回调函数(调用成功、失败都会执行)

 

下面的代码是从建立WebSocket连接,到向服务端发送数据,然后接收到响应数据,最后关闭WebSocket连接的完整演示。


   
  1. var socketOpen = false
  2. var socketMsgQueue = []
  3. wx.connectSocket({
  4. url: 'wss://example.com/test.php', // 该Url并不存在,只是为了演示假设了一个url
  5. data:{
  6. x: '',
  7. y: ''
  8. },
  9. header:{
  10. 'content-type': 'application/json'
  11. },
  12. method: "GET"
  13. })
  14. // 成功建立WebSocket连接后,会调用该函数
  15. wx.onSocketOpen( function(res) {
  16. socketOpen = true
  17. for ( var i = 0; i < socketMsgQueue.length; i++){
  18. sendSocketMessage(socketMsgQueue[i])
  19. }
  20. socketMsgQueue = []
  21. })
  22. // 向服务端发送数据,如果成功建立了连接,则直接发送,否则保存到消息队列(socketMsgQueue)中
  23. function sendSocketMessage(msg) {
  24. if (socketOpen) {
  25. wx.sendSocketMessage({
  26. data:msg
  27. })
  28. } else {
  29. socketMsgQueue.push(msg)
  30. }
  31. }
  32. // 接收服务端的响应消息,然后关闭WebSocket连接
  33. wx.onSocketMessage( function(res) {
  34. console.log( '收到服务器内容:' + res.data)
  35. wx.closeSocket()
  36. })
  37. // 成功关闭WebSocket连接后,会调用该函数
  38. wx.onSocketClose( function(res) {
  39. console.log( 'WebSocket 已关闭!')
  40. })

如果读者没有用于测试WebSocket的Url,可以使用HTML5来测试WebSocket,效果是一样的。例如,下面是一段用来测试WebSocket的完整的代码,使用的是ws://echo.websocket.org,一个专门用来测试WebSocket的echo服务。在小程序中,必须使用wss,而在HTML5中并没这个要求,使用wss和ws都可以,而且域名也不需要备案。


   
  1. <html>
  2. <head>
  3. <title>测试WebSocket </title>
  4. <script>
  5. function init() {
  6. websocket = new WebSocket( "ws://echo.websocket.org/");
  7. websocket.onopen = function() { document.getElementById( "output").innerHTML += "<p>> CONNECTED</p>"; };
  8. websocket.onmessage = function(evt)
  9. { document.getElementById( "output").innerHTML += "<p style='color: blue;'>> RESPONSE: " + evt.data + "</p>"; };
  10. websocket.onerror = function(evt)
  11. { document.getElementById( "output").innerHTML += "<p style='color: red;'>> ERROR: " + evt.data + "</p>"; };
  12. }
  13. function sendMessage(message) {
  14. document.getElementById( "output").innerHTML += "<p>> SENT: " + message + "</p>";
  15. websocket.send(message);
  16. }
  17. window.addEventListener( "load", init, false);
  18. </script>
  19. </head>
  20. <body>
  21. <input onkeypress="if(this.value) {if (window.event.keyCode == 13) { sendMessage(this.value); this.value = null; }}"/>
  22. <div id="output"> </div>
  23. </body>
  24. </html>

我们可以看到,HTML5的WebSocket和小程序的WebSocket的API在使用上基本是一样的。例如,小程序使用wx.connectSocket方法连接服务端,而HTML5直接创建了WebSocket对象。小程序使用wx.sendSocketMessage方法向服务端发送数据,而HTML5使用websocket.send方法向服务端发送数据。

在浏览器中运行这段代码后,会自动连接服务端,然后在页面左上角输入Hello,按回车键,在页面会显示发送和返回的响应信息。如图1所示。

图1  HTML5 WebSocket测试

 


转载:https://blog.csdn.net/nokiaguy/article/details/108212194
查看评论
* 以上用户言论只代表其个人观点,不代表本网站的观点或立场