django + channels + nginx + supervisor 部署经验总结

最近在研究python websocket,最一些部署遇到的坑做一下记录总结,部署channels的前提是其他的https环境都配置好了,具体的可以看我的另外一篇文章 https://www.jianshu.com/p/4e3c213d7db0
这里我以其他的环境都搭建好为前提讲解如何使用channels和线上部署
首先我们们先安装channels,执行以下命令

pip3 install channels

会为我们安装很多依赖,包括我们后面需要的的 daphne,daphne需要做软连接,要不然我们后面执行daphne命令的时候会报找不到命令的错误

ln -s /usr/local/python3/bin/daphne  /usr/bin/daphne

这样我们的channels已经安装好了,下面我们需要做django的配置
首先加载channels,在settings.py
INSTALLED_APPS 中添加channels,如下

INSTALLED_APPS = [
    'channels',
    'chat',
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'home.apps.HomeConfig'
]

下面我们在项目目录下创建asgi.py配置文件,与wsgi.py同级,配置内容如下:

import os
import django
from channels.routing import get_default_application

os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'haomai.settings')
django.setup()
application = get_default_application()

同时我们创建channels路由配置文件.创建routing.py,配置内容如下

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

application = ProtocolTypeRouter({
    # (http->django views is added by default)
    'websocket': AuthMiddlewareStack(
        URLRouter(
            chat.routing.websocket_urlpatterns
        )
    ),
})

这是我们把创建个chat app,主要用来测试websocket聊天用的,创建命令如下:

python3 manage.py startapp chat

这样我们就常见了个chat app,在上面的路由配置文件我们发现 chat.routing.websocket_urlpatterns,目前是找不到的,我们还没有创建配置,这里我们先创建,在chat 目录下,同样创建个routing.py文件,配置内容如下:

from django.conf.urls import url
from django.urls import path
from . import chat

websocket_urlpatterns = [
    path('ws/chat/', chat.ChatConsumer),
]

我们创建服务端测试代码chat.py,内容如下:

# 该文件内是专门用来写处理websocket请求的视图函数


from channels.generic.websocket import WebsocketConsumer
from channels.exceptions import StopConsumer


consumer_object_list = []

class ChatConsumer(WebsocketConsumer):
    def websocket_connect(self, message):
        """
        客户端发来链接请求之后就会自动触发
        :param message:
        :return:
        """
        print('连接成功')
        self.accept()  # 向服务端发送加密字符串
        # self就是每一个客户端对象
        # 链接成功 我就将当前对象放入全局的列表中
        consumer_object_list.append(self)


    def websocket_receive(self, message):
        """
        客户端向服务端发送消息就会自动触发
        :param message:内部包含客户端给你发送的消息  {'type': 'websocket.receive', 'text': '大宝贝'}
        :return:
        """
        print('接收到新消息....')
        print(message)
        # 给客户端回消息
        # self.send(text_data=message.get('text'))

        # 给列表中所有的对象都发送消息
        for obj in consumer_object_list:
            obj.send('服务器回复信息..')


    def websocket_disconnect(self, message):
        """
        客户端主动断开链接之后自动触发
        :param message:
        :return:
        """
        print('断开链接了')
        # 服务端断开链接 就去列表中删除对应的客户端对象
        consumer_object_list.remove(self)
        raise StopConsumer

我们在创建个测试模板,chat 目录下创建个templates目录,里面创建个chat.html,先写上一下websocket连接的测试代码内容:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>chatting</h1>
</body>
<script>
var ws = new WebSocket("ws://127.0.0.1:8080/ws/chat/");
ws.onopen = function(evt) {  //绑定连接事件
　　console.log("Connection open ...");
　　ws.send("发送的数据");
};

ws.onmessage = function(evt) {//绑定收到消息事件
　　console.log( "Received Message: " + evt.data);
};

ws.onclose = function(evt) { //绑定关闭或断开连接事件
　　console.log("Connection closed.");
};


</script>
</html>

让后创建路由函数,在chat/view.py 下创建个index函数,内容如下:

from django.shortcuts import render
from django.http import HttpResponse
# Create your views here.
def index(request):
    return render(request, 'chat.html')

然后配置 url.py

from django.contrib import admin
from django.urls import path
from . import views
urlpatterns = [
    path('', views.index)
]

然后再主工程的url.py下include chat的url.py.这里就不演示了,这样我们启动服务,通过如下命令:

python3 manage.py runserver

这样默认就会启动了8000端口的服务,我们直接访问下面链接 http://127.0.0.1:8080/chat/,就会成功连接到websocket服务,可以打开控制台查看log,如下图:

image.png

