你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

在 Azure 中部署使用 PostgreSQL 的 Python（Django 或 Flask）Web 应用

项目
08/28/2023

在本教程中，你要将一个使用 Azure Database for PostgreSQL 关系数据库服务的数据驱动 Python Web 应用（Django 或 Flask）部署到 Azure 应用服务。 Azure 应用服务支持 Linux 服务器环境中的 Python。

若要完成本教程，你需要：

具有活动订阅的 Azure 帐户。如果没有 Azure 帐户，可以免费创建一个。
了解使用 Flask 的 Python 开发或使用 Django 的 Python 开发

示例应用程序

我们提供了使用 Flask 和 Django 框架的示例 Python 应用程序来帮助你学习本教程。若要部署这些应用程序但不在本地运行它们，请跳过本部分。

若要在本地运行应用程序，请确保在本地安装 Python 3.7 或更高版本和 PostgreSQL。然后下载或克隆应用：

Flask
Django

git clone https://github.com/Azure-Samples/msdocs-flask-postgresql-sample-app.git

git clone https://github.com/Azure-Samples/msdocs-django-postgresql-sample-app.git

转到应用程序文件夹：

Flask
Django

cd msdocs-python-flask-webapp-quickstart

cd msdocs-django-postgresql-sample-app

使用 .env.sample 文件作为指南创建 .env 文件，如下所示。将 DBNAME 的值设置为本地 PostgreSQL 实例中现有数据库的名称。根据本地 PostgreSQL 实例设置相应的 DBHOST、DBUSER 和 DBPASS 值。

DBNAME=<database name>
DBHOST=<database-hostname>
DBUSER=<db-user-name>
DBPASS=<db-password>

通过在终端提示符下运行以下命令，为应用创建 SECRET_KEY 值：python -c 'import secrets; print(secrets.token_hex())'。

将返回的值设置为 .env 文件中 SECRET_KEY 的值。

SECRET_KEY=<secret-key>

为应用创建一个虚拟环境：

Windows
macOS/Linux

py -m venv .venv
.venv\scripts\activate

python3 -m venv .venv
source .venv/bin/activate

安装依赖项：

pip install -r requirements.txt

使用以下命令运行示例应用程序：

Flask
Django

# Run database migration
flask db upgrade
# Run the app at http://127.0.0.1:5000
flask run

# Run database migration
python manage.py migrate
# Run the app at http://127.0.0.1:8000
python manage.py runserver

1. 创建应用服务和 PostgreSQL

此步骤创建 Azure 资源。本教程中使用的步骤创建一组默认安全的资源，其中包括应用服务和 Azure Database for PostgreSQL。此创建过程中，你将指定：

Web 应用的名称。此名称用作 Web 应用的 DNS 名称的一部分，其格式为 https://<app-name>.azurewebsites.net。
“区域”，在世界上以物理方式运行应用。
应用的运行时堆栈。在此处选择要用于应用的 Python 版本。
应用的托管计划。它是定价层，包括应用的一组功能和缩放容量。
应用的资源组。使用资源组可将应用程序所需的所有 Azure 资源分组到一个逻辑容器中。

登录到 Azure 门户并按照以下步骤创建 Azure 应用服务资源。

步骤 1：在Azure 门户中：

在 Azure 门户顶部的搜索栏中，输入“Web 应用数据库”。
选择“市场”标题下标记为“Web 应用 + 数据库”的项目。还可以直接导航到创建向导。

步骤 2：在“创建 Web 应用 + 数据库”页上，按下面所述填写表单。

资源组 → 选择“新建”，然后使用名称 msdocs-python-postgres-tutorial。
区域 → 与你靠近的任何 Azure 区域。
名称 → msdocs-python-postgres-XYZ，其中 XYZ 是任意三个随机字符。该名称在 Azure 中必须唯一。
运行时堆栈 → Python 3.10。
数据库 → 默认已选择“PostgreSQL 灵活服务器”作为数据库引擎。默认情况下，服务器名称和数据库名称也会设置为适当的值。
托管计划 → 基本。准备就绪后，可以稍后纵向扩展到生产定价层。
选择“查看 + 创建”。
验证完成后，选择“创建”。

