django中實現websocket

時間 2019-12-12

原文原文鏈接

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>

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

相關標籤/搜索

實現

現實

django+websocket+redis

nginx+uwsig+django+websocket

websocket+django+python+paramiko

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。

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__()