Websocket模块
WebSocket 是什么？
WebSocket 是一种网络通信协议。RFC6455 定义了它的通信标准。
WebSocket 是 HTML5 开始提供的一种在单个 TCP 连接上进行全双工通讯的协议。
为什么需要 WebSocket ？
了解计算机网络协议的人，应该都知道：HTTP 协议是一种无状态的、无连接的、单向的应用层协议。它采用了请求/响应模型。通信请求只能由客户端发起，服务端对请求做出应答处理。
这种通信模型有一个弊端：HTTP 协议无法实现服务器主动向客户端发起消息。
这种单向请求的特点，注定了如果服务器有连续的状态变化，客户端要获知就非常麻烦。大多数 Web 应用程序将通过频繁的异步 JavaScript 和 XML（AJAX）请求实现长轮询。轮询的效率低，非常浪费资源（因为必须不停连接，或者 HTTP 连接始终打开）。
因此，工程师们一直在思考，有没有更好的方法。WebSocket 就是这样发明的。WebSocket 连接允许客户端和服务器之间进行全双工通信，以便任一方都可以通过建立的连接将数据推送到另一端。WebSocket 只需要建立一次连接，就可以一直保持连接状态。这相比于轮询方式的不停建立连接显然效率要大大提高。
WebSocket 如何工作？
Web 浏览器和服务器都必须实现 WebSockets 协议来建立和维护连接。由于 WebSockets 连接长期存在，与典型的 HTTP 连接不同，对服务器有重要的影响。
基于多线程或多进程的服务器无法适用于 WebSockets，因为它旨在打开连接，尽可能快地处理请求，然后关闭连接。任何实际的 WebSockets 服务器端实现都需要一个异步服务器。
WebSocket 客户端
在客户端，没有必要为 WebSockets 使用 JavaScript 库。实现 WebSockets 的 Web 浏览器将通过 WebSockets 对象公开所有必需的客户端功能（主要指支持 Html5 的浏览器）。
客户端 API
以下 API 用于创建 WebSocket 对象。
var Socket = new WebSocket(url, [protocol] );
Websocket属性
| 属性 | 描述 |
|---|---|
| Socket.readyState | 只读属性readySate表示连接状态,可以是以下值:0 - 表示连接尚未建立,1 - 表示连接已建立,可以进行通信. 2 - 表示连接正在进行关闭.3 - 表示连接已经关闭或者连接不能打开 |
| Socket.bufferedAmount | 只读属性 bufferedAmount 已被 send() 放入正在队列中等待传输，但是还没有发出的 UTF-8 文本字节数。 |
WebSocket事件
| 事件 | 事件处理程序 | 描述 |
|---|---|---|
| open | Socket.onopen | 连接建立时触发 |
| message | Socket.onmessage | 客户端接收服务端数据时触发 |
| error | Socket.onerror | 通信发生错误时触发 |
| close | Socket.onclose | 连接关闭时触发 |
WebSocket方法
| 方法 | 描述 |
|---|---|
| Socket.send() | 使用连接发送数据 |
| Socket.close() | 关闭连接 |
gevent-websocket模块(python操作websocket)
模拟群聊小示例
# views.py
from geventwebsocket.handler import WebSocketHandler
from geventwebsocket.server import WSGIServer
from geventwebsocket.websocket import WebSocket # 用于提示语法信息
from flask import Flask, request, render_template
app = Flask(__name__)
socket_list = []
@app.route('/ws')
def ws():
sock = request.environ.get('wsgi.websocket') # type:WebSocket
# request.environ是个大字典,获取wsgi.websocket键对应的值即获得web.socket对象
socket_list.append(sock)
while True:
try:
msg = sock.receive() # receive v.接收
except:
socket_list.remove(sock)
break
# 监听时如果连接异常会报错,异常捕捉如果接收异常则删除这个websocket对象
for so in socket_list:
if so == sock:
continue
try:
so.send(msg)
except:
continue
# 如果发送的客户端断开则会报错,捕捉异常,如果无法正常发送则跳过
return '200 ok'
@app.route('/')
def index():
return render_template('wb_client.html')
if __name__ == '__main__':
http_serv = WSGIServer(('0.0.0.0', 9527), app, handler_class=WebSocketHandler)
# app 是Flask示例化对象,wsgi处理完environ之后交给Flaskrequest处理.handler_class处理类型.
http_serv.serve_forever()
websocket.html
<!DOCTYPE html>
<html lang="zh-CN">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<!-- 上述3个meta标签*必须*放在最前面，任何其他内容都*必须*跟随其后！ -->
<title>思宇群聊</title>
</head>
<body>
<input type="text" id="text">
<button id="send">点击发送消息</button>
<div id="content_list"></div>
<script type='application/javascript'>
var ws = new WebSocket('ws://192.168.14.118/ws')
# 回调函数
# 连接建立时调用
ws.onopen = function() {
ws.send('hello')
}
# 接收到消息时,执行
ws.onmessage = function (eventMessage) {
var s = eventMessage.data; # 获取数据
var p = document.createElement('p')
p.innerText = s;
document.getElementById('content_list').appendChild(p);
};
# 绑定点击事件发送消息
document.getElementById('send').addEventListener('onclick', function() {
var st = document.getElementById('text').value;
ws.send(st);
})
</script>
</body>
</html>
模拟点对点小示例
# views.py
import json
from geventwebsocket.handler import WebSocketHandler # ws 协议请求处理
from geventwebsocket.server import WSGIServer # 替换Flask原有的WSGI
from geventwebsocket.websocket import WebSocket
from flask import Flask, request, render_template
app = Flask(__name__)
socket_dict = {}
@app.route('/ws/<username>')
def ws(username):
sock = request.environ.get('wsgi.websocket', None) # type: WebSocket
# 1.不是WS协议上的请求,则获得None
# 2.WS协议认证失败,获得None
if not sock:
return '请使用WS协议连接'
socket_dict[username] = sock
while True:
msg = sock.receive()
msg_dickt = json.loads(msg)
recv = msg_dict.get('recv')
recv_sock = socket_dict.get(recv)
recv_sock.send(msg)
@app.route('/')
def index():
return render_template('ws_client_2.html')
if __name__ == '__main__':
http_serv = WSGIServer(('0.0.0.0', 9527),app, handler_class = WebSocketHandler)
http.serv.serve.forever()
<!DOCTYPE html>
<html lang="zh-CN">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Bootstrap 101 Template</title>
</head>
<body>
你的名字:<input type="text" id="username"><button id="createws">登录聊天室</button>
<p>给<input type="text" id="recv">发送<input type="text" id="text">内容 <button id="send">点击发送消息</button></p>
<div id="content_list">
</div>
</body>
<script type="application/javascript">
var ws = null;
document.getElementById('createws').onclick = function() {
# 获取用户名
var username = document.getElementById('username').value;
ws = new WebSocket('ws://192.168.14.26:9527/ws/'+username);
ws.onopen = function () {
alert('欢迎进入九聊');
};
ws.onmessage = function (eventMessage) {
var msg = JSON.parse(eventMessage.data);
console.log(msg);
var p = document.createElement('p');
p.insertText = msg.sender + ':' + msg.msg;
document.getElementById('content_list').appendChild(p);
};
};
</script>
</html>
WebSocket协议
目前Workerman的WebSocke协议版本为13
WebSocket protocol 是HTML5一种新的协议。它实现了浏览器与服务器全双工通信
WebSocket与TCP关系
WebSocket和HTTP一样是一种应用层协议，都是基于TCP传输的，WebSocket本身和Socket并没有多大关系，更不能等同。
WebSocket协议握手
WebSocket协议有一个握手的过程，握手时浏览器和服务端是以HTTP协议通信的，在Workerman中可以这样介入到握手过程。