步骤 3：该部署需要数分钟才能完成。部署完成后，选择“转到资源”按钮。这将直接转到应用服务应用，但会创建以下资源：

资源组 → 所有已创建资源的容器。
应用服务计划 → 定义应用服务的计算资源。将创建基本层中的 Linux 计划。
应用服务 → 表示应用，且在应用服务计划中运行。
虚拟网络 → 与应用服务应用集成，并隔离后端网络流量。
Azure Database for PostgreSQL 灵活服务器 → 只能从虚拟网络内部访问。你的数据库和用户创建于此服务器上。
专用 DNS 区域 → 在虚拟网络中启用 PostgreSQL 服务器的 DNS 解析。

2. 验证连接设置

创建向导已经为你生成了连接变量作为应用设置。使用应用设置可以将连接机密保留在代码存储库之外。准备好将机密移动到更安全的位置后，下面提供了一篇有关在 Azure 密钥保管库中存储的文章。

步骤 1：在“应用服务”页的左侧菜单中，选择“配置”。

步骤 2：在“配置”页的“应用程序设置”选项卡中，验证 AZURE_POSTGRESQL_CONNECTIONSTRING 是否存在。它将作为环境变量注入到运行时环境中。

步骤 3：在终端或命令提示符下，运行以下 Python 脚本来生成唯一机密：python -c 'import secrets; print(secrets.token_hex())'。复制输出值以在下一步中使用。

步骤 4：在“配置”页的“应用程序设置”选项卡中，选择“新建应用程序设置”。将设置命名为 SECRET_KEY。粘贴上文值中的值。选择“确定”。

步骤 5：选择“保存”。

遇到问题？查看故障排除指南。

3. 部署示例代码

在此步骤中，你将使用 GitHub Actions 配置 GitHub 部署。这只是部署到应用服务的许多方法之一，也是一种在部署过程中持续集成的好方法。默认情况下，GitHub 存储库的每个 git push 都会启动生成和部署操作。

Flask
Django

步骤 1：在新浏览器窗口中：

登录到 GitHub 帐户。
导航到 https://github.com/Azure-Samples/msdocs-flask-postgresql-sample-app。
选择“Fork”。
选择“创建分支”。

步骤 2：在 GitHub 页中，按 . 键在浏览器中打开 Visual Studio Code。

步骤 3：在浏览器上的 Visual Studio Code 中，在资源管理器中打开“azureproject/production.py”。查看生产环境中使用的环境变量，包括在配置页中看到的应用设置。

步骤 4：返回“应用服务”页，在左侧菜单中，选择“部署中心”。

步骤 5：在“部署中心”页中：

在“源”中，选择“GitHub”。默认情况下，选择 GitHub Actions 作为生成提供程序。
登录到 GitHub 帐户，并按照提示授权 Azure。
在“组织”中，选择你的帐户。
在“存储库”中，选择“msdocs-flask-postgresql-sample-app”。
在“分支”中，选择“主”。
保留所选的默认选项以添加工作流。
在顶部菜单中，选择“保存”。应用服务会将工作流文件提交到所选 GitHub 存储库中（在 .github/workflows 目录中）。

步骤 6：在“部署中心”页中：

选择“日志”。部署运行已启动。
在部署运行的日志项中，选择“生成/部署日志”。

步骤 7：你已转到 GitHub 存储库，并看到 GitHub Action 正在运行。工作流文件定义两个单独的阶段，即生成和部署阶段。等待 GitHub 运行以显示“完成”状态。此过程大约需要 5 分钟。

步骤 1：在新浏览器窗口中：

登录到 GitHub 帐户。
导航到 https://github.com/Azure-Samples/msdocs-django-postgresql-sample-app。
选择“Fork”。
选择“创建分支”。

步骤 2：在 GitHub 页中，按 . 键在浏览器中打开 Visual Studio Code。

