WebSocket是HTML5开始提供的一种在单个TCP连接上进行全双工通讯的协议;
在WebSocket API中,浏览器和服务器只需要做一个握手的动作,然后,浏览器和服务器之间就形成了一条快速通道,两者之间就直接可以数据互相传送;
浏览器通过JavaScript向服务器发出建立WebSocket连接的请求,连接建立以后客户端和服务器端就可以通过TCP连接直接交换数据;
当你获取Web Socket连接后,你可以通过send()方法来向服务器发送数据,并通过 onmessage 事件来接受服务器返回的数据;
创建WebSocket对象
var Socket = new WebSocket(url, [protocol]);
以上代码中的第一个参数 url,指定连接的URL;第二个参数 protocol是可选的,指定可接受的子协议。
WebSocket属性
以下是WebSocket对象的属性。假设已经创建了Socket对象;
属性 | 描述 |
---|---|
Socket.readyState | 只读属性 readyState表示连接状态,可以是以下值: 0 - 表示连接尚未成立 1 - 表示连接已建立,可以进行通讯; 2 - 表示连接正在进行关闭; 3 - 表示连接已经关闭或者连接不能打开; |
Socket.bufferedAmount | 只读属性 bufferedAmount 已被send()放入正在队列中等待传输,但是还没有发出的 UTF-8 文本字节数; |
WebSocket事件
以下是WebSocket对象的相关事件,假定已经创建了Socket对象;
事件 | 事件处理程序 | 描述 |
---|---|---|
open | Socket.onopen | 建立连接时触发 |
message | Socket.onmessage | 客户端接收服务端数据时触发 |
error | Socket.onerror | 通信发生错误时触发 |
close | Socket.onclose | 连接关闭时触发 |
WebSocket方法
以下是WebSocket对象的相关方法,假定已经创建了Socket对象
方法 | 描述 |
---|---|
Socket.send() | 使用连接发送数据 |
Socket.close() | 关闭连接 |
WebSocket实例
WebSocket协议本质上是一个基于TCP的协议;
为了建立一个WebSocket连接,客户端浏览器首先要向服务器发起一个HTTP请求,这个请求和通常的HTTP请求不同,包含了一些附加头信息,其中附加头信息“Upgrade:WebSocket”表明这是一个申请协议升级的HTTP请求,服务器端解析这些附加的头信息然后产生应答信息返回给客户端,客户端和服务器端的WebSocket连接就建立起来了,双方就可以通过这个连接通道自由的传递信息,并且这个连接会持续存在直到客户端或者服务器端的某一方主动的关闭连接。
客户端的HTML和JavaScript
目前大部分浏览器支持WebSocket()接口,你可以在以下浏览器中尝试实例:Chrome,Mozilla,Opera 和 Safari 。
<!DOCTYPE HTML>
<html>
<head>
<meta charset="utf-8">
<title>WebSocket</title>
<script type="text/javascript">
function WebSocketTest() {
if ("WebSocket" in window) {
console.log("您的浏览器支持 WebSocket!");
// 打开一个 web socket
var ws = new WebSocket("ws://localhost:9998/echo");
ws.onopen = function() {
// Web Socket 已连接上,使用 send() 方法发送数据
ws.send("发送数据");
console.log("数据发送中...");
};
ws.onmessage = function (evt)
{
var received_msg = evt.data;
console.log("数据已接收...");
};
ws.onclose = function()
{
// 关闭 websocket
console.log("连接已关闭...");
};
}else{
//您的浏览器不支持 WebSocket
console.log("您的浏览器不支持 WebSocket!");
}
}
</script>
</head>
<body>
<div id="sse">
<a href="javascript:WebSocketTest()">运行 WebSocket</a>
</div>
</body>
</html>
安装 pywebsocket
在执行以上程序前,我们需要创建一个支持 WebSocket的服务,从pywebsocket 下载mod_pywebsocket,或者使用git命令下载:
git clone https://github.com/google/pywebsocket.git
mod_pywebsocket需要 python 环境支持
mod_pywebsocket 是一个Apache HTTP的Web Socket的扩展,安装步骤如下:
- 解压下载的文件;
- 进入 pywebsocket 目录;
- 执行命令:
$ python setup.py build
$ sudo python setup.py install
- 查看文档说明:
$ pydoc mod_pywebsocket
开启服务
在 pywebsocket/mod_pywebsocket 目录下执行以下命令:
$ sudo python standalone.py -p 9998 -w ../example/
以上命令会开启一个端口号为9998的服务,使用 -w 来设置处理程序 echo_wsh.py 所在的目录。
现在我们可以在Chrome浏览器打开前面创建的文件,如果你的浏览器支持WebSocket()。点击“运行WebSocket”,就可以在控制台看到整个流程各个步骤输出的内容;
在我们停止服务后,会输出“连接已关闭...” 。
网友评论