FastAPI FastAPI中的会话

在本文中，我们将介绍如何在FastAPI应用程序中使用会话。会话是一种跟踪用户在多个请求之间的状态的方式。通过使用会话，我们可以存储和访问用户的信息，例如登录状态、购物车内容等。

什么是会话？

会话是指在客户端和服务器之间建立的持久化的连接。在Web应用程序中，会话经常用于在多个请求之间存储和访问用户的信息。当用户通过登录页面进行身份验证后，会话会为用户分配一个唯一的标识符，通常是一个会话ID。该会话ID将在用户与服务器通信的每个请求中被发送，从而维持用户状态。

FastAPI中的会话管理

FastAPI提供了多种管理会话的方式，其中最常用的是使用cookie或header传递会话ID。

使用Cookie进行会话管理

在FastAPI中，可以使用FastAPI.Sessions中的SessionMiddleware来启用会话管理。该中间件负责处理会话ID的生成、存储和验证。

from fastapi import FastAPI
from fastapi.middleware.session import SessionMiddleware

app = FastAPI()
app.add_middleware(SessionMiddleware, secret_key="my_secret_key")

在上述代码中，我们使用SessionMiddleware中间件来启用会话管理，并通过secret_key传递了一个密钥供FastAPI使用。这个密钥用于加密会话ID，以确保其安全性。

一旦我们启用了会话管理，FastAPI将会自动将会话ID存储在cookie中，并在每个请求中自动验证会话ID的有效性。我们可以通过request.session来访问会话对象。

from fastapi import FastAPI

@app.get("/items/")
async def read_items(session: Session = Depends(get_session)):
    session_data = session.get("user")
    if session_data:
        return {"message": f"Hello {session_data['name']}!"}
    return {"message": "Hello guest!"}

在上述代码中，我们定义了一个read_items路由，其中通过session: Session = Depends(get_session)来声明Session依赖项，并在函数参数中使用session来访问会话对象。我们可以使用会话对象的get方法来获取会话中存储的数据。

使用Header进行会话管理

除了使用cookie以外，还可以使用header来传递和管理会话ID。FastAPI提供了fastapi_sessions.sessions模块来方便我们使用header进行会话管理。

from fastapi import FastAPI, Depends
from fastapi_sessions import SessionCookie, SessionManager

app = FastAPI()
app.session_manager = SessionManager(secret_key="my_secret_key")

@app.get("/items/")
async def read_items(session: SessionCookie = Depends(app.session_manager)):
    session_data = session.get("user")
    if session_data:
        return {"message": f"Hello {session_data['name']}!"}
    return {"message": "Hello guest!"}

在上述代码中，我们使用SessionCookie依赖项来声明会话对象，并通过app.session_manager来设置会话管理器。我们可以在会话对象上使用get方法来获取会话中存储的数据。

示例：使用会话管理用户登录状态

下面是一个示例，展示了如何在FastAPI应用程序中使用会话管理用户的登录状态：

from fastapi import FastAPI, Depends, HTTPException
from fastapi.security import HTTPBasic, HTTPBasicCredentials
from fastapi_sessions import SessionCookie, SessionManager

app = FastAPI()
app.session_manager = SessionManager(secret_key="my_secret_key")
security = HTTPBasic()

@app.post("/login/")
async def login(credentials: HTTPBasicCredentials, session: SessionCookie = Depends(app.session_manager)):
    if credentials.username == "admin" and credentials.password == "password":
        session["user"] = {"name": credentials.username}
        return {"message": "Login successful"}
    raise HTTPException(status_code=401, detail="Invalid username or password")

@app.get("/items/")
async def read_items(session: SessionCookie = Depends(app.session_manager)):
    session_data = session.get("user")
    if session_data:
        return {"message": f"Hello {session_data['name']}!"}
    raise HTTPException(status_code=401, detail="Not authenticated")

在上述代码中，我们定义了一个/login/路由，用于用户登录。在登录成功后，我们将用户信息存储在会话中。然后，我们定义了一个/items/路由，用于返回用户的欢迎信息。只有在用户已经登录的情况下，才能访问该路由。否则，将返回未经身份验证的错误。