步骤 4：返回“应用服务”页，在左侧菜单中，选择“部署中心”。

步骤 5：在“部署中心”页中：

在“源”中，选择“GitHub”。默认情况下，选择 GitHub Actions 作为生成提供程序。
登录到 GitHub 帐户，并按照提示授权 Azure。
在“组织”中，选择你的帐户。
在“存储库”中，选择“msdocs-django-postgresql-sample-app”。
在“分支”中，选择“主”。
在顶部菜单中，选择“保存”。应用服务会将工作流文件提交到所选 GitHub 存储库中（在 .github/workflows 目录中）。

步骤 6：在“部署中心”页中：

选择“日志”。部署运行已启动。
在部署运行的日志项中，选择“生成/部署日志”。

遇到问题？查看故障排除指南。

在 PostgreSQL 数据库受虚拟网络保护的情况下，运行 Flask 数据库迁移的最简单方法是使用应用服务容器在 SSH 会话中运行。

步骤 1：返回“应用服务”页，在左侧菜单中，选择“SSH”。

选择“转到”。

步骤 2：在 SSH 终端中运行 flask db upgrade。如果该命令成功，则应用服务会成功连接到数据库。只有对 /home 中文件的更改才能在应用重启之后持久保存。不会保留 /home 外部的更改。

在 PostgreSQL 数据库受虚拟网络保护的情况下，运行 Django 数据库迁移的最简单方法是使用应用服务容器在 SSH 会话中运行。

步骤 1：返回“应用服务”页，在左侧菜单中，选择“SSH”。

选择“转到”。

步骤 2：在 SSH 终端中运行 python manage.py migrate。如果该命令成功，则应用服务会成功连接到数据库。只有对 /home 中文件的更改才能在应用重启之后持久保存。不会保留 /home 外部的更改。

提示

在 SSH 会话中，对于 Django，还可以使用 python manage.py createsuperuser 命令创建用户，就像在典型的 Django 应用中所做的那样。有关详细信息，请参阅 django django-admin 和 manage.py 的文档。使用超级用户帐户访问网站的 /admin 部分。对于 Flask，请使用 Flask-admin 之类的扩展来提供相同的功能。

5.浏览到应用

步骤 1：在“应用服务”页中：

从左侧菜单中选择“概述”。
选择应用的 URL。你也可以直接导航到 https://<app-name>.azurewebsites.net。

步骤 2：在列表中添加几家餐厅。恭喜，你已在 Azure 应用服务中运行了一个 Web 应用，并安全连接到了 Azure Database for PostgreSQL。

6.流式传输诊断日志

Azure 应用服务会捕获输出到控制台的所有消息，以帮助你诊断应用程序的问题。示例应用包含了 print() 语句用于演示此功能，如下所示。

Flask
Django

@app.route('/', methods=['GET'])
def index():
    print('Request for index page received')
    restaurants = Restaurant.query.all()
    return render_template('index.html', restaurants=restaurants)

def index(request):
    print('Request for index page received')
    restaurants = Restaurant.objects.annotate(avg_rating=Avg('review__rating')).annotate(review_count=Count('review'))
    return render(request, 'restaurant_review/index.html', {'restaurants': restaurants})

步骤 1：在“应用服务”页中：

从左菜单中选择“应用服务日志”。
在“应用程序日志记录”下，选择“文件系统”。
在顶部菜单中，选择“保存”。

步骤 2：在左侧菜单中，选择“日志流”。将显示应用的日志，包括平台日志和容器内部的日志。

在为 Python 应用程序设置 Azure Monitor 系列文章中，详细了解 Python 应用中的日志记录。

7.清理资源

完成后，可以通过删除资源组从 Azure 订阅中删除所有资源。

步骤 1：在 Azure 门户顶部的搜索栏中：

输入资源组名称。
选择前面创建的资源组。

步骤 2：在资源组页上，选择“删除资源组”。

步骤 3：

输入资源组名称以确认删除。
选择“删除”。

：

故障排除

下面列出了尝试完成本教程时可能遇到的问题以及解决这些问题的步骤。

