FastAPI+Gunicorn+Nginx部署(超详细)

前言

系统使用: Ubuntu22.04 (用户名:ubuntu)
Python版本: Python3.10 (虚拟环境:fastapi_env )
数据库: MySQL5.7
本项目使用 以下工具

• FastAPI
• Gunicorn
• uvicorn
• Nginx
• supervisor

项目结构

项目路径 /data/www/fast-tortoise

└── fast-tortoise
    ├── aerich
    ├── common
    ├── conf
    ├── control
    ├── logs
    ├── middleware
    ├── models
    ├── schemas
    ├── static
    ├── utils
    ├──views
    ├── main.py
    ├── create_superuser.py
    ├── gunicorn.conf.py
    ├── supervisor.conf
    ├── nginx.conf
    ├── README.md
    └── requirements.txt
    

依赖包

aerich==0.6.3
aiomysql==0.1.1
aioredis==2.0.1
aiosqlite==0.17.0
anyio==3.6.1
async-timeout==4.0.2
autopep8==1.7.0
click==8.1.3
dictdiffer==0.9.0
dnspython==2.2.1
ecdsa==0.18.0
email-validator==1.2.1
fastapi==0.79.0
fastapi-pagination==0.9.3
gunicorn==20.1.0
h11==0.13.0
idna==3.3
iso8601==1.0.2
loguru==0.6.0
passlib==1.7.4
pyasn1==0.4.8
pycodestyle==2.9.1
pydantic==1.9.2
PyMySQL==1.0.2
pypika-tortoise==0.1.6
python-jose==3.3.0
python-multipart==0.0.5
pytz==2022.2.1
rsa==4.9
six==1.16.0
sniffio==1.2.0
starlette==0.19.1
supervisor==4.2.4
toml==0.10.2
tomlkit==0.11.3
tortoise-orm==0.19.2
typing_extensions==4.3.0
uvicorn==0.18.2

入口文件

import uvicorn
from fastapi import FastAPI
from views import register_router
from conf.config import settings
from common.database import register_db
from common.redis import register_redis
from common import register_static_file
from middleware.cors import register_middleware
from fastapi_pagination import add_pagination

app = FastAPI(
    title=settings.TITLE,
    description=settings.DESC,
    version=settings.VERSION
)

# 静态文件注册
register_static_file(app)

# 注册中间件
register_middleware(app)

# 注册路由
register_router(app)

# 数据库连接
register_db(app)

# 连接redis
# register_redis(app)

# 注册分页
add_pagination(app)

if __name__ == '__main__':
    uvicorn.run("main:app", host="127.0.0.1", port=5000, reload=True, debug=True)

文件配置

gunicorn

# 监听内网端口
bind = '0.0.0.0:5000'

# 工作目录
chdir = './'

# 并行工作进程数
workers = 4

# 指定每个工作者的线程数
threads = 4

# 监听队列
backlog = 512

# 超时时间
timeout = 120

# 设置守护进程,将进程交给 supervisor 管理；如果设置为 True 时，supervisor 启动日志为：
# gave up: fastapi_server entered FATAL state, too many start retries too quickly
# 则需要将此改为: False
daemon = False

# 工作模式协程
worker_class = 'uvicorn.workers.UvicornWorker'

# 设置最大并发量
worker_connections = 2000

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

# 设置访问日志和错误信息日志路径
# accesslog = './logs/gunicorn_access.log'
# errorlog = './logs/gunicorn_error.log'

# 如果supervisor管理gunicorn
errorlog = '-'
accesslog = '-'

# 设置gunicron访问日志格式，错误日志无法设置
access_log_format = '%(h) -  %(t)s - %(u)s - %(s)s %(H)s'

# 设置这个值为true 才会把打印信息记录到错误日志里
capture_output = True

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


# python程序
pythonpath = '/home/ubuntu/.virtualenvs/fastapi_env/lib/python3.10/site-packages'

# 启动 gunicorn -c gunicorn.conf.py main:app

# pstree -ap|grep gunicorn

supervisor

; Sample supervisor config file.
;
; For more information on the config file, please see:
; http://supervisord.org/configuration.html
;
; Notes:
;  - Shell expansion ("~" or "$HOME") is not supported.  Environment
;    variables can be expanded using this syntax: "%(ENV_HOME)s".
;  - Quotes around values are not supported, except in the case of
;    the environment= options as shown below.
;  - Comments must have a leading space: "a=b ;comment" not "a=b;comment".
;  - Command will be truncated if it looks like a config file comment, e.g.
;    "command=bash -c 'foo ; bar'" will truncate to "command=bash -c 'foo ".
;
; Warning:
;  Paths throughout this example file use /tmp because it is available on most
;  systems.  You will likely need to change these to locations more appropriate
;  for your system.  Some systems periodically delete older files in /tmp.
;  Notably, if the socket file defined in the [unix_http_server] section below
;  is deleted, supervisorctl will be unable to connect to supervisord.

