FastAPI Events 使用教程

FastAPI Events 使用教程

fastapi-eventsAsynchronous event dispatching/handling library for FastAPI and Starlette项目地址:https://gitcode.com/gh_mirrors/fa/fastapi-events

项目介绍

FastAPI Events 是一个用于 FastAPI 和 Starlette 的异步事件分发/处理库。它提供了一个简单的 API 来在代码的任何地方发射事件，并且支持将事件发送到远程队列。事件处理在响应返回后进行，确保不会影响响应时间。FastAPI Events 支持事件的模式匹配，使用 Unix shell 风格的匹配方式。

项目快速启动

安装

首先，你需要安装 fastapi-events 库。你可以通过 pip 安装：

pip install fastapi-events

如果你需要使用 AWS 处理程序，可以安装以下扩展：

pip install fastapi-events[aws]

配置和使用

以下是一个简单的示例，展示如何在 FastAPI 应用中配置和使用 fastapi-events：

from fastapi import FastAPI
from fastapi_events.dispatcher import dispatch
from fastapi_events.middleware import EventHandlerASGIMiddleware
from fastapi_events.handlers.local import local_handler

app = FastAPI()

# 注册中间件
app.add_middleware(EventHandlerASGIMiddleware, handlers=[local_handler])

@app.get("/")
async def root():
    # 分发事件
    dispatch("my_event_name", payload={"message": "Hello, FastAPI Events!"})
    return {"message": "Event dispatched"}

应用案例和最佳实践

本地事件处理

在本地处理事件时，可以使用 local_handler。以下是一个示例：

from fastapi_events.handlers.local import local_handler

# 在中间件中注册本地处理程序
app.add_middleware(EventHandlerASGIMiddleware, handlers=[local_handler])

# 分发事件
dispatch("my_event_name", payload={"key": "value"})

远程事件处理

如果你需要将事件发送到远程队列，例如 AWS SQS，可以注册 SQSForwardHandler：

from fastapi_events.handlers.aws import SQSForwardHandler

# 注册 SQS 处理程序
app.add_middleware(EventHandlerASGIMiddleware, handlers=[SQSForwardHandler(queue_url="test-queue", region_name="eu-central-1")])

# 分发事件
dispatch("remote_event_name", payload={"data": "to_be_forwarded"})

典型生态项目

FastAPI Events 可以与其他 FastAPI 生态项目结合使用，例如：

• FastAPI: 用于构建 API 的主要框架。
• Pydantic: 用于数据验证和设置。
• SQLAlchemy: 用于数据库操作。
• Celery: 用于异步任务处理。

通过结合这些工具，你可以构建一个完整且高效的后端服务。

fastapi-eventsAsynchronous event dispatching/handling library for FastAPI and Starlette项目地址:https://gitcode.com/gh_mirrors/fa/fastapi-events