无法连接到 SSH 会话

如果你无法连接到 SSH 会话，则表示应用本身已启动失败。请查看诊断日志了解详细信息。例如，如果看到类似于 KeyError: 'AZURE_POSTGRESQL_CONNECTIONSTRING' 的错误，则可能表示缺少环境变量（你可能已删除应用设置）。

运行数据库迁移时出错

如果遇到与连接数据库相关的任何错误，请检查应用设置 (AZURE_POSTGRESQL_CONNECTIONSTRING) 是否已更改。如果没有该连接字符串，则 migrate 命令将无法与数据库通信。

常见问题解答

此设置花费有多大？
如何使用其他工具连接到在虚拟网络后面受保护的 PostgreSQL 服务器？
本地应用开发如何处理 GitHub Actions？
如何将 Django 示例配置为在 Azure 应用服务上运行？

此设置花费有多大？

所创建资源的定价如下所示：

应用服务计划在基本层中创建，可以进行纵向扩展或缩减。请参阅应用服务定价。
PostgreSQL 灵活服务器是在最低可突发层 Standard_B1ms 中创建的，该层提供最小的存储大小，但可以纵向扩展或缩减。请参阅 Azure Database for PostgreSQL 定价。
除非配置额外的功能（例如对等互连），否则虚拟网络不会产生费用。请参阅 Azure 虚拟网络定价。
专用 DNS 区域会产生少量费用。请参阅 Azure DNS 定价。

如何使用其他工具连接到在虚拟网络后面受保护的 PostgreSQL 服务器？

要从命令行工具进行基本访问，可以从应用的 SSH 终端运行 psql。
若要从桌面工具进行连接，计算机必须位于虚拟网络中。例如，它可以是连接到其中一个子网的 Azure VM，也可以是与 Azure 虚拟网络建立了站点到站点 VPN 连接的本地网络中的计算机。
还可以将 Azure Cloud Shell 与虚拟网络集成。

本地应用开发如何与 GitHub Actions 配合使用？

以应用服务中自动生成的工作流文件为例，每个 git push 都会启动新的生成和部署运行。从 GitHub 存储库的本地克隆中，进行所需更新并推送到 GitHub。例如：

git add .
git commit -m "<some-message>"
git push origin main

如何将 Django 示例配置为在 Azure 应用服务上运行？

注意

如果使用自己的应用按照本教程中所述内容进行操作，请查看每个项目的 README.md 文件中的 requirements.txt 文件说明（Flask、Django），以了解自己需要的包。

Django 示例应用程序在 azureproject/production.py 文件中配置设置，使它可以在 Azure 应用服务中运行。将 Django 部署到生产环境时经常会做出这些更改，它们并非特定于应用服务。

Django 验证传入请求中的 HTTP_HOST 标头。示例代码使用应用服务中的 WEBSITE_HOSTNAME 环境变量将应用的域名添加到 Django 的 ALLOWED_HOSTS 设置。

# Configure the domain name using the environment variable
# that Azure automatically creates for us.
ALLOWED_HOSTS = [os.environ['WEBSITE_HOSTNAME']] if 'WEBSITE_HOSTNAME' in os.environ else []

Django 不支持在生产中提供静态文件。对于本教程，请使用 WhiteNoise 来支持提供文件。 WhiteNoise 包已与 requirements.txt 一起安装，其中间件已添加到列表中。


# WhiteNoise configuration
MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    # Add whitenoise middleware after the security middleware
    'whitenoise.middleware.WhiteNoiseMiddleware',

然后根据 Django 文档配置静态文件设置。

STATICFILES_STORAGE = 'whitenoise.storage.CompressedManifestStaticFilesStorage'
STATIC_ROOT = os.path.join(BASE_DIR, 'staticfiles')

有关详细信息，请参阅 Django 应用的生产设置。

后续步骤

请继续学习下一教程，了解如何使用自定义域和证书保护应用。

使用自定义域和证书进行保护

了解应用服务如何运行 Python 应用：

配置 Python 应用