django-gevent-websocket 0.2.0

设置

将以下内容添加到您的 $PROJECT_DIR/wsgi.py

from django_websocket.wsgi import get_wsgi_websocket_application
websocket = get_wsgi_websocket_application()

将以下内容添加到您的 $PROJECT_DIR/settings.py

WEBSOCKET_URLCONF = '<path-to-websocket-urlconf>'

建议的urlconf可以是 $PROJECT_DIR/websocket_urls.py。

然后您需要将您的WebSocket urls添加到该文件中：它们将与您的正常urls非常相似，但只会包含应该接受WebSocket连接的端点

from django.conf.urls import patterns, url

urlpatterns = patterns('',
    url(r'^chat/$', 'path.to.view', name='chat'),
)

如果您想使用 {% websocket_url %} 获取指向正确WebSocket服务器和端口的绝对urls，那么您需要设置

视图

WebSocket视图函数看起来非常像普通的django视图函数，实际上，它是由常规django请求周期调用的，但它不返回HttpResponse对象。相反，您从请求中获取websocket对象，并从它那里 .receive() 数据，或者 .send(data) 到它。

为了使事情变得简单，您可以使用装饰器来包装您的视图

from django_websocket.decorators import websocket

@websocket
def view_function(request, websocket, *args, **kwargs):
    # do stuff here.

此装饰器将websocket作为视图的第二个参数添加：您仍然有请求对象，允许您进行权限检查等操作。如果您愿意，仍然可以使用任何常规django装饰器。

from select import select

from django_websocket.decorators import websocket

@websocket
def view_function(request, websocket):
    ws_sock = websocket.handler.socket.fileno()
    other_sock = ... # other socket to listen on.

    while not websocket.closed():
        fd = select([ws_sock, other_sock], [], [])[0][0]

        if fd == ws_sock:
            data = websocket.receive()
            # Deal with incoming data.
        else: ## fd == other_sock:
            # Deal with data from the other source
            websocket.send(message)

from select import select

import redis

from ..decorators import websocket

@websocket
def chat(request, websocket, *args, **kwargs):

    conn = redis.StrictRedis()
    subs = conn.pubsub()
    subs.subscribe('CHAT')

    def incoming():
        data = websocket.receive()
        if data:
            conn.publish('CHAT', data)

    def outgoing():
        msg_type, channel, message = subs.parse_response()
        if msg_type == 'message':
            websocket.send(message)

    sockets = {
        websocket.handler.socket.fileno(): incoming,
        subs.connection._sock.fileno(): outgoing
    }

    while not websocket.closed:
        fd = select(sockets.keys(), [], [])[0][0]
        sockets[fd]()

模板标签

因为您应该为WebSocket视图有不同的urlconf，所以您需要使用一个稍微不同的模板标签来访问WebSocket urls

{% load websockets %}

<script>
  var ws = new WebSocket("{% websocket_url 'urlname' %}");

  // Do something with your shiny new WebSocket!
  // ws.send('foo');
</script>

启动服务器

您需要单独启动 geventwebsocket 服务器：没有django管理命令（这反映了run_gunicorn的弃用）

gunicorn -k "geventwebsocket.gunicorn.workers.GeventWebSocketWorker" $PROJECT_DIR.wsgi:websocket -b 127.0.0.1:8001

注意这运行在不同于您的django开发服务器（或生产中的gunicorn）的端口上。在生产中，您可能将两者都放在nginx代理或类似的后面。如果您想这样做，您可能需要进行一些复杂的设置，以便WebSocket连接的分离可以正常工作。我做了类似以下的事情

server {
  listen  80;
  proxy_set_header Host $host;

  location /static/ {
    alias ...
  }

  if ($http_upgrade) {
    rewrite ^(.*)$ /__ws__/$1 break;
  }

  location /__ws__/ {
    proxy_pass http://127.0.0.1:8001;
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "upgrade";
    rewrite ^/__ws__/(.*)$ $1 break;
    return;
  }

  location / {
    proxy_pass http://127.0.0.1:8000;
  }
}

注意双重的重写。当存在Upgrade头时，它重写url，然后重写回来，以便url在django内部匹配。