看得懂上面的代码的小伙伴应该会发现我们的流程很正常,也就是客户端创建个连接,连接成功之后,我们客户端发送了个"发送的数x据"字符串,服务端,收到消息又回复了一条"服务器回复信息..",整个流程没有问题,这是在django的服务器上运行的效果,最终我们需要部署上线,以niginx反代理的形式访问,下面我们开始部署channels,具体步骤
1.上传代码到远程服务器
2,安装依赖环境,这里直接在本地导出requirements.txt,传入远程服务器直接运行以下

pip3 install -r requirements.txt

3.daphne 启动websocket 服务,这里我们websocket服务在8001端口启动

daphne -p 8001 -b 127.0.0.1 haomai.asgi:application

4.配置nginx反向代理

 upstream socket.haomai.com {
    server localhost:8001;
}

server {
    listen      8080;
    #server_name www.ziqiangxuetang.com;
    charset     utf-8;
 
    client_max_body_size 75M;
 
    location /static {
        alias /Users/shuaijiguang/Documents/项目仓库/我的项目/Django学习/haomai/haomai/static;
    }
 
      location /ws {
        proxy_pass http://socket.haomai.com;
       
    
    
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";

        proxy_redirect off;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Host $server_name;
    }

    location / {
        uwsgi_pass  127.0.0.1:9999;
        include     /Applications/MAMP/conf/nginx/uwsgi_params;
    }

}

主要是 /ws 配置内容,这里我遇到一个坑,困扰了我很长时间,死活websocket都不同,主要是 proxy_pass http://socket.haomai.com;我写成了 proxy_pass http://socket.haomai.com/;多了个斜杆,奶奶的,发现这个问题脑细胞死了一大片,重启nginx,这时我们发现js模板文件的ws访问地址还是本地的127.0.0.1,现在我们部署到了远程服务器了,我们得访问远程的地址,在这里还有一个非常非常重要的点,一开始我写的8001端口,因为我们websocket是8001端口,我访问发现死活不行,后来想明白了,我们是通过nginx反向代理访问的,所以说我们的访问地址的端口是你项目部署的端口,我这里是8080端口,这样不出意外你就成功了

尽管你现在websocket可以正常使用了,但是还得需要有优化的点,你可以尝试下把服务端的终端关闭,你在访问发现websocket的就出现无法访问的现象,这是因为daphne不是常驻线程的,这时候我们得需要常驻线程,我们就得借助supervisor来管理他了,非常方便,大致步骤分为以下几步

1.安装supervisor

pip3 install supervisor

安装成功之后,我们需要创建软连接,要不然你运行会发现找不到命令

ln -s /usr/local/python3/bin/supervisord  /usr/bin/supervisord

2.修改配置文件

配置文件所在目录 /etc/ supervisord.conf
配置daphne,我这里同时还配置了uwsgi,这里我附上我完整的配置内容

[supervisord]
nodaemon=true
[supervisorctl]

[program:daphne]
directory=/www/wwwroot/haomai/haomai  #项目目录
command=daphne -b 127.0.0.1 -p 8001 --proxy-headers haomai.asgi:application #启动命令
autostart=true
autorestart=true
stdout_logfile=/www/wwwroot/haomai/haomai/websocket.log  #日志
redirect_stderr=true

[program:uwsgi]
directory=/www/wwwroot/haomai/haomai/haomai  #项目目录
command=uwsgi --ini uwsgi.ini #启动命令
autostart=true
autorestart=true
stdout_logfile=/www/wwwroot/haomai/haomai/uwsgi.log  #日志
redirect_stderr=true

3.启动supervisor

我们执行以下命令开启 supervisor

supervisord -c /etc/supervisord.conf

这时候你再测试,我们关闭终端,程序正常访问,一直在常驻线程,到这里你们就完事了,为了更加的完美,我这里将supervisord加入了开机自启动设置,要不然每次重启服务器之后忘了开启supervisord,当前系统环境centos7具体的步骤如下

1.创建supervisord.service

我们在任意位置随便创建个这个文件,运行以下命令

touch supervisord.service
vi supervisord.service

2.写入以下内容

#supervisord.service

[Unit] 
Description=Supervisor daemon

[Service] 
Type=forking 
ExecStart=/usr/bin/supervisord -c /etc/supervisord.conf 
ExecStop=/usr/bin/supervisorctl shutdown 
ExecReload=/usr/bin/supervisorctl reload 
KillMode=process 
Restart=on-failure 
RestartSec=42s

[Install] 
WantedBy=multi-user.target

3.将文件拷贝到/usr/lib/systemd/system/

cp supervisord.service /usr/lib/systemd/system/

4.启动服务

systemctl enable supervisord

5.验证一下是否为开机启动

systemctl is-enabled supervisord

以上通过之后,重启服务器,我们直接访问发现都能正常访问,说明我们的uwsgi和daphne都通过supervisor自动起来了