使用 Vercel 部署 Flask 应用教程

本教程旨在帮助开发者解决在使用 Vercel 部署 Flask 应用时遇到的常见问题。我们将详细介绍 vercel.json 文件的配置方法，以及如何排查和解决部署过程中可能出现的错误，确保 Flask 应用能够成功部署并运行在 Vercel 平台上。

Vercel 部署 Flask 应用配置详解

Vercel 是一个流行的无服务器函数平台，非常适合部署静态网站和 API。虽然 Vercel 提供了对多种框架的支持，但 Flask 并不在其默认支持列表中。因此，我们需要手动配置 vercel.json 文件来告诉 Vercel 如何构建和运行我们的 Flask 应用。

1. vercel.json 文件配置

vercel.json 文件是 Vercel 用来了解如何构建和部署你的项目的配置文件。对于 Flask 应用，我们需要配置 builds 和 routes 两个关键部分。

• builds: builds 部分告诉 Vercel 如何构建你的应用。对于 Flask 应用，我们需要指定 Python 运行时环境。

• routes: routes 部分定义了如何将传入的请求路由到你的应用。

一个典型的 vercel.json 文件配置如下：

{
    "version": 2,
    "builds": [
        {
            "src": "app.py",
            "use": "@vercel/python"
        }
    ],
    "routes": [
        {
            "src": "/(.*)",
            "dest": "app.py"
        }
    ]
}

解释：

• version: 指定 Vercel 配置文件版本。
• builds:
  • src: 指定 Flask 应用的主文件，通常是 app.py 或 index.py。
  • use: 指定使用的 Vercel 构建器，@vercel/python 用于 Python 应用。
• routes:
  • src: 使用正则表达式 /(.*) 匹配所有传入的请求。
  • dest: 将所有请求路由到 app.py 文件，由 Flask 应用处理。

注意： 将 app.py 替换为你实际的 Flask 应用入口文件。

2. 依赖管理

Vercel 需要知道你的 Flask 应用依赖哪些 Python 包。你需要创建一个 requirements.txt 文件，列出所有依赖包及其版本。

例如：

Flask==2.3.2
gunicorn==20.1.0

确保 requirements.txt 文件位于项目根目录下，与 vercel.json 和 Flask 应用文件在同一目录。

Cursor

一个新的IDE，使用AI来帮助您重构、理解、调试和编写代码。

下载

3. 错误排查

在部署过程中，可能会遇到各种错误。以下是一些常见的错误及其解决方法：

• 500: INTERNAL_SERVER_ERROR / FUNCTION_INVOCATION_FAILED: 这通常表示你的 Flask 应用在运行时遇到了错误。

  • 解决方法:
    • 检查 Flask 应用代码是否存在语法错误。
    • 确保 requirements.txt 文件包含了所有必要的依赖包。
    • 查看 Vercel 的部署日志，找到具体的错误信息。

• ModuleNotFoundError: 这表示你的应用缺少必要的 Python 包。

  • 解决方法:
    • 检查 requirements.txt 文件是否包含了所有依赖包。
    • 确保 requirements.txt 文件中的包名和版本号正确。

4. 示例 Flask 应用

以下是一个简单的 Flask 应用示例，可以用于测试 Vercel 部署：

app.py:

from flask import Flask

app = Flask(__name__)

@app.route("/")
def hello():
    return "Hello, World!"

if __name__ == "__main__":
    app.run(debug=True)

requirements.txt:

Flask==2.3.2

将以上文件放在同一目录下，并创建一个 vercel.json 文件，内容如下：

{
    "version": 2,
    "builds": [
        {
            "src": "app.py",
            "use": "@vercel/python"
        }
    ],
    "routes": [
        {
            "src": "/(.*)",
            "dest": "app.py"
        }
    ]
}

然后，将项目连接到 Vercel 并进行部署。

5. 注意事项

• Gunicorn: 在生产环境中，建议使用 Gunicorn 作为 WSGI 服务器来运行 Flask 应用。 你需要在 requirements.txt 文件中添加 gunicorn，并在 app.py 中使用 Gunicorn 启动 Flask 应用。 但是，Vercel 会自动处理 Gunicorn 的启动，你只需要确保安装了 Gunicorn 即可。
• Vercel CLI: 可以使用 Vercel CLI 工具进行本地测试和部署。
• 部署日志: 仔细查看 Vercel 的部署日志，可以帮助你找到并解决问题。

总结

通过正确配置 vercel.json 文件，管理依赖，并仔细排查错误，你可以成功地将 Flask 应用部署到 Vercel 平台。 Vercel 的无服务器架构可以提供快速的部署和可扩展性，非常适合部署小型到中型的 Flask 应用。