FastAPI Web框架 [1.12]

Posted 2022-12-03 再认真点

中间件

"中间件"是一个函数，它在每个请求被特定的路径操作处理之前，以及在每个响应返回之前工作。

• 它接收你的应用程序的每一个请求.
• 然后它可以对这个请求做一些事情或者执行任何需要的代码.
• 然后它将请求传递给应用程序的其他部分 (通过某种路径操作).
• 然后它获取应用程序生产的响应 (通过某种路径操作).
• 它可以对该响应做些什么或者执行任何需要的代码.
• 它返回这个响应.

如果你使用了 yield 关键字依赖, 依赖中的退出代码将在执行中间件后执行；如果有任何后台任务(稍后记录), 它们将在执行中间件后运行.

创建中间件

要创建中间件你可以在函数的顶部使用装饰器 @app.middleware(“http”).
中间件参数接收如下参数:

• request.
• 一个函数 call_next 它将接收 request 作为参数.。这个函数将 request 传递给相应的 路径操作，然后它将返回由相应的路径操作生成的 response.
• 然后你可以在返回 response 前进一步修改它.

import time
from fastapi import FastAPI,Request
app = FastAPI()

@app.middleware("http")
async def add_process_time_header(request:Request,call_next):
    start_time = time.time()    #   在任何路径操作收到request前,可以添加要和请求一起运行的代码.
    response = await call_next(request)
    process_time = time.time() - start_time
    response.headers["X-Process-Time"] = str(process_time)      #可以在响应生成但是返回之前添加代码. 例如你可以添加自定义请求头 X-Process-Time 包含以秒为单位的接收请求和生成响应的时间.
    return response

CORS（跨域资源共享）

CORS 或者「跨域资源共享」 指浏览器中运行的前端拥有与后端通信的 javascript 代码，而后端处于与前端不同的「源」的情况。

源

源是协议（http，https）、域（myapp.com，localhost，localhost.tiangolo.com）以及端口（80、443、8080）的组合。
因此，这些都是不同的源：

• http://localhost
• https://localhost
• http://localhost:8080

即使它们都在 localhost 中，但是它们使用不同的协议或者端口，所以它们都是不同的「源」。假设你的浏览器中有一个前端运行在 http://localhost:8080，并且它的 JavaScript 正在尝试与运行在 http://localhost 的后端通信（因为我们没有指定端口，浏览器会采用默认的端口 80）。

然后，浏览器会向后端发送一个 HTTP OPTIONS 请求，如果后端发送适当的 headers 来授权来自这个不同源（http://localhost:8080）的通信，浏览器将允许前端的 JavaScript 向后端发送请求。为此，后端必须有一个「允许的源」列表。
在这种情况下，它必须包含 http://localhost:8080，前端才能正常工作。

通配符
也可以使用 " * " （一个「通配符」）声明这个列表，表示全部都是允许的。
但这仅允许某些类型的通信，不包括所有涉及凭据的内容：像 Cookies 以及那些使用 Bearer 令牌的授权 headers 等。
因此，为了一切都能正常工作，最好显式地指定允许的源。

#   使用 CORSMiddleware
#   你可以在 FastAPI 应用中使用 CORSMiddleware 来配置它。
#   导入 CORSMiddleware。
#   创建一个允许的源列表（由字符串组成）。
#   将其作为「中间件」添加到你的 FastAPI 应用中。
#
#   你也可以指定后端是否允许：
#     凭证（授权 headers，Cookies 等）。
#     特定的 HTTP 方法（POST，PUT）或者使用通配符 "*" 允许所有方法。
#     特定的 HTTP headers 或者使用通配符 "*" 允许所有 headers。
from fastapi import FastAPI
from fastapi.middleware.cors import CORSMiddleware
app = FastAPI()

origins = [
    "http://localhost.tiangolo.com",
    "https://localhost.tiangolo.com",
    "http://localhost",
    "http://localhost:8080",
]

app.add_middleware(
    CORSMiddleware,
    allow_origins=origins,
    allow_credentials=True,
    allow_methods=["*"],
    allow_headers=["*"],
)

@app.get("/")
async def main():
    return "message": "Hello World"

#   默认情况下，这个 CORSMiddleware 实现所使用的默认参数较为保守，所以你需要显式地启用特定的源、方法或者 headers，以便浏览器能够在跨域上下文中使用它们。

支持以下参数：

allow_origins - 一个允许跨域请求的源列表。例如 ['https://example.org', 'https://www.example.org']。你可以使用 ['*'] 允许任何源。
allow_origin_regex - 一个正则表达式字符串，匹配的源允许跨域请求。例如 'https://.*\\.example\\.org'。
allow_methods - 一个允许跨域请求的 HTTP 方法列表。默认为 ['GET']。你可以使用 ['*'] 来允许所有标准方法。
allow_headers - 一个允许跨域请求的 HTTP 请求头列表。默认为 []。你可以使用 ['*'] 允许所有的请求头。Accept、Accept-Language、Content-Language 以及 Content-Type 请求头总是允许 CORS 请求。
allow_credentials - 指示跨域请求支持 cookies。默认是 False。另外，允许凭证时 allow_origins 不能设定为 ['*']，必须指定源。
expose_headers - 指示可以被浏览器访问的响应头。默认为 []。
max_age - 设定浏览器缓存 CORS 响应的最长时间，单位是秒。默认为 600。

CORS 预检请求
这是些带有 Origin 和 Access-Control-Request-Method 请求头的 OPTIONS 请求。
在这种情况下，中间件将拦截传入的请求并进行响应，出于提供信息的目的返回一个使用了适当的 CORS headers 的 200 或 400 响应。

简单请求
任何带有 Origin 请求头的请求。在这种情况下，中间件将像平常一样传递请求，但是在响应中包含适当的 CORS headers。

参考：https://fastapi.tiangolo.com/zh/