Django使用Channels实现WebSocket消息推送功能
- 特别注意：
- channels的版本
- django的版本
- channels配置
- 设置ASGI_APPLICATION
- 修改asgi.py
- 在和settings.py同级目录下创建routings.py
- 在自己创建的app中创建文件consumers.py
- 运行程序
- 测试websocket是否可以正常使用
- 参考
特别注意：
最近在学习django中的websocket的时候遇见了一些配置的问题，被卡了很长的一段时间，所以希望这篇文章可以帮助一些正在学习Djano并且想做消息推送的的小伙伴提供一些解决方法。
channels的版本
这个也就是困惑了我很长的一个时间，如果直接使用pip install channels的话会自动下载比较高的版本（我当时>是下载的4.0.1的版本），所以在注册channels的时候，Django的settings.py中ASGI_APPLICATION没有被配置识别，使得总是在使用WSGI_APPLICATION中的配置。然后还不会报错，这样就浪费了很长的时间。一下是个人对于channels版本的一些猜测。仅仅是猜测。
channels版本过高：可能channels不支持之前的使用方法
channels版本过低：一些后期会使用到的函数没有（比如在2.3版本的时候没有as_asgi()函数）
以上是我看的一些文档代表，很多文档都是这么说，使用pip install channels去下载channels模块，但是，官网可不是这么说的啊，以下是官网原文channels 安装文档：
这个是说，如果你想使用别的服务器程序，就使用pip install channels，但是，但是，咱们之前根本就不知道其他的异步服务器啊，所以，还是使用上面的pip install -U channels[“daphne”] 命令吧
为啥不使用pip install channels呢,因为channels 4.0之后默认不带Daphne服务器了。
django的版本
无所谓的，都行的。
看看下面的文档channels pypi：
channels配置
关键来了，一直要主要看；这就是你看其他的文档没有成功的原因，你距离成功仅仅一步之遥
这是一些文档写的
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'channels',
'app01.apps.App01Config',
]你只要多做一步，
INSTALLED_APPS = (
"daphne ",
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'channels',
'app01.apps.App01Config',
)哪里不同，看到了吗？在首行添加了daphne，通过这个，我也更加理解django的模块可插拔说法。
设置ASGI_APPLICATION
# WSGI_APPLICATION是django中的settings.py中自带的
WSGI_APPLICATION = "项目名称.wsgi.application"
# 需要自己配置的
ASGI_APPLICATION = "项目名称.wsgi.application"
### WSGI_APPLICATION是不需要注销的修改asgi.py
import os
from django.core.asgi import get_asgi_application
from channels.routing import ProtocolTypeRouter, URLRouter
from . import routings
os.environ.setdefault('DJANGO_SETTINGS_MODULE','项目名称.settings')
application = ProtocolTypeRouter(
{
"http": get_asgi_application(), # http走Django默认的asgi
"websocket": URLRouter(routings.websocket_urlpatterns), # websocket走channels
}
)如果不进行修改的话，django默认的是不处理websocket类型的请求的。
在和settings.py同级目录下创建routings.py
from django.urls import re_path
from app01 import consumers,views # 从app01这个app导入consumers，先写上，稍后会说。
import re
# websocket的路由配置
websocket_urlpatterns = [
re_path(r"room/(?P<group>\w+)/$", consumers.ChatConsumer.as_asgi()),
]可以理解为websocket请求的路由匹配的文件
在自己创建的app中创建文件consumers.py
from channels.generic.websocket import WebsocketConsumer
from channels.exceptions import StopConsumer
class ChatConsumer(WebsocketConsumer):
def websocket_connect(self, message):
# 发起请求之后自动创建连接
print("正在常见连接")
self.accept()
def websocket_receive(self, message):
print("接受消息",message)
self.send(text_data='OK') # 返回给客户端的消息
def websocket_disconnect(self, message):
raise StopConsumer()运行程序
channels配置成功
测试websocket是否可以正常使用
使用和平常一样的方式常见案例
app01的文件views
# app01 views.py
from django.shortcuts import render
def index(request):
return render(request,"index.html")app01的urls文件
# app01 urls.py
# urls.py
from django.urls import path
from app01 import views
urlpatterns = [
path('index/', views.index),
]settings的urls.py文件
# settings urls.py
from django.contrib import admin
from django.urls import path, include
urlpatterns = [
path('admin/', admin.site.urls),
path('app01/', include('app01.urls'))
]再写个前端页面
# index.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
<h1>index</h1>
<div>
<input type="text" placeholder="请输入" id="txt">
<input type="button" value="提交" id="but1" onclick="sendMessage();">
</div>
<script>
var socket = new WebSocket("ws://127.0.0.1:8000/room/123/");
function sendMessage() {
let tag = document.getElementById("txt")
console.log("点击了")
if (socket.readyState===1){
socket.send(tag.value);
}else {
console.log("没有连接成功！！！")
}
}
</script>
</body>进行访问和点击之后会自动和consumers.py中的websocket_connection进行连接（完成握手的阶段）
访问如下链接 http://127.0.0.1:8000/app01/index/
后台服务器控制台如下图：
如果你看到这里，说明你没有使用阿里云的源，因为我使用了阿里云的python的源，没有在INSTALLED_APPS中添加daphne，也执行成功了，呜呜呜呜。
参考
- Study_ovo_Boy的django框架channels配置
