django实时通讯--channels2.x使用

一、背景

　　在最近的项目中的一个需求是消息实时推送消息以及通知功能，项目使用django写的所以决定采用django-channels来实现websocket进行实时通讯。目前官方已经更新到2.1版本，相对于老的channels 1.x版本有了很大变化，无论是使用方式还是功能，其中最大的变化莫过于2.x版本中带来的asyncio特性，可使用异步处理模式。本文内容将介绍channels2版本使用，由于项目django是1.11,其中也遇到了一些坑，比如在channels在处理一次请求后hang住然后报错，后面修改了下django1.11版本的一点源码得以解决，2.0版本应该不会有问题。

二、channels介绍

　　channels是以django插件的形式存在，它不仅能处理http请求，还提供对websocket、MQTT等长连接支持。不仅如此，channels在保留了原生django的同步和易用的特性上还带来了异步处理方式(channels2.X版本)，并且将django自带的认证系统以及session集成到模块中，扩展性非常强。官方文档：https://channels.readthedocs.io/en/latest/index.html

三、安装以及安装需求

　　channels2.0最低django版本要求是1.11+，python3.5+。笔者的版本是django1.11，直接安装可能有问题，以下是测试通过的版本。

笔者的相关版本如下：

Django==1.11.10==2.1.4-redis==2.3.1==2.1.6-redis==1.4.3

如果django版本比较高直接采用pip安装：

-redis

redis安装可以参考博客：https://www.cnblogs.com/wdliu/p/9360286.html

四、开始使用

一、配置settings.py

　　笔者采用的redis作为channel layer(关于其介绍请移步至https://channels.readthedocs.io/en/latest/topics/channel_layers.html),它是实现消息推送的核心，在项目的settings.py中：

注册channles app：

INSTALLED_APPS =, ]

配置channels layer：

ASGI_APPLICATION = =: : [(,6379)],

二、路由配置

在项目settings文件同级目录中新增routing.py

from channels.auth import AuthMiddlewareStack
from channels.routing import ProtocolTypeRouter,URLRouter
import deploy.routing

application = ProtocolTypeRouter({
'websocket': AuthMiddlewareStack(
URLRouter(
deploy.routing.websocket_urlpatterns# 指明路由文件是devops/routing.py
 )
),})

最后在app里配置路由和对应的消费者，笔者这里是devops下的routing.py：

django.conf.urls from . import consumers

websocket_urlpatterns = [
url(r'^ws/deploy/(?P[^/]+)/$',consumers.DeployResult),#consumers.DeployResult 是该路由的消费者
]

项目目录结构如下：

三、编写webscoket消息处理方法(消费者)

deploy/consumers.py：

from channels.generic.websocket import AsyncWebsocketConsumer
import json

class DeployResult(AsyncWebsocketConsumer):
async def connect(self):
self.service_uid = self.scope["url_route"]["kwargs"]["service_uid"]
self.chat_groupname = 'chat%s' % self.service_uid
# 收到连接时候处理，
 await self.channel_layer.group_add(
self.chat_group_name,self.channel_name
)

    await self.accept()

async </span><span style="color: #0000ff;"&gt;def</span><span style="color: #000000;"&gt; disconnect(self,close_code):
    </span><span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt; 关闭channel时候处理</span>

await self.channel_layer.group_discard(
self.chat_group_name,self.channel_name
)

</span><span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt; 收到消息</span>
async <span style="color: #0000ff;"&gt;def</span><span style="color: #000000;"&gt; receive(self,text_data):
    text_data_json </span>=<span style="color: #000000;"&gt; json.loads(text_data)
    message </span>= text_data_json[<span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;message</span><span style="color: #800000;"&gt;'</span><span style="color: #000000;"&gt;]
    </span><span style="color: #0000ff;"&gt;print</span>(<span style="color: #800000;"&gt;"</span><span style="color: #800000;"&gt;收到消息--》</span><span style="color: #800000;"&gt;"</span><span style="color: #000000;"&gt;,message)
    </span><span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt; 发送消息到组</span>

await self.channel_layer.group_send(
self.chat_group_name,{
'type': 'client.message','message': message
}
)

</span><span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt; 处理客户端发来的消息</span>
async <span style="color: #0000ff;"&gt;def</span><span style="color: #000000;"&gt; client_message(self,event):
    message </span>= event[<span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;message</span><span style="color: #800000;"&gt;'</span><span style="color: #000000;"&gt;]
    </span><span style="color: #0000ff;"&gt;print</span>(<span style="color: #800000;"&gt;"</span><span style="color: #800000;"&gt;发送消息。。。</span><span style="color: #800000;"&gt;"</span><span style="color: #000000;"&gt;,message)
    </span><span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt; 发送消息到 WebSocket</span>
    await self.send(text_data=<span style="color: #000000;"&gt;json.dumps({
        </span><span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;message</span><span style="color: #800000;"&gt;'</span><span style="color: #000000;"&gt;: message
    }))</span></pre>

以上代码部分说明：

1.self.scope是单个连接传入的详细信息，其中包含了请求的session、以及django认证系统中的用户信息等；

2.async...await 是python3.5之后的新异步特性，基于asyncio模块；

四、发起webscoket请求

利用js发起websocket请求

websocket = 'ws://' + window.location.host + '/ws/deploy/tasks/'

        websocket.onmessage </span>= <span style="color: #0000ff;"&gt;function</span><span style="color: #000000;"&gt; (e) {
            </span><span style="color: #0000ff;"&gt;var</span> data =<span style="color: #000000;"&gt; JSON.parse(e.data);
            </span><span style="color: #0000ff;"&gt;var</span> message = '\n' + data['message'<span style="color: #000000;"&gt;];
            document.querySelector(</span>'#deploy-res').innerText += (message + '\n'<span style="color: #000000;"&gt;);
        };
    }</span></pre>

五、发送消息到channel

无论是消息的推送或者消息的接受，都是经过channel layer进行传输，以下是发送消息示例，

channel_layer = get_channel_layer()
def send_channel_msg(channel_name,msg):
"""
send msg to channel
:param channel_name:
:param msg:
:return:
"""
async_to_sync(channel_layer.group_send)(channel_name,{"type": "deploy.run","text": msg})

六、生产部署

大多数django的应用部署方式都采用的是nginx+uwsgi进行部署，当django集成channels时候，由于uwsgi不能处理websocket请求，所以我们需要asgi服务器来处理websocket请求，官方推荐使用daphne。下一篇文章将介绍nginx+supervisor+daphne+uwsgi进行生产部署。