[unix_http_server]
file=/tmp/supervisor.sock   ; the path to the socket file
;chmod=0700                 ; socket file mode (default 0700)
;chown=nobody:nogroup       ; socket file uid:gid owner
;username=user              ; default is no username (open server)
;password=123               ; default is no password (open server)

; Security Warning:
;  The inet HTTP server is not enabled by default.  The inet HTTP server is
;  enabled by uncommenting the [inet_http_server] section below.  The inet
;  HTTP server is intended for use within a trusted environment only.  It
;  should only be bound to localhost or only accessible from within an
;  isolated, trusted network.  The inet HTTP server does not support any
;  form of encryption.  The inet HTTP server does not use authentication
;  by default (see the username= and password= options to add authentication).
;  Never expose the inet HTTP server to the public internet.

[inet_http_server]         ; inet (TCP) server disabled by default
port=*:9001        ; ip_address:port specifier, *:port for all iface
;username=user              ; default is no username (open server)
;password=123               ; default is no password (open server)

[supervisord]
logfile=/tmp/supervisord.log ; main log file; default $CWD/supervisord.log
logfile_maxbytes=50MB        ; max main logfile bytes b4 rotation; default 50MB
logfile_backups=10           ; # of main logfile backups; 0 means none, default 10
loglevel=info                ; log level; default info; others: debug,warn,trace
pidfile=/tmp/supervisord.pid ; supervisord pidfile; default supervisord.pid
nodaemon=false               ; start in foreground if true; default false
silent=false                 ; no logs to stdout if true; default false
minfds=1024                  ; min. avail startup file descriptors; default 1024
minprocs=200                 ; min. avail process descriptors;default 200
;umask=022                   ; process file creation umask; default 022
user=ubuntu                   ; setuid to this UNIX account at startup; recommended if root
;identifier=supervisor       ; supervisord identifier, default is 'supervisor'
;directory=/tmp              ; default is not to cd during start
;nocleanup=true              ; don't clean up tempfiles at start; default false
;childlogdir=/tmp            ; 'AUTO' child log dir, default $TEMP
;environment=KEY="value"     ; key value pairs to add to environment
;strip_ansi=false            ; strip ansi escape codes in logs; def. false

; The rpcinterface:supervisor section must remain in the config file for
; RPC (supervisorctl/web interface) to work.  Additional interfaces may be
; added by defining them in separate [rpcinterface:x] sections.

[rpcinterface:supervisor]
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface

; The supervisorctl section configures how supervisorctl will connect to
; supervisord.  configure it match the settings in either the unix_http_server
; or inet_http_server section.

[supervisorctl]
;serverurl=unix:///tmp/supervisor.sock ; use a unix:// URL  for a unix socket
serverurl=http://127.0.0.1:9001 ; use an http:// url to specify an inet socket
;username=chris              ; should be same as in [*_http_server] if set
;password=123                ; should be same as in [*_http_server] if set
;prompt=mysupervisor         ; cmd line prompt (default "supervisor")
;history_file=~/.sc_history  ; use readline history if available

; The sample program section below shows all possible program subsection values.
; Create one or more 'real' program: sections to be able to control them under
; supervisor.

