FastAPI 提供了一些中间件来增强它的功能,类似于 Spring 的切面编程,中间件可以在请求处理前或处理后执行一些操作,例如记录日志、添加请求头、鉴权等,跨域也是 FastAPI 中间件的一部分。
目录
1 中间件
1.1 创建中间件
1.2 使用中间件
2 跨域
2.1 跨域详解
2.2 使用 CORSMiddleware 实现跨域
源码地址:
FastAPI_Study_Yinyu: FastAPI学习路径,CSDN专栏:http://t.csdn.cn/JRtrk
你可以通过向 FastAPI 应用添加中间件来实现类似切面编程的的效果。
简单来说,中间件也就是一个函数,它可以在每个请求处理之前及请求处理之后工作:
首先我们使用装饰器 @app.middleware("http") 来创建一个简单的中间件:
中间件参数接收如下参数:
import time
from fastapi import FastAPI, Request
app = FastAPI()
@app.middleware("http")
async def add_process_time_header(request: Request, call_next):
#请求处理前
response = await call_next(request)
#请求处理后
return response
你可以在请求处理前和请求处理后添加相应的逻辑代码~
接下来我们使用上述的模板,使用中间件来完成一个需求(添加自定义请求头 X-Process-Time ,包含以秒为单位的接收请求和生成响应的时间)
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()
time.sleep(1)
response = await call_next(request)
process_time = time.time() - start_time
response.headers["X-Process-Time-Yinyu"] = str(process_time)
return response
#请求示例
@app.get("/test/")
async def read_item():
return "OK"
if __name__ == '__main__':
import uvicorn
uvicorn.run(app, host="127.0.0.1", port=8000)
然后我们启动这个应用然后进行请求 ,这说明中间件起到作用了。
但是如果你想让浏览器中的客户端看到你的自定义请求头,你需要把它们加到 CORS 配置 (CORS (Cross-Origin Resource Sharing)) 的 expose_headers 参数中。
假如是前后端分离的项目(比如前端 Vue,后端 Fastapi),那跨域就绕不过去了。
首先跨域是指浏览器中运行的前端拥有与后端通信的 JavaScript 代码,而后端处于与前端不同的「源」的情况。
源
源是指协议(http,https)、域(myapp.com,localhost,localhost.tiangolo.com)以及端口(80、443、8080)的组合。
这些都是不同的源:
即使它们都在 localhost 中,但是它们使用不同的协议或者端口,所以它们都是不同的「源」。
跨域必要性
假设你的浏览器中有一个前端运行在 http://localhost:8080,并且它的 JavaScript 正在尝试与运行在 http://localhost 的后端通信(如果我们没有指定端口,浏览器会采用默认的端口 80)。
然后,浏览器会向后端发送一个 HTTP OPTIONS 请求,如果后端发送适当的 headers 来授权来自这个不同源(http://localhost:8080)的通信,浏览器将允许前端的 JavaScript 向后端发送请求。
因此后端需要有一个「允许的源」列表。 在这种情况下,包含 http://localhost:8080,前端才能正常工作。
也可以使用 "*" 声明这个列表,表示全部都是允许的,但也不会影响授权认证方面的处理。
主要步骤如下:
还可以做如下指定:
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,以便浏览器能够在跨域上下文中使用它们。
支持以下参数: