本教程适用于以下操作系统版本

  • Ubuntu 22.04 (Jammy Jellyfish)
  • Ubuntu 20.04 (Focal Fossa)

本页内容

  • 先决条件
  • 设置新用户
  • 安装软件包依赖
  • 搭建开发环境
  • 在虚拟环境中安装 Python Flask
  • 使用 Flask 创建第一个应用项目
  • 配置 Gunicorn
  • 使用 Gunicorn 和 Supervisor 运行 Flask 应用
  • 将 Nginx 设置为 Flask 应用的反向代理
  • 结论

Flask 是一个用 Python 编写的微框架,用于开发现代 Web 应用和 API(Application Programming Interface)。它基于 Werkzeug 工具集和 Jinja2 模板。Flask 不采用复杂的架构,而是一个小型 Web 框架,核心易于扩展,并且由于代码量较少而易于学习。Flask 不包含 ORM,但仍拥有 URL 路由和模板引擎等实用功能。

Gunicorn 即「Green Unicorn」,是一个采用 pre-fork worker 模式的 WSGI HTTP Server。它移植自 Ruby 的 Unicorn 项目。Gunicorn 可与多种 Web 框架搭配使用,对服务器资源占用轻且速度快。Gunicorn 位于你的应用与 Web 服务器之间,因此你可以将 Gunicorn 与 Nginx、Apache2 等 Web 服务器配合使用。

在本文中,我们将向你展示如何在 Ubuntu 22.04 系统上安装和配置搭配 Gunicorn 与 Nginx 的 Python Flask Web 框架。本教程还涵盖如何结合 Gunicorn 和 Supervisord 搭建 Python Flask。

先决条件

阅读本指南前,你需要满足以下先决条件:

  • 一台 Ubuntu 22.04 系统 —— 你可以使用 Ubuntu 22.04 Desktop 或 Server 版本。
  • 一个 root 用户 —— 或非 root 用户。

设置新用户

第一步,你将为 Python Flask Web 框架的开发环境设置一个新用户。如果你已经拥有具备 root/sudo 权限的非 root 用户,可以跳过此步骤。该用户将用于运行 Python Flask 应用。

在本例中,你将创建一个名为「james」的新用户。运行以下命令创建新用户「james」并为用户「james」设置密码。请务必使用强密码。

sudo useradd -m -s /bin/bash james
sudo passwd james

接下来,使用下面的命令将用户「james」添加到「sudo」组。这将允许新用户「james」执行「sudo su」命令并获得 root 管理员权限,而这是安装软件包和设置系统配置所必需的。

sudo usermod -aG sudo james

最后,以用户「james」登录并运行「sudo su」命令来验证新用户并获取 root 权限。输入用户「james」的密码后,你将进入 root shell。当前 shell 会从「james@hostname」变为「root@hostname」。

su - james
sudo su

在 Ubuntu 22.04 系统上通过 Gunicorn 与 Nginx 部署 Flask 应用完整教程

现在按「Ctrl+d」或输入「exit」返回到非 root 用户「james」。

安装软件包依赖

现在你将为安装 Python Flask 安装一些软件包依赖,其中包括「python3-pip」和「python3-venv」。最后,你还将安装 Nginx Web 服务器和 supervisor。

在开始安装软件包之前,运行下面的 apt 命令更新并刷新你的软件包仓库。

sudo apt update

现在使用以下命令安装 python3-pip 和 python3-venv。python3-pip 将用作 Python 软件包的包管理器,而 python3-venv 将用于为 Flask 应用开发创建虚拟环境。

sudo apt install python3-pip python3-venv

输入 Y 确认安装并按 ENTER 继续。安装将开始。

在 Ubuntu 22.04 系统上通过 Gunicorn 与 Nginx 部署 Flask 应用完整教程

安装完成后,运行以下命令在 Ubuntu 系统上设置默认的 Python。

sudo update-alternatives --install /usr/bin/python python /usr/bin/python3 10

现在运行以下命令验证 Python 和 Pip 的版本,并检查 Python venv 模块。在下面的示例中,你将使用 Python 3.10 安装 Python Flask Web 框架。

python --version
pip --version
python -m venv -h

在 Ubuntu 22.04 系统上通过 Gunicorn 与 Nginx 部署 Flask 应用完整教程