;[program:theprogramname]
;command=/bin/cat              ; the program (relative uses PATH, can take args)
;process_name=%(program_name)s ; process_name expr (default %(program_name)s)
;numprocs=1                    ; number of processes copies to start (def 1)
;directory=/tmp                ; directory to cwd to before exec (def no cwd)
;umask=022                     ; umask for process (default None)
;priority=999                  ; the relative start priority (default 999)
;autostart=true                ; start at supervisord start (default: true)
;startsecs=1                   ; # of secs prog must stay up to be running (def. 1)
;startretries=3                ; max # of serial start failures when starting (default 3)
;autorestart=unexpected        ; when to restart if exited after running (def: unexpected)
;exitcodes=0                   ; 'expected' exit codes used with autorestart (default 0)
;stopsignal=QUIT               ; signal used to kill process (default TERM)
;stopwaitsecs=10               ; max num secs to wait b4 SIGKILL (default 10)
;stopasgroup=false             ; send stop signal to the UNIX process group (default false)
;killasgroup=false             ; SIGKILL the UNIX process group (def false)
;user=root                     ; setuid to this UNIX account to run the program
;redirect_stderr=true          ; redirect proc stderr to stdout (default false)
;stdout_logfile=/a/path        ; stdout log path, NONE for none; default AUTO
;stdout_logfile_maxbytes=1MB   ; max # logfile bytes b4 rotation (default 50MB)
;stdout_logfile_backups=10     ; # of stdout logfile backups (0 means none, default 10)
;stdout_capture_maxbytes=1MB   ; number of bytes in 'capturemode' (default 0)
;stdout_events_enabled=false   ; emit events on stdout writes (default false)
;stdout_syslog=false           ; send stdout to syslog with process name (default false)
;stderr_logfile=/a/path        ; stderr log path, NONE for none; default AUTO
;stderr_logfile_maxbytes=1MB   ; max # logfile bytes b4 rotation (default 50MB)
;stderr_logfile_backups=10     ; # of stderr logfile backups (0 means none, default 10)
;stderr_capture_maxbytes=1MB   ; number of bytes in 'capturemode' (default 0)
;stderr_events_enabled=false   ; emit events on stderr writes (default false)
;stderr_syslog=false           ; send stderr to syslog with process name (default false)
;environment=A="1",B="2"       ; process environment additions (def no adds)
;serverurl=AUTO                ; override serverurl computation (childutils)

; The sample eventlistener section below shows all possible eventlistener
; subsection values.  Create one or more 'real' eventlistener: sections to be
; able to handle event notifications sent by supervisord.

;[eventlistener:theeventlistenername]
;command=/bin/eventlistener    ; the program (relative uses PATH, can take args)
;process_name=%(program_name)s ; process_name expr (default %(program_name)s)
;numprocs=1                    ; number of processes copies to start (def 1)
;events=EVENT                  ; event notif. types to subscribe to (req'd)
;buffer_size=10                ; event buffer queue size (default 10)
;directory=/tmp                ; directory to cwd to before exec (def no cwd)
;umask=022                     ; umask for process (default None)
;priority=-1                   ; the relative start priority (default -1)
;autostart=true                ; start at supervisord start (default: true)
;startsecs=1                   ; # of secs prog must stay up to be running (def. 1)
;startretries=3                ; max # of serial start failures when starting (default 3)
;autorestart=unexpected        ; autorestart if exited after running (def: unexpected)
;exitcodes=0                   ; 'expected' exit codes used with autorestart (default 0)
;stopsignal=QUIT               ; signal used to kill process (default TERM)
;stopwaitsecs=10               ; max num secs to wait b4 SIGKILL (default 10)
;stopasgroup=false             ; send stop signal to the UNIX process group (default false)
;killasgroup=false             ; SIGKILL the UNIX process group (def false)
;user=chrism                   ; setuid to this UNIX account to run the program
;redirect_stderr=false         ; redirect_stderr=true is not allowed for eventlisteners

;[group:thegroupname]
;programs=progname1,progname2  ; each refers to 'x' in [program:x] definitions
;priority=999                  ; the relative start priority (default 999)

; The [include] section can just contain the "files" setting.  This
; setting can list multiple files (separated by whitespace or
; newlines).  It can also contain wildcards.  The filenames are
; interpreted as relative to this file.  Included files *cannot*
; include files themselves.

;[include]
;files = relative/directory/*.ini

[program:fastapi_server]
directory=./
command=gunicorn -c gunicorn.conf.py main:app
user=ubuntu
autostart=true
autorestart=true
                                                                     
startretries=5
redirect_stderr=true
stdout_logfile=./logs/fastapi_server.log
loglevel=info


; supervisord -c supervisor.conf
; ps aux|grep supervisord
; ps aux|grep gunicorn
; killall gunicorn
; supervisorctl reload

主要配置

[program:fastapi_server]
directory=./
command=gunicorn -c gunicorn.conf.py main:app
user=ubuntu
autostart=true
autorestart=true
startretries=5
redirect_stderr=true
stdout_logfile=./logs/fastapi_server.log
loglevel=info

nginx

文件路径 /etc/nginx/conf.d/fastapi.conf

server {
      listen 80;
      root /data/www/fast-tortoise;
      server_name 10.16.168.61;
      location / {
            proxy_set_header x-Real-IP $remote_addr;
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
            proxy_set_header Host $http_host;
            proxy_pass http://127.0.0.1:5000/; # gunicorn绑定的fastapi的端口号
        }
      # 配置static的静态文件：
      location ~ ^\/static\/.*$ {
            root /data/www/fast-tortoise/static;
         }
}

启动

项目主目录下运行命令

supervisord -c supervisor.conf

其他命令

• supervisorctl reload 重新加载配置文件启动
• supervisorctl status 查看运行状态