Nginx+gunicorn部署flask项目

背景

在生产环境中不推荐使用 Flask 的 app.run() 方法，主要是因为这个方法是为开发环境设计的，它并不具备生产环境中所需的稳定性、性能和安全性 。开发服务器由 Werkzeug 提供，它被设计用来在开发时提供便利，但并不高效、稳定或安全 。相反，应该使用专门的生产 WSGI 服务器，例如 Gunicorn 或 Waitress 。

使用 app.run() 在生产环境中可能导致的问题包括但不限于：

• 它不支持多线程或多进程，这限制了其处理高并发的能力 。
• 它不包含生产环境中需要的安全特性，例如 HTTPS 支持和安全头设置 。
• 它不提供足够的日志记录和错误处理机制，这对于生产环境中监控和问题排查至关重要 。
• 它没有持久化配置，这意味着每次服务器重启时都需要重新配置 。

因此，为了在生产环境中部署 Flask 应用，推荐的做法是使用 WSGI 服务器如 Gunicorn ，并结合 Nginx 或 Apache 作为反向代理服务器来处理静态文件和SSL加密 。同时，确保配置了正确的日志记录、错误处理和性能监控机制 。

gunicorn 是一个python WSGI http server，我们这里采用它做 wsgi 服务器，来部署flask程序。

安装模块

pip3 install -i https://pypi.tuna.tsinghua.edu.cn/simple gunicorn

一般使用它，主要是为使用其异步的worker模型，还需要安装对应的异步模块。

pip3 install greenlet # 使用异步必须安装
pip3 install eventlet # 使用eventlet workers
pip3 install gevent   # 使用gevent workers

启动gunicorn

命令行启动

gunicorn 命令启动程序比较简单。以下面app.py 为例

from flask import Flask

app = Flask(__name__)

@app.route("/")
def index():
    return "hello world"

if __name__ == "__main__":
    app.run(debug=True, host="0.0.0.0", port="5000")

运行命令：

gunicorn -w 4 -b 0.0.0.0:5000 -t 60 app:app

持久化运行，使用nohup ，运行日志将存储于当前目录的app.log日志

nohup python -m gunicorn -w 4 -b 0.0.0.0:5000 -t 60 app:app > app.log 2>&1 &

-w :表示工作进程数

-b :访问地址和端口

-t: 设置超时时间60秒， 默认30秒

app:app：启动python文件名，冒号后面那个是Flask对象名

注意！

• windows不支持运行gunicorn 会报错ModuleNotFoundError: No module named 'fcntl'
• 如果手动指定过版本，或者安装flask是老版本，可能访问请求很慢，这个是版本不兼容导致，找到对应版本即可

其他可能用到的参数解释

-c CONFIG    : CONFIG,配置文件的路径，通过配置文件启动；生产环境使用；
-b ADDRESS   : ADDRESS，ip加端口，绑定运行的主机；
-w INT, --workers INT：用于处理工作进程的数量，为正整数，默认为1；
-k STRTING, --worker-class STRTING：要使用的工作模式，默认为sync异步，可以下载eventlet和gevent并指定
--threads INT：处理请求的工作线程数，使用指定数量的线程运行每个worker。为正整数，默认为1。
--worker-connections INT：最大客户端并发数量，默认情况下这个值为1000。
--backlog int：未决连接的最大数量，即等待服务的客户的数量。默认2048个，一般不修改；
-p FILE, --pid FILE：设置pid文件的文件名，如果不设置将不会创建pid文件
--access-logfile FILE   ：  要写入的访问日志目录
--access-logformat STRING：要写入的访问日志格式
--error-logfile FILE, --log-file FILE  ：  要写入错误日志的文件目录。
--log-level LEVEL   ：   错误日志输出等级。
--limit-request-line INT   ：  HTTP请求头的行数的最大大小，此参数用于限制HTTP请求行的允许大小，默认情况下，这个值为4094。值是0~8190的数字。
--limit-request-fields INT   ：  限制HTTP请求中请求头字段的数量。此字段用于限制请求头字段的数量以防止DDOS攻击，默认情况下，这个值为100，这个值不能超过32768
--limit-request-field-size INT  ：  限制HTTP请求中请求头的大小，默认情况下这个值为8190字节。值是一个整数或者0，当该值为0时，表示将对请求头大小不做限制
-t INT, --timeout INT：超过这么多秒后工作将被杀掉，并重新启动。一般设定为30秒；
--daemon： 是否以守护进程启动，默认false；
--chdir： 在加载应用程序之前切换目录；
--graceful-timeout INT：默认情况下，这个值为30，在超时(从接收到重启信号开始)之后仍然活着的工作将被强行杀死；一般使用默认；
--keep-alive INT：在keep-alive连接上等待请求的秒数，默认情况下值为2。一般设定在1~5秒之间。
--reload：默认为False。此设置用于开发，每当应用程序发生更改时，都会导致工作重新启动。
--spew：打印服务器执行过的每一条语句，默认False。此选择为原子性的，即要么全部打印，要么全部不打印；
--check-config   ：显示现在的配置，默认值为False，即显示。
-e ENV, --env ENV： 设置环境变量；

