Python+Django+channels实现websocket

前言

公司需要实现一个长连接，用的Python的Django框架。研究了很长时间，发现Django+channels可以实现websocket。学习Django Channels可以访问官网：https://channels.readthedocs.io/en/latest/
学习，基础写的很详细。这里记录下我实现的websocket测试步骤，备用及分享下。

安装

pip install Django 2.0.2
pip install -U channels 2.0.2
pip install channels_redis 2.0.2
pip install Daphne 2.0.4
pip install asgiref 2.1.6
channels添加到settings.py文件的 INSTALLED_APPS下
注意：
1、若安装过程出现UnicodeDecodeError：‘utf-8’ codec can not decode byte 0xd6 in position 2:invalid continuation byte错误则将/lib\site-packages\pip\compat_init_.py return s.decode(‘utf-8’)修改为return s.decode(‘gbk’)
2、运行channels时，保证redis已启动。

教程

https://channels.readthedocs.io/en/latest/tutorial/index.html
大家可以先去官网学习下，英文档，可以选择翻译也可以读原文档，个人建议读英文档，翻译过来的有点不伦不类。教程有基本设置，实现聊天服务器，将聊天服务器重写为异步，自动化测试，实现这个后差不多懂了一半了。

settings.py文件

#websocket
ASGI_APPLICATION = "trade.routing.application"  # 上面新建的 asgi 应用
CHANNEL_LAYERS = {'default': {# 这里用到了 channels_redis'BACKEND': 'channels_redis.core.RedisChannelLayer','CONFIG': {'hosts': [('127.0.0.1', 6379)],  # 配置你自己的 redis 服务信息},}
}

路由 routing.py

from django.urls import path
from channels.routing import ProtocolTypeRouter, URLRouter
from channels.auth import AuthMiddlewareStack
from trade.consumers import MyConsumerapplication = ProtocolTypeRouter({# WebSocket chat handler"websocket": AuthMiddlewareStack(URLRouter([path("chart/push", MyConsumer),])),
})

WebsocketConsumer

自定义websocket处理类，负责连接，发送，接收，断开连接。
# consumers.py
#-*- coding: utf-8 -*-from channels.generic.websocket import AsyncWebsocketConsumer
from scripts.websocket import updateclass MyConsumer(AsyncWebsocketConsumer):async def connect(self):# 创建连接时调用await self.accept()# 将新的连接加入到群组await self.channel_layer.group_add("chat", self.channel_name)# 信息群发await self.channel_layer.group_send("chat",{"type": "chat.message","text": update('boss_usdt', mode=1),},)async def receive(self, text_data=None, bytes_data=None):# 收到信息时调用# 信息单发# await self.send(text_data="Hello world!")# 信息群发# await self.channel_layer.group_send(#     "chat",#     {#         "type": "chat.message",#         "text": text_data,#     },# )passasync def disconnect(self, close_code):# 连接关闭时调用# 将关闭的连接从群组中移除await self.channel_layer.group_discard("chat", self.channel_name)await self.close()async def chat_message(self, event):# Handles the "chat.message" event when it's sent to us.await self.send(text_data=event["text"])

管道 websocket.py

#websocket.py
from decimal import Decimal
import json
import time
from asgiref.sync import async_to_sync
from channels.layers import get_channel_layer
from django.db.models import Sum
from trade.views import MARKET_CN, TotalTradeView, TradeListView, TradeLogListView, MarketView
from trade.models import Tradelog, Trade, Market, UserCollecion, UserSettlementFee
from trade.serializers import TradeLogSerializer, TradeListSerializer, MarketSerializer, UserCollectionSerializerchannel_layer = get_channel_layer()   #  创建管道def send_to_websocket(value):"""发送到管道"""value = json.dumps(value)async_to_sync(channel_layer.group_send)('chat', {"type": "chat.message", 'text': value})def trade_log(market):"""实时成交"""tradelogs = Tradelog.objects.filter(market=market).order_by('-addtime')[:10]serializer = TradeLogSerializer(tradelogs, many=True)data = {'tradelog': list(serializer.data)}send_to_websocket(data)   # 把数据发送到管道，实现websocketdef trade(market):"""挂单列表"""trade_buy = Trade.objects.filter(market=market, status=0, type=1).order_by('price', '-addtime')[:10]serializer_buy = TradeListSerializer(trade_buy, many=True)calculate_num(serializer_buy.data)trade_sell = Trade.objects.filter(market=market, status=0, type=2).order_by('-price', '-addtime')[:10]serializer_sell = TradeListSerializer(trade_sell, many=True)calculate_num(serializer_sell.data)data = {'status': 1, 'depth': {'buy': list(serializer_buy.data), 'sell': list(serializer_sell.data)}}send_to_websocket(data)

总结

Django实现了对Channels的支持，他所使用的是WebSocket通信，解决了实时通信的问题，而且在使用WebSocket进行通信的同时依旧能够支持HTTP通信。但当服务端接收到新的请求时，可能会打断上个请求的执行，这个需要注意下。写的比较简单，还有一些没有贴上来，后续完善后会更新完善。对于初学者还是建议先阅读官https://channels.readthedocs.io/en/latest/ 学习，不建议直接怼代码，会走很多弯路。