解决Connexion 3与Zappa部署冲突：ASGI迁移与WSGI适配策略

本文探讨了connexion从版本2升级到3后，由于其底层接口从wsgi迁移至asgi，导致与aws lambda部署工具zappa之间出现兼容性问题。我们将详细介绍错误`abstractapp.__call__() missing 1 required positional argument: 'send'`的根源，并提供两种有效的解决方案：一是通过connexion官方提供的wsgi适配器中间件将asgi应用包装为wsgi兼容模式；二是采用原生支持asgi的部署工具如mangum，以确保应用在aws lambda上顺利运行。

Connexion 3 ASGI 迁移带来的挑战

Connexion是一个基于OpenAPI/Swagger规范构建和运行API的Python框架。在Connexion 3版本中，其底层应用接口发生了重大变革，从传统的WSGI（Web Server Gateway Interface）标准迁移到了更现代的ASGI（Asynchronous Server Gateway Interface）标准。ASGI是WSGI的异步继任者，旨在支持异步操作和WebSocket等新特性。

然而，这种迁移给依赖WSGI的现有部署工具带来了兼容性问题。Zappa是一个流行的Python工具，用于将WSGI应用程序部署到AWS Lambda和API Gateway。由于Zappa目前主要支持WSGI应用程序，当尝试使用Zappa部署Connexion 3的ASGI应用程序时，就会出现以下错误：AbstractApp.__call__() missing 1 required positional argument: 'send'。

此错误表明Connexion 3的ASGI应用程序在被Zappa调用时，期望接收一个ASGI规范中的send参数，但Zappa作为WSGI服务器，未能提供此参数，从而导致调用失败。本质上，这是因为Zappa正在尝试以WSGI的方式运行一个ASGI应用程序。

解决方案一：使用WSGI适配器中间件

如果你希望继续使用Zappa进行部署，最直接的解决方案是利用Connexion官方提供的WSGI适配器中间件。这个适配器能够将一个ASGI应用程序包装成一个WSGI兼容的接口，使其能够被WSGI服务器（如Zappa）正确识别和运行。

实现步骤

1. 导入WSGIMiddleware： 从connexion.middleware.wsgi模块中导入WSGIMiddleware。
2. 包装ASGI应用： 将你的Connexion 3应用程序实例（其内部的ASGI应用）传递给WSGIMiddleware，生成一个新的WSGI兼容应用实例。
3. 配置Zappa： 在Zappa的配置文件中（通常是zappa_settings.json），将这个WSGI兼容的应用实例指定为入口点。

示例代码

假设你的Connexion应用程序定义在一个名为app.py的文件中：

# app.py
from connexion import App
from connexion.middleware.wsgi import WSGIMiddleware

# 初始化Connexion应用
# __name__通常是当前模块的名称
connexion_app = App(__name__)

# 添加你的API定义，例如从一个OpenAPI YAML文件加载
connexion_app.add_api('openapi.yaml')

# 获取Connexion内部的ASGI应用实例
# connexion_app.app 才是真正的ASGI应用
asgi_application = connexion_app.app

# 使用WSGIMiddleware将ASGI应用包装成WSGI兼容应用
# 这个 wsgi_application 实例就是Zappa可以部署的
wsgi_application = WSGIMiddleware(asgi_application)

# 注意：在Zappa的settings.json中，你需要指向这个 wsgi_application
# 例如："app_function": "app.wsgi_application"

在你的zappa_settings.json中，app_function应指向你包装后的WSGI应用：

{
    "dev": {
        "app_function": "app.wsgi_application",
        "aws_region": "us-east-1",
        "project_name": "my-connexion-api",
        "runtime": "python3.9",
        "s3_bucket": "zappa-bucket-name"
    }
}

通过这种方式，Zappa会调用app.wsgi_application，而这个实例已经是一个WSGI兼容的接口，能够与Zappa正常交互。

讯飞绘文

讯飞绘文：免费AI写作/AI生成文章

118

查看详情

解决方案二：采用ASGI兼容的部署工具

如果你对更换部署工具持开放态度，或者希望充分利用ASGI的异步特性，那么采用原生支持ASGI的部署工具是更优的选择。Mangum是一个专门为AWS Lambda设计的ASGI适配器，它允许ASGI应用程序在Lambda环境中运行。

实现步骤

1. 安装Mangum： 使用pip安装Mangum。
2. 创建Mangum处理器： 将你的Connexion 3 ASGI应用程序实例传递给Mangum的Mangum类，创建一个Lambda处理器。
3. 部署： 使用支持Mangum或能直接部署Lambda函数的工具（例如Serverless Framework、AWS SAM，或者直接通过AWS控制台/CLI）来部署你的应用。

示例代码

假设你的Connexion应用程序定义在一个名为app.py的文件中：

# app.py
from connexion import App
from mangum import Mangum

# 初始化Connexion应用
connexion_app = App(__name__)

# 添加你的API定义
connexion_app.add_api('openapi.yaml')

# 获取Connexion内部的ASGI应用实例
asgi_application = connexion_app.app

# 创建一个Mangum处理器
# 这个handler就是AWS Lambda函数的入口点
handler = Mangum(asgi_application)

# 在AWS Lambda配置中，你的函数处理器路径将是 'app.handler'

当你使用Serverless Framework或AWS SAM等工具部署时，你的配置可能看起来像这样（以Serverless Framework为例）：

# serverless.yml
service: my-connexion-asgi-api

provider:
  name: aws
  runtime: python3.9
  stage: dev
  region: us-east-1

functions:
  api:
    handler: app.handler # 指向你的Mangum处理器
    events:
      - http:
          path: /{proxy+}
          method: any

这种方法避免了WSGI到ASGI的转换开销，并且能够更好地支持ASGI应用程序的异步特性。

选择合适的解决方案

• 坚持使用Zappa： 如果你对Zappa的现有工作流非常熟悉，并且不想引入新的部署工具，那么使用Connexion的WSGI适配器是最佳选择。它允许你在最小化改动部署流程的前提下解决兼容性问题。
• 拥抱ASGI和现代化部署： 如果你希望充分利用ASGI的优势，或者正在寻找更灵活、更现代的Lambda部署方案，那么切换到如Mangum这样的ASGI兼容工具，并结合Serverless Framework或AWS SAM等部署框架，将是更长远的解决方案。这可能需要一些学习成本来适应新的部署范式。

总结

Connexion 3从WSGI到ASGI的迁移是其架构演进的重要一步，但也带来了与传统WSGI部署工具（如Zappa）的兼容性挑战。通过理解这一核心变化，我们可以选择两种主要策略来解决AbstractApp.__call__() missing 'send'错误：一是通过官方WSGI适配器将ASGI应用包装为WSGI兼容模式以继续使用Zappa；二是采用Mangum等原生ASGI兼容的部署工具，以更直接、高效的方式在AWS Lambda上运行Connexion 3应用。根据项目需求和团队偏好，选择最适合的方案，确保你的API能够稳定、高效地运行。

以上就是解决Connexion 3与Zappa部署冲突：ASGI迁移与WSGI适配策略的详细内容，更多请关注php中文网其它相关文章！