配置文件启动

创建gunicorn 配置文件，文件名建议gunicorn.conf.py

# 并行工作进程数
workers = 4
 
# 指定每个工作者的线程数
threads = 2
 
 # 端口 5000
bind = '0.0.0.0:5000'
 
# 是否后台运行
daemon = True

## 修改是否重新加载
reload = True

# 工作模式协程
worker_class = 'gevent'

# 设置最大并发量
worker_connections = 2000

# 设置进程文件目录
pidfile = '/var/run/gunicorn.pid'

# 设置访问日志和错误信息日志路径
accesslog = "log/access.log"
errorlog = "log/debug.log"
loglevel = "debug"

# 设置日志记录水平
loglevel = 'warning'

运行命令

gunicorn -c gunicorn.conf.py app:app

其他可能用到的配置项

import logging
import logging.handlers
import os
import multiprocessing
import gevent.monkey
gevent.monkey.patch_all()

bind = '0.0.0.0:8080'  # 绑定的ip已经端口号
chdir = '/home/flaskProject'  # gunicorn要切换到的目的工作目录
timeout = 60  # 超时
worker_class = 'gevent'  # 使用gevent模式，还可以使用sync 模式，默认的是sync模式
workers = multiprocessing.cpu_count() * 2 + 1  # 启动的进程数
loglevel = "info"  # 日志级别，这个日志级别指的是错误日志的级别，而访问日志的级别无法设置
access_log_format = '%(t)s %(p)s %(h)s "%(r)s" %(s)s %(L)s %(b)s %(f)s" "%(a)s"'  # 设置gunicorn访问日志格式，错误日志无法设置
pidfile = "gunicorn.pid"
accesslog = "access.log"
errorlog = "error.log"
daemon = True  # 是否后台运行

结束所有的gunicorn 进程

kill -9 `ps -ef | grep gunicorn | awk '{print $2}'`

启动Nginx

Nginx 实际上只能处理静态资源请求，那么对于动态请求怎么做呢。这就需要用到 Nginx 的 upstream 模块对这些请求进行转发，即反向代理。Nginx 在这里主要是用来做负载均衡，同时它能缓存一些动态内容。

yum -y install epel-release
yum -y install nginx
systemctl enable --now nginx

配置虚拟主机

vim /etc/nginx/conf.d/flask.conf
server {
    listen     8080; # 监听8080端口,可以自行配置
    server_name _; # 配置域名

    # 动态请求转发到 5000 端口(gunicorn):
    location / {
        proxy_pass   http://127.0.0.1:5000;
        proxy_redirect off;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header Host $host;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
       proxy_read_timeout 300;
       proxy_send_timeout 300;
    }
}

# 修改完之后保存，重启 nginx.
systemctl restart nginx

访问测试一下，没有问题

supervisor

使用supervisor 作为gunicorn 的服务监控，可以对gunicorn 进行自启动，异常检测，自动重启等等

首先将gunicorn.conf.py 配置文件中的后台运行改成False

# 是否后台运行
daemon = False

安装supervisor

yum -y install supervisor

启动supervisor

systemctl enable --now supervisord

推荐直接在/etc/supervisor.d/下创建子配置文件

修改配置文件

在/etc/supervisor.d/flask.ini 子配置文件添加相应配置

[program:project]  
directory = /root/flask       ; 程序的启动目录  
command = /usr/local/bin/gunicorn -c /root/flask/gunicorn.conf.py app:app  ; 启动命令

numprocs=1           ; number of processes copies to start (def 1)   
autostart = true     ; 在 supervisord 启动的时候也自动启动   
startsecs = 1        ; 启动 1 秒后没有异常退出，就当作已经正常启动了   
autorestart = true   ; 程序异常退出后自动重启   
startretries = 3     ; 启动失败自动重试次数，默认是 3   
user = root          ; 用哪个用户启动   
redirect_stderr = true          ; 把 stderr 重定向到 stdout，默认 false   
stdout_logfile_maxbytes = 20MB  ; stdout 日志文件大小，默认 50MB   
stdout_logfile_backups = 10     ; stdout 日志文件备份数 
stdout_logfile=/root/flask/log/access.log      ; log 日志
stderr_logfile=/root/flask/log/error.log     ; 错误日志

编辑完之后保存，启动 supervisor。这里的启动命令和在命令行用 gunicorn 启动的命令是一致的。

supervisor基本命令

重启supervisor命令

systemctl restart supervisord

通过配置文件启动 supervisor

supervisord -c supervisor.conf

查看 supervisor 的状态

supervisorctl -c supervisor.conf status 

重新载入配置文件,每次修改之后记得重新载入

supervisorctl -c supervisor.conf reload

启动指定/所有 supervisor 管理的程序进程

supervisorctl -c supervisor.conf start [all]|[appname]

关闭指定/所有 supervisor管理的程序进程

supervisorctl -c supervisor.conf stop [all]|[appname]