利用dwebsocket在Django中使用Websocket

时间 2019-11-11

标签利用 dwebsocket django 使用 websocket 栏目 Python 繁體版

原文原文链接

1、Websockets介绍

随着互联网的发展，传统的HTTP协议已经很难知足Web应用日益复杂的需求了。近年来，随着HTML5的诞生，WebSocket协议被提出，它实现了浏览器与服务器的全双工通讯，扩展了浏览器与服务端的通讯功能，使服务端也能主动向客户端发送数据。
　咱们知道，传统的HTTP协议是无状态的，每次请求（request）都要由客户端（如浏览器）主动发起，服务端进行处理后返回response结果，而服务端很难主动向客户端发送数据；这种客户端是主动方，服务端是被动方的传统Web模式对于信息变化不频繁的Web应用来讲形成的麻烦较小，而对于涉及实时信息的Web应用却带来了很大的不便，如带有即时通讯、实时数据、订阅推送等功能的应用。在WebSocket规范提出以前，开发人员若要实现这些实时性较强的功能，常常会使用折衷的解决方法：轮询（polling）和Comet技术。其实后者本质上也是一种轮询，只不过有所改进。
　轮询是最原始的实现实时Web应用的解决方案。轮询技术要求客户端以设定的时间间隔周期性地向服务端发送请求，频繁地查询是否有新的数据改动。明显地，这种方法会致使过多没必要要的请求，浪费流量和服务器资源。
　 Comet技术又能够分为长轮询和流技术。长轮询改进了上述的轮询技术，减少了无用的请求。它会为某些数据设定过时时间，当数据过时后才会向服务端发送请求；这种机制适合数据的改动不是特别频繁的状况。流技术一般是指客户端使用一个隐藏的窗口与服务端创建一个HTTP长链接，服务端会不断更新链接状态以保持HTTP长链接存活；这样的话，服务端就能够经过这条长链接主动将数据发送给客户端；流技术在大并发环境下，可能会考验到服务端的性能。
　这两种技术都是基于请求-应答模式，都不算是真正意义上的实时技术；它们的每一次请求、应答，都浪费了必定流量在相同的头部信息上，而且开发复杂度也较大。
　伴随着HTML5推出的WebSocket，真正实现了Web的实时通讯，使B/S模式具有了C/S模式的实时通讯能力。WebSocket的工做流程是这样的：浏览器经过JavaScript向服务端发出创建WebSocket链接的请求，在WebSocket链接创建成功后，客户端和服务端就能够经过 TCP链接传输数据。由于WebSocket链接本质上是TCP链接，不须要每次传输都带上重复的头部数据，因此它的数据传输量比轮询和Comet技术小了不少.javascript

关于websocket的优势能够看：http://www.tuicool.com/articles/7zyMvy6html

2、安装dwebsocket

做者的github地址：https://github.com/duanhongyi/dwebsocketjava

安装方法：

1.经过pippython

pip install  dwebsocket2

2.经过下载到本地jquery

解压》执行 python setup.py installgit

附：若是安装失败提示关于ASCII码直接删掉readme里面内容便可github

3、使用方法

若是你想为一个单独的视图处理一个websocklet链接可使用accept_websocket装饰器，它会将标准的HTTP请求路由到视图中。使用require_websocke装饰器只容许使用WebSocket链接，会拒绝正常的HTTP请求。web

在设置中添加设置MIDDLEWARE_CLASSES=dwebsocket.middleware.WebSocketMiddleware这样会拒绝单独的视图实用websocket，必须加上accept_websocket 装饰器。django

设置WEBSOCKET_ACCEPT_ALL=True能够容许每个单独的视图实用websocketsapi

一些方法和属性

`1.request.is_websocket()`

若是是个websocket请求返回True，若是是个普通的http请求返回False,能够用这个方法区分它们。

`2.request.websocket`

在一个websocket请求创建以后，这个请求将会有一个websocket属性，用来给客户端提供一个简单的api通信，若是request.is_websocket()是False，这个属性将是None。

`3.WebSocket.wait()`

返回一个客户端发送的信息，在客户端关闭链接以前他不会返回任何值，这种状况下，方法将返回None

`4.WebSocket.read()`

若是没有从客户端接收到新的消息，read方法会返回一个新的消息，若是没有，就不返回。这是一个替代wait的非阻塞方法

`5.WebSocket.count_messages()`

返回消息队列数量

`6.WebSocket.has_messages()`

若是有新消息返回True，不然返回False

`7.WebSocket.send(message)`

向客户端发送消息

`8.WebSocket.iter()`

websocket迭代器

4、干货

