dwebsocket基本使用(1)

123 阅读2分钟

如果使用了require_websocket,但使用了普通http请求,则出现Bad Request的报错信息

补充相关方法

相关方法函数说明
1.request.is_websocket()
如果是个websocket请求返回True,如果是个普通的http请求返回False,可以用这个方法区分它们。

2.request.websocket
在一个websocket请求建立之后,这个请求将会有一个websocket属性,用来给客户端提供一个简单的api通讯,如果request.is_websocket()是False,这个属性将是None3.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

视图函数使用装饰器的方式,浏览器客户端与服务端使用websocket通信,增加websocket停止以及重连功能

views.py

from django.shortcuts import render
from dwebsocket import accept_websocket, require_websocket
import time, json


@accept_websocket
def test_websocket(request):
    if request.is_websocket(): # 如果请求是websocket请求:
        WebSocket = request.websocket
        i = 0 # 设置发送至前端的次数
        messages = {}

        while True:
            i += 1 # 递增次数 i
            time.sleep(1) # 休眠1秒

            # 判断是否通过websocket接收到数据
            if WebSocket.has_messages():

                # 存在Websocket客户端发送过来的消息
                client_msg = WebSocket.read().decode()
                # 设置发送前端的数据
                messages = {
                    'time': time.strftime('%Y.%m.%d %H:%M:%S', time.localtime(time.time())),
                    'server_msg': 'send %d times!' % i,
                    'client_msg': client_msg,
                }

            else:
                # 设置发送前端的数据
                messages = {
                    'time':time.strftime('%Y.%m.%d %H:%M:%S',time.localtime(time.time())),
                    'server_msg': 'send %d times!' % i,
                }

            # 设置发送数据为json格式
            request.websocket.send(json.dumps(messages))
    else:
        return render(request, 'test_websocket.html')

test_websocket.html

【坑】:注意发送ws请求时,url后面加上"/"

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
    <script src="http://libs.baidu.com/jquery/2.0.0/jquery.min.js"></script>
    <script type="text/javascript">
        $(function () {
            // 点击连接websocket按钮,则启动访问websocket
            $('#connect_websocket').click(function () {
                // 点击连接websocket按钮,则启动访问websocket
                $('#connect_websocket').click(function () {

                    if(window.s){
                        window.s.close()
                    }

                    // 设置websocket的服务端url
                    var s = new WebSocket("ws://" + window.location.host + "/test_websocket/");

                    // 打开连接websocket服务,连接成功则打印信息
                    s.onopen = function () {
                        console.log('WebSocket open');//成功连接上Websocket
                    };

                    // 接收服务端发送过来的数据,在浏览器上刷新
                    s.onmessage = function (e) {
                        console.log('message: ' + e.data);//打印出服务端返回过来的数据
                        $('#messagecontainer').prepend('<p>' + e.data + '</p>');
                    };

                    window.s = s;
                });

                // 点击发送消息按钮,则通过websocket发送数据至服务端
                $('#send_message').click(function () {
                    if (!window.s) {
                        alert("Please connect server.");
                    } else {
                        window.s.send($('#message').val());//通过websocket发送数据
                    }
                });

                // 点击关闭websocket连接
                $('#close_websocket').click(function () {
                    if (window.s) {
                        window.s.close();//关闭websocket
                        console.log('websocket is closed!');
                    }
                });

            });
        });
    </script>
</head>
<body>

<input type="text" id="message" value="Open websocket!" />
<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>


urls.py

from django.conf.urls import url

from app01 import views

urlpatterns = [  
    url(r'^test_websocket/', views2.test_websocket),
]
复制代码

演示2:websocket连接成功后,服务端主动发消息

views.py

修改上述视图文件

from django.shortcuts import render
from dwebsocket import accept_websocket, require_websocket
import time, json