接下来,运行以下 apt 命令安装 Nginx Web 服务器和 supervisor 软件包。Nginx Web 服务器将用作 Python Flask Web 框架的默认 Web 服务器,而 supervisor 将用于控制 Flask 应用,例如启动和停止 Flask 进程。

sudo apt install nginx supervisor

输入 Y 确认安装并按 ENTER 继续。等待软件包安装完成。

在 Ubuntu 22.04 系统上通过 Gunicorn 与 Nginx 部署 Flask 应用完整教程

搭建开发环境

在本节中,你将创建一个新的 Python 虚拟环境,用作 Python Flask Web 框架的开发环境。

运行以下命令创建新的项目目录「/var/www/myapp」。该目录将用作你的 Flask 应用的主项目目录。

sudo mkdir -p /var/www/myapp

使用下面的命令将新目录的所有权更改为用户「james」,并将权限更改为「755」。

sudo chown -R james:james /var/www/myapp
sudo chmod 755 /var/www/myapp

切换到项目目录「/var/www/myapp」,并使用以下命令创建名为「myenv」的新 Python 虚拟环境。

cd /var/www/myapp
python -m venv myenv

最后,使用以下命令激活虚拟环境「myenv」。激活后,你的 shell 提示符将变为「(myenv) james@hostname」。

source myenv/bin/activate

在 Ubuntu 22.04 系统上通过 Gunicorn 与 Nginx 部署 Flask 应用完整教程

在虚拟环境中安装 Python Flask

设置好虚拟环境后,你可以运行下面的 pip 命令,在虚拟环境中安装 Python Flask 和 Gunicorn。所有这些软件包都将从 PyPi Python 仓库安装。

pip install flask gunicorn

现在安装将开始。

在 Ubuntu 22.04 系统上通过 Gunicorn 与 Nginx 部署 Flask 应用完整教程

使用 Flask 创建第一个应用项目

你现在已经安装了 Python Flask Web 框架。接下来将使用 Flask 创建第一个应用。

在创建 Flask 项目之前,请确保你位于主项目目录「/var/www/myapp」中,并且虚拟环境「myenv」已激活。

使用 nano 编辑器创建一个新文件「myapp.py」。

nano myapp.py

现在将以下 Python 脚本添加到该文件中。

# myapp.py
from flask import Flask, render_template  # importing the render_template function
app = Flask(__name__)
# route to index page
@app.route("/")
def hello():
    return render_template('index.html')
if __name__ == ' __main__':
    app.run(debug=True)

完成后保存并关闭文件。

接下来,创建一个新目录「templates」,并在「template」目录中创建一个新文件「index.html」。

mkdir -p templates/
nano templates/index.html

将以下 HTML 脚本添加到其中。

<html>
    <body>
        <h1><center>Hello World!</center></h1>
    </body>
</html>

完成后保存并关闭文件。

最后,运行脚本「myapp.py」来启动你的第一个 Flask 应用。

python myapp.py

你将看到你的 Flask 项目正在默认的 localhost 上运行,端口为 5000。

在 Ubuntu 22.04 系统上通过 Gunicorn 与 Nginx 部署 Flask 应用完整教程

打开 Ubuntu 机器的新终端 shell,并运行下面的 curl 命令。

curl http://127.0.0.1:5000/

现在你可以在下面的截图中看到 index.html 页面的输出。

在 Ubuntu 22.04 系统上通过 Gunicorn 与 Nginx 部署 Flask 应用完整教程

要终止 Flask 应用进程,你可以按「Ctrl+c」。

配置 Gunicorn

Gunicorn 即「Green Unicorn」,是面向 HTTP 服务器的 Python Web 服务器网关接口。它允许你以 HTTP 进程或使用 sock 文件的方式运行 Python 应用。现在你将把 Gunicorn 添加到你的 Flask 项目中。

在 Flask 项目目录中,使用 nano 编辑器创建一个新文件「wsgi.py」。

nano wsgi.py

将以下脚本添加到其中。

# import myapp Flask application
from myapp import app
if __name__ == "__main__":
    app.run(debug=True)

完成后保存并关闭文件。

接下来,运行以下命令,使用 Gunicorn 启动并运行你的 Flask 项目。在本例中,你的 Flask 项目将运行在公共 IP 地址的 8000 端口上。