功能：让咱们从客户端接收一条消息，将该消息发送回客户端并关闭链接。

1.新建一个django项目

2.新建index.html在templates文件夹下，编写咱们的客户端

<!DOCTYPE html>
<html>
<head>
    <title>django-websocket</title>
    <script src="http://code.jquery.com/jquery-1.11.1.min.js"></script>
    <script type="text/javascript">//<![CDATA[
    $(function () {
        $('#send_message').click(function () {
            var socket = new WebSocket("ws://" + window.location.host + "/echo_once/");
            socket.onopen = function () {
                console.log('WebSocket open');//成功链接上Websocket
                socket.send($('#message').val());//发送数据到服务端
            };
            socket.onmessage = function (e) {
                console.log('message: ' + e.data);//打印服务端返回的数据
                $('#messagecontainer').prepend('<p>' + e.data + '</p>');
            };
        });
    });
    //]]></script>
</head>
<body>
<br>
<input type="text" id="message" value="Hello, World!"/>
<button type="button" id="send_message">发送 message</button>
<h1>Received Messages</h1>
<div id="messagecontainer">

</div>
</body>
</html>

View Code

3.app的views.py编写咱们的服务端

from dwebsocket import require_websocket

@require_websocket
def echo_once(request):
    message = request.websocket.wait()
    request.websocket.send(message)

4.url路由设置

from demo import views as v

urlpatterns = [

    url(r'^index/', v.index),
    url(r'^echo_once', v.echo_once),
]

5.runserver运行，效果展现

能够看到，当咱们点击按钮以后，服务端发送消息到客户端以后，就自动关闭了链接。

固然，咱们也可让服务端不自动关闭链接，接下来利用websocket和http Get写一个同样的功能的函数，

6.新建一个html，写一个新的客户端

<!DOCTYPE html>
<html>
<head>
    <title>django-websocket</title>
    <script src="http://code.jquery.com/jquery-1.11.1.min.js"></script>
    <script type="text/javascript">//<![CDATA[
    $(function () {
        $('#connect_websocket').click(function () {
            if (window.s) {
                window.s.close()
            }
            /*建立socket链接*/
            var socket = new WebSocket("ws://" + window.location.host + "/echo");
            socket.onopen = function () {
                console.log('WebSocket open');//成功链接上Websocket
            };
            socket.onmessage = function (e) {
                console.log('message: ' + e.data);//打印出服务端返回过来的数据
                $('#messagecontainer').prepend('<p>' + e.data + '</p>');
            };
            // Call onopen directly if socket is already open
            if (socket.readyState == WebSocket.OPEN) socket.onopen();
            window.s = socket;
        });
        $('#send_message').click(function () {
            //若是未链接到websocket
            if (!window.s) {
                alert("websocket未链接.");
            } else {
                window.s.send($('#message').val());//经过websocket发送数据
            }
        });
        $('#close_websocket').click(function () {
            if (window.s) {
                window.s.close();//关闭websocket
                console.log('websocket已关闭');
            }
        });

    });
    //]]></script>
</head>
<body>
<br>
<input type="text" id="message" value="Hello, World!"/>
<button type="button" id="connect_websocket">链接 websocket</button>
<button type="button" id="send_message">发送 message</button>
<button type="button" id="close_websocket">关闭 websocket</button>
<h1>Received Messages</h1>
<div id="messagecontainer">

</div>
</body>
</html>

View Code

7.在viws.py中加入新的方法

from django.shortcuts import render
from dwebsocket.decorators import accept_websocket,require_websocket
from django.http import HttpResponse


@accept_websocket
def echo(request):
    if not request.is_websocket():#判断是否是websocket链接
        try:#若是是普通的http方法
            message = request.GET['message']
            return HttpResponse(message)
        except:
            return render(request,'index.html')
    else:
        for message in request.websocket:
            request.websocket.send(message)#发送消息到客户端

8.url.py

from demo import views as v

urlpatterns = [
    url(r'^index2/', v.index2),
    url(r'^echo$', v.echo),
]

9.runserver运行，看看效果

能够看到，只有当咱们手动关闭链接时候，websocket才会关闭。

附上demo地址：

https://github.com/huguodong/dj_dwebsocket

利用dwebsocket在Django中使用Websocket

1、Websockets介绍

2、安装dwebsocket

安装方法：

3、使用方法

一些方法和属性

1.request.is_websocket()

2.request.websocket

3.WebSocket.wait()

4.WebSocket.read()

5.WebSocket.count_messages()

6.WebSocket.has_messages()

7.WebSocket.send(message)

8.WebSocket.__iter__()