利用dwebsocket在Django中使用Websocket

最新推荐文章于 2024-03-05 14:59:38 发布

喝完这杯还有一箱

最新推荐文章于 2024-03-05 14:59:38 发布

阅读量8k

点赞数

温馨提示：博主回头拾遗的时候发现自己也没办法通过本文实现预期效果了，正在看另一种方法，如果您希望快速解决问题，请关闭本页，如只是随便看看，欢迎欢迎！！

2019-07-30更新：django 基于 channels 实现实时聊天和后台主动推送https://blog.csdn.net/qq_37049050/article/details/97774658

一、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技术小了很多.

关于websocket的优点可以看：http://www.tuicool.com/articles/7zyMvy6

二、安装dwebsocket

作者的github地址：https://github.com/duanhongyi/dwebsocket

安装方法：

1.通过pip

pip install  dwebsocket2

2.通过下载到本地

解压》执行 python setup.py install

附：如果安装失败提示关于ASCII码直接删掉readme里面内容即可

三、使用方法

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

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

设置WEBSOCKET_ACCEPT_ALL=True可以允许每一个单独的视图实用websockets

一些方法和属性

`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迭代器

四、干货

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

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>

复制代码

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>

复制代码

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

以下是个人总结的爬坑经验：

1：request.websocket.send（）这里返回的数据类型必须是 string 类型

2：如果要用uwsgi 配合 nginx 启动的话，需要在uwsgi文件中加入以下配置：

[uwsgi]
socket = 127.0.0.1:9090
chdir           = /pro
module          = pro.wsgi
master          = true
processes       = 4
chmod-socket    = 664
vacuum          = true
async = 30
ugreen = ''
http-timeout = 300

喝完这杯还有一箱

关注

0
点赞
踩
9

收藏

觉得还不错? 一键收藏
10
评论
利用dwebsocket在Django中使用Websocket

温馨提示：博主回头拾遗的时候发现自己也没办法通过本文实现预期效果了，正在看另一种方法，如果您希望快速解决问题，请关闭本页，如只是随便看看，欢迎欢迎！！2019-07-30更新：django 基于 channels 实现实时聊天和后台主动推送https://blog.csdn.net/qq_37049050/article/details/97774658一、Websockets介绍...
复制链接

扫一扫