gunicorn -w 4 --bind 0.0.0.0:8000 wsgi:app

在 Ubuntu 22.04 系统上通过 Gunicorn 与 Nginx 部署 Flask 应用完整教程

打开 Web 浏览器,输入 Ubuntu 系统的 IP 地址和 8000 端口(例如 http://192.168.5.28:8000/ )。你应该能看到 Flask 项目的 index 页面。

在 Ubuntu 22.04 系统上通过 Gunicorn 与 Nginx 部署 Flask 应用完整教程

现在按「Ctrl+c」终止 Gunicorn 进程。

使用 Gunicorn 和 Supervisor 运行 Flask 应用

现在你已经为 Flask 项目配置好了 Gunicorn。接下来就是为 Flask Web 框架设置 Supervisor 的时候了。

supervisor 是一种进程管理工具,可让你在一处集中控制进程。因此,你将使用 Supervisor,而不是将 Flask 应用作为系统服务来运行。

使用 nano 编辑器创建一个新配置文件「/etc/supervisor/conf.d/myapp.conf」。

sudo nano /etc/supervisor/conf.d/myapp.conf

将以下配置添加到该文件中。请务必修改配置中的具体路径和用户。

使用此配置,你将通过 Gunicorn 运行 Flask 项目,并且不使用 IP 地址,而是以 sock 文件的方式运行 Flask 项目。

[program:myapp] 
command=/bin/bash -c 'source /var/www/myapp/myenv/bin/activate; gunicorn -w 3 --bind unix:/var/www/myapp/ipc.sock wsgi:app'
directory=/var/www/myapp
user=james
group=www-data
autostart=true 
autorestart=true 
stdout_logfile=/var/www/myapp/myapp.log 
stderr_logfile=/var/www/myapp/error.log

完成后保存并关闭文件。

现在使用下面的命令重启 supervisor 服务以应用新的更改。

sudo systemctl restart supervisor

最后,使用以下命令检查并验证 Supervisor 下的进程列表。你应该能看到「myapp」进程正在运行。

sudo supervisorctl status

如果你检查 supervisor 服务,会看到该服务处于活动(active)状态并正在运行。

sudo systemctl status supervisor

在 Ubuntu 22.04 系统上通过 Gunicorn 与 Nginx 部署 Flask 应用完整教程

将 Nginx 设置为 Flask 应用的反向代理

使用 nano 编辑器创建一个新的虚拟主机配置「/etc/nginx/sites-available/myapp.conf」。

sudo nano /etc/nginx/sites-available/myapp.conf

将以下配置添加到该文件中。在本例中,Flask 项目将运行在本地域名「www.myapp.local」下。此外,你可以看到「proxy_pass」选项指向由 Gunicorn 和 Supervisor 运行的 UNIX sock 文件。

server {
    listen 80;
    server_name www.myapp.local;
    location / {
        include proxy_params;
        proxy_pass http://unix:/var/www/myapp/ipc.sock;
    }
}

完成后保存并关闭文件。

接下来,运行以下命令激活 server block 配置「myapp.conf」,然后验证 Nginx 配置。如果没有出现任何错误,你将看到类似「Syntax OK - test successful」的输出消息。

sudo ln -s /etc/nginx/sites-available/myapp.conf /etc/nginx/sites-enabled/
sudo nginx -t

之后,你可以使用以下命令重启 Nginx 服务,以应用对 Nginx 配置的新更改。

sudo systemctl restart nginx

现在在你的本地机器上,使用 nano 编辑器编辑 /etc/hosts 文件。

sudo nano /etc/hosts

按如下方式定义 Ubuntu 机器的 IP 地址与域名「www.myapp.local」。

192.168.5.28 www.myapp.local

保存并关闭文件。

现在打开 Web 浏览器,在地址栏中输入 Flask 项目的域名(例如 http://www.myapp.local)。你应该能看到 Python Flask 项目的 index 页面。

在 Ubuntu 22.04 系统上通过 Gunicorn 与 Nginx 部署 Flask 应用完整教程

结论

恭喜!你已在 Ubuntu 22.04 机器上成功安装了搭配 Gunicorn 和 Nginx 的 Python Flask Web 框架。你还学习了如何创建第一个 Python Flask 项目、设置 Python 虚拟环境,以及为 Flask 项目设置 Supervisor 进程管理。