1. 项目背景:从"百口锅"到"一口灶"的管理系统改造
去年秋季学期,我们小组接了个班级管理系统的重构任务。项目不算大,但前端调用后端接口的方式五花八门:有的接口返回 {"code":0,"data":...},有的直接丢一个 JSON 对象,有的把错误信息塞在 HTTP 状态码里,还有的干脆在业务逻辑里逐个写 try...except 然后拼错误消息。作为后端负责人,我发现最难受的事情不是写新功能,而是每次给接口加一个鉴权逻辑,就得在十几个路由函数里复制同一段 JWT 解析代码——这就是典型的"重复造轮子",而且每个轮子造得还不一样圆。
我当时的处境大概是这样的:系统里有教师端、学生端、管理员端三种角色,权限模型本身就有重叠,再加上课程管理、考勤统计、成绩录入这些业务模块,FastAPI 的 APIRouter 已经分了七八个文件。每次前端同学过来问我"为什么这个接口报错格式跟那个不一样",我都得翻半天代码。后来我痛下决心,用 FastAPI 中间件做了一次彻底统一:统一鉴权、统一日志、统一返回格式、统一异常处理。这篇文章把这套改造的完整思路、代码和踩过的坑都整理出来,给同样在做中小型管理系统后端的朋友一个参考。
当时团队里也有同学提出用装饰器或者依赖注入来做,甚至有人建议直接上微服务网关。我评估了一圈,最后选择中间件方案,核心原因有四点:一是中间件可以在不入侵业务代码的前提下拦下所有请求;二是班级管理系统这种体量,引入网关完全是杀鸡用牛刀;三是 FastAPI 中间件本身就是 ASGI 层面的标准机制,后续就算迁移到其他 ASGI 框架也能复用;四是中间件的执行顺序可控,可以叠加多个职责,正好匹配我们"统一管控"的需求。
需要模型API调用? 免费领10W Token,多模型网关一键接入 Claude、DeepSeek 等主流模型。
2. 核心方案选型与整体架构设计
2.1 为什么是中间件,而不是装饰器或依赖注入
先回应一个很多人会问的问题:FastAPI 里做跨切面逻辑,装饰器、依赖注入、中间件都可以,为什么非要用中间件?
我简单做了一张对比表,是我当时给组内同学讲方案时用的:
| 实现方式 | 拦截范围 | 与业务代码耦合度 | 能否处理路由未匹配的请求 | 适合场景 |
|---|---|---|---|---|
| 装饰器 | 仅被装饰的接口 | 高,需要每个路由手动加 | 不能 | 单个接口的特有逻辑 |
| 依赖注入(Depends) | 声明了该依赖的路由 | 中,路由签名需修改 | 不能 | 参数校验、局部权限控制 |
| 中间件 | 所有经过应用的请求 | 低,业务代码无感知 | 能 | 全局统一逻辑 |
装饰器最大的问题是要记着给每个新接口加上。项目赶工期的时候,总有那么一两个接口漏加装饰器,然后权限漏洞就出来了。依赖注入稍微好一点,但它要求路由函数签名里显式写参数,这本身就污染了业务函数。中间件是请求进入路由之前的最后一层(实际是进入完整 ASGI 应用之前的一层),所有请求都从它这里过,不存在"漏加"的可能性。
再说一个关键细节:中间件能捕获到路由未匹配的 404 请求。班级管理系统里有几个前端路由是动态拼接的,比如 /api/student/{student_id}/courses,如果前端拼错了 ID 类型,FastAPI 会返回默认的 404 响应,这个响应格式和业务接口不一样。用了中间件之后,这种 404 也被统一包装成同样的返回结构,前端只要写一种解析逻辑就够了。
2.2 中间件在 FastAPI 请求生命周期中的位置
要设计好中间件,必须先理解它在请求生命周期里的位置。FastAPI 基于 Starlette,请求进来之后大致走这样一条链路:
text复制客户端请求
→ Uvicorn/Gunicorn
→ 最外层自定义中间件
→ 下一层自定义中间件
→ ...(按注册顺序逐层深入)
→ 路由匹配
→ 依赖注入
→ 路径/查询参数解析
→ 业务函数执行
→ 返回响应
→ 响应返回时逐层向外回传
→ 客户端收到响应
中间件就像洋葱皮,请求要一层层剥进去,响应要一层层返出来。这个特性很重要,因为它决定了你可以在请求进入业务逻辑之前做"预处理",也可以在响应返回之后做"后处理"。比如日志中间件,请求进来时记录一句话,响应出去时再记录一句话,两边一拼就是完整的调用信息。
我在项目里一共实现了四个中间件,按注册顺序从外到内是:
- 统一返回格式中间件(最外层)
- 异常捕获中间件
- JWT 认证与权限中间件
- 请求日志中间件(最内层)
这个顺序是我调了几次才定下来的。最外层放返回格式统一,可以保证所有响应的外壳都是一致的;认证放在比较靠里的位置,是因为它依赖请求体里的 token,而且它只关注 /api 下的业务路由,对 /docs 和静态资源要放行;日志放在最内层,可以记录到经过权限过滤后的最终请求状态。
2.3 四层中间件的职责边界
很多人在写中间件的时候容易犯一个错误:把什么逻辑都往中间件里塞。我的原则是每个中间件只干一件事,职责边界要清晰:
- 返回格式中间件:负责给所有响应包一层
{"code": 0, "data": ..., "message": "success"}的外壳; - 异常捕获中间件:把未捕获的异常转成统一格式的 JSON 响应,避免堆栈信息直接暴露给前端;
- 认证与权限中间件:从 Header 里解析 JWT,校验角色权限,不通过就直接返回 401/403;
- 日志中间件:打印请求方法、路径、处理耗时、状态码,方便排查问题。
这四个中间件互相不依赖,各自独立,组合起来却覆盖了之前散落在各个业务函数里的所有重复代码。等我把它们都实现完后,删除的业务代码量大概有 300 多行,同时新增接口时再也不用复制粘贴鉴权逻辑了。
3. 中间件核心实现与关键细节拆解
3.1 统一返回格式中间件:终结接口格式混乱
先上代码,这是整个改造中收益最明显的一个中间件:
python复制import json
from fastapi import Request
from starlette.middleware.base import BaseHTTPMiddleware
from starlette.responses import Response, JSONResponse
class UnifiedResponseMiddleware(BaseHTTPMiddleware):
async def dispatch(self, request: Request, call_next):
# 对非API路径直接放行,比如 /docs、/redoc、/static
if not request.url.path.startswith("/api"):
return await call_next(request)
# 执行下游(业务路由、其他中间件),获得原始响应
raw_response = await call_next(request)
# 如果下游已经把响应改成了统一格式,或者响应本身无法读取 body,就原样返回
if getattr(raw_response, "unified", False):
return raw_response
# 读取响应体内容
body = b""
async for chunk in raw_response.body_iterator:
body += chunk
# 尝试解析 JSON,解析失败则返回原始内容
try:
data = json.loads(body)
except json.JSONDecodeError:
data = body.decode("utf-8")
# 如果业务响应已经是 {"code": xx, "data": yy} 结构,就不再二次包装
if isinstance(data, dict) and "code" in data and "data" in data:
wrapped = data
else:
wrapped = {
"code": 0,
"data": data,
"message": "success",
}
return JSONResponse(
status_code=raw_response.status_code,
content=wrapped,
headers=dict(raw_response.headers),
)
这个中间件的实现里有几个细节值得单独说。
首先是放行非 /api 路径。FastAPI 自动生成的 /docs 接口文档页和 /openapi.json 是给开发者看的,前端业务代码根本不会调用它们。如果把这些路径也包一层格式,Swagger UI 会解析失败,反而添乱。所以第一件事就是路径判断。
其次是"读取响应体"的方式。raw_response.body_iterator 是一个异步迭代器,必须用 async for 把它消费掉。很多人在这里会想当然地直接调 raw_response.body(),但要注意,经过 call_next 返回的响应对象虽然有 body 属性,但在某些情况下它并没有被完整加载。用异步迭代器聚合是最稳妥的做法。
再就是二次包装的判定。我的业务代码里有些接口为了兼容旧版本的调用方,已经手动返回了 {"code": 1, "data": {...}, "message": "..."} 这种结构。这种响应如果再用统一格式包一层,就会变成 {"code": 0, "data": {"code": 1, "data": ...}},嵌套两层,前端解析逻辑就要写两种情况。所以我加了一个判断:如果响应体本身已经是统一格式的 dict,就原样返回,不再包第二层。
还有一个隐藏问题:响应头。JSONResponse 默认会重新生成 content-length,如果你直接把它返回给前端,这个长度和内容是一致的,没毛病。但如果你从 raw_response.headers 里拷贝了 content-length,然后又传给了新的 JSONResponse,就会出现长度不匹配的问题,前端拿到响应后解析直接卡死。我的处理是不拷贝 content-length,让 JSONResponse 自己生成。我代码里写的是 headers=dict(raw_response.headers),这里其实是有风险的,建议你拷贝 headers 时把 content-length 剔除掉,确保安全。
3.2 全局异常捕获中间件:再也不用担心堆栈丢给前端
在中间件改造之前,我们的异常处理方式是每个路由函数里写 try...except Exception,然后返回一个错误提示。这种做法的毛病显而易见:代码重复严重,而且不同人写的错误消息风格还不一样。有个同学甚至直接返回了 raise HTTPException(status_code=500, detail="服务器炸了"),虽然功能没错,但"炸了"这种词出现在生产环境可不太好。
全局异常捕获中间件的代码如下:
python复制from fastapi import Request
from fastapi.responses import JSONResponse
from starlette.middleware.base import BaseHTTPMiddleware
class ExceptionHandlingMiddleware(BaseHTTPMiddleware):
async def dispatch(self, request: Request, call_next):
try:
response = await call_next(request)
return response
except Exception as e:
# 记录异常堆栈到日志
import traceback
traceback.print_exc()
return JSONResponse(
status_code=500,
content={
"code": 500,
"data": None,
"message": f"服务异常: {str(e)}",
},
)
这个中间件看似简单,但有几个细节需要注意。
第一,异常捕获中间件的注册位置要在返回格式中间件的内层。原因很容易理解:如果异常在返回格式中间件里抛出,而异常捕获中间件在外层,它就无法捕获到。注册顺序(从外到内)是 [返回格式, 异常捕获],这样异常捕获中间件能覆盖到所有业务路由和它外层之间的逻辑。
第二,traceback.print_exc() 在生产环境不要全部打印。我们后来加了 logging 模块,把堆栈信息写入专门的 error 日志文件,控制台只打一条摘要。日志级别也做了区分:4xx 状态码不算异常,5xx 才打 ERROR。
第三,这个中间件捕获的是"未处理"异常。FastAPI 自身的 HTTPException 会由框架层处理并返回正常的 JSON 响应,不会走到这里。所以如果你用 HTTPException 来做业务错误提示,那统一格式中间件会把它包装成 {"code": 0, "data": {}, "message": "xxx"}——但这时候 HTTP 状态码可能是 404 或 403,前端就得同时判断 HTTP 状态码和 body 里的 code。为了彻底统一,我们后来在项目里约定:业务错误全部通过自定义异常抛出(比如 BizException),由异常捕获中间件统一转成 {"code": 业务码, "data": None, "message": "具体错误"},HTTP 状态码固定 200。这样前端只需要解析 body 里的 code,逻辑大大简化。
当时有人质疑"HTTP 状态码永远返回 200"不符合 RESTful 规范,我承认有道理。但在班级管理系统这种前后端分离且没有严格的 API 规范约束的团队里,统一简化比规范更重要。如果你有强规范要求,可以折中:HTTP 状态码保持原样,body 里的 code 额外再给一个业务码。
3.3 JWT 认证与权限控制中间件:权限管理的统一入口
这是整个改造里我写得最久、调试次数最多的中间件。先放核心代码:
python复制from fastapi import Request
from fastapi.responses import JSONResponse
from starlette.middleware.base import BaseHTTPMiddleware
import jwt
from config import SECRET_KEY, ALGORITHM
# 不需要认证的路由白名单
WHITE_LIST = {
"/api/auth/login",
"/api/auth/register",
"/api/health",
}
# 路径前缀 → 允许的角色集合
ROLE_PERMISSIONS = {
"/api/admin": ["admin"],
"/api/teacher": ["admin", "teacher"],
"/api/student": ["admin", "teacher", "student"],
"/api/course": ["admin", "teacher", "student"],
"/api/attendance": ["admin", "teacher"],
}
class AuthMiddleware(BaseHTTPMiddleware):
async def dispatch(self, request: Request, call_next):
# 非 API 路径直接放行
if not request.url.path.startswith("/api"):
return await call_next(request)
# 白名单直接放行
if request.url.path in WHITE_LIST:
return await call_next(request)
# 获取 Authorization Header
auth_header = request.headers.get("Authorization", "")
if not auth_header.startswith("Bearer "):
return JSONResponse(status_code=401, content={
"code": 401, "data": None, "message": "未登录或token缺失"
})
token = auth_header[7:]
try:
payload = jwt.decode(token, SECRET_KEY, algorithms=[ALGORITHM])
except jwt.ExpiredSignatureError:
return JSONResponse(status_code=401, content={
"code": 401, "data": None, "message": "token已过期"
})
except jwt.InvalidTokenError:
return JSONResponse(status_code=401, content={
"code": 401, "data": None, "message": "token无效"
})
# 将用户信息挂载到 request.state,供后续业务函数读取
request.state.user = payload
# 权限校验:根据路径前缀判断所需角色
user_role = payload.get("role", "")
allowed_roles = None
for prefix, roles in ROLE_PERMISSIONS.items():
if request.url.path.startswith(prefix):
allowed_roles = roles
break
if allowed_roles and user_role not in allowed_roles:
return JSONResponse(status_code=403, content={
"code": 403, "data": None, "message": "权限不足"
})
return await call_next(request)
这个中间件踩了两个大坑,我详细说说。
第一个坑是白名单的判断。班级管理系统的登录接口必须允许未认证用户访问,否则就死循环了。但我们的路由设计是 APIRouter 里路径会加上 /api/auth/login,我在白名单里写的是字符串精确匹配。后来前端传来的实际路径带了尾部斜杠,比如 /api/auth/login/,这就匹配不上白名单,直接被 401 挡回去了。排查了很久才发现是尾部斜杠的问题。解决方案很简单:用 request.url.path.rstrip("/") 去掉尾巴再匹配。
第二个坑是权限模型的粒度。起初我图省事,只区分了"是否登录"和"是否管理员",后来发现学生模块某些接口允许学生自己查询,教师模块某些接口允许管理员代为操作,就不得不引入更细粒度的策略。我的做法是维护一个角色映射表,在配置里写清楚每个路径前缀允许哪些角色访问。实际项目中你也可以用更严谨的 RBAC 表存数据库,但班级管理系统这个量级,配置文件里写死就够用了,关键是快。
关于在中间件里给业务函数传用户信息,我用的是 request.state.user = payload。业务层在路由函数里可以通过 request.state.user.get("user_id") 拿到当前登录用户 ID。这里有一个非常实用的技巧:把用户信息挂到 request.state 后,你就不再需要在各个路由里重复写解析 token 的代码了,而且业务函数也拿不到 token 明文,安全性更高。
3.4 请求日志中间件:给每个接口装上"黑匣子"
日志中间件是我在开发阶段临时加的,后来发现它在排查线上问题时简直太好用,就保留了下来。它的主要功能是打印请求方法、路径、耗时、状态码,并在响应体里追加一个 trace_id,方便前后端联调时对齐问题。
python复制import time
import uuid
from fastapi import Request
from starlette.middleware.base import BaseHTTPMiddleware
class LoggingMiddleware(BaseHTTPMiddleware):
async def dispatch(self, request: Request, call_next):
start_time = time.time()
trace_id = str(uuid.uuid4())[:8]
request.state.trace_id = trace_id
response = await call_next(request)
duration_ms = (time.time() - start_time) * 1000
# 在响应头中带上 trace_id
response.headers["X-Trace-ID"] = trace_id
print(
f"[{trace_id}] {request.method} {request.url.path} "
f"-> {response.status_code} | {duration_ms:.1f}ms"
)
return response
这个中间件有一个值得展开讲的细节:给每个请求生成 trace_id。在联调的时候,前端同学经常说"我这边调接口报错了,你帮我查一下服务端日志"。如果没有任何关联标识,你得靠时间、IP、路径去猜是哪一条。有了 trace_id,前端把响应头里的 X-Trace-ID 发给你,你用 grep 直接搜这个 ID 就能定位到对应的日志,效率提升立竿见影。
我后来还给它加了一项功能:记录请求体。开发环境方便调试,但生产环境要注意,请求体里可能包含用户密码等敏感信息。我的做法是给中间件加一个开关,在环境变量里配置 LOG_BODY=True 才打印请求体,生产环境默认关闭。
日志中间件的执行顺序被我放在最内层,这有一个小问题:它记录的耗时只包含"经过了它之后"的逻辑,也就是从路由匹配开始的耗时,而外层中间件的耗时(比如统一格式包装、异常处理)没有被统计进去。从排查问题的角度看,这个误差可以接受,因为真正耗时的部分在业务函数里。如果你要精确统计全链路耗时,建议把日志中间件放在最外层。
3.5 补充:CORS 中间件与 FastAPI 内置中间件
班级管理系统在前端部署时用了不同的域名或端口(比如前端跑在 8080,后端跑在 8000),所以跨域问题也得处理。FastAPI 自带 CORSMiddleware,配置很简单:
python复制from fastapi.middleware.cors import CORSMiddleware
app.add_middleware(
CORSMiddleware,
allow_origins=["http://localhost:8080", "https://your-frontend-domain.com"],
allow_credentials=True,
allow_methods=["*"],
allow_headers=["*"],
)
这里面有一个常见的误区:跨域配置会影响中间件的执行顺序吗?不会。CORSMiddleware 和自定义中间件一样按注册顺序执行。我一般把 CORS 放在最外层,这样预检请求(OPTIONS)在最外层直接处理掉,不会深入到下面的业务逻辑和认证中间件。如果你把 CORS 放在认证之后,预检请求没有 Authorization Header,会被认证中间件直接 401 拒掉,前端就会报跨域错误,排查起来特别迷惑。
还有一个值得注意的细节:allow_origins 不要写 ["*"] 和 allow_credentials=True 同时使用。Starlette 遇到这种配置会直接抛 ValueError 或在运行时行为异常,因为浏览器不允许带凭据的跨域请求使用通配符来源。我一开始就踩了这个坑,后来老老实实列出了具体域名。
4. 常见问题与排查技巧实录
4.1 BaseHTTPMiddleware 的流式响应与缓冲问题
BaseHTTPMiddleware 虽然写起来直观,但它有一个老问题:它默认会把响应体整体缓冲,然后再交给下游处理。这意味着如果你在中间件里返回一个很长的流式响应,中间件会一直攒着不发给前端,等全部读完再一次性返回。对于文件下载、SSE(服务端推送事件)这种场景,这会造成明显延迟,甚至前端会误以为服务端没有响应。
我在班级管理系统的导出成绩功能里就遇到了这个问题。导出的 Excel 文件有几 MB,用户在页面上点了"导出"按钮后久久看不到下载弹窗,最后是因为中间件缓冲了完整文件才返回。排查后发现是日志中间件的 ASCII 流式消费方式导致响应被整体读了一遍。
解决方案有两个:一是对下载、SSE 这类接口,在中间件里做路径判断,直接 call_next 不做响应体读取;二是将 BaseHTTPMiddleware 换成纯 ASGI 中间件,手动处理 send/receive 调用链,但代码复杂度会高不少。我建议中小型项目用方案一就够了,无非是在统一返回格式中间件和日志中间件里都加一个"是否处理响应体"的判断条件。
4.2 响应体消费与二次读取问题
中间件调 call_next 之后,响应体其实已经被消费了一次。如果你在日志中间件里读取了 body,再往后面传,外层包装中间件就读取不到内容了,导致返回格式包装失败。这个问题的本质是:ASGI 的响应体是一个一次性迭代器,不能被多个中间件重复消费。
我的解决方案是在最内层日志中间件里不读取响应体,只记录状态码和耗时;需要读取响应体做统一包装的只有最外层返回格式中间件,而且它读取完直接生成新的 JSONResponse 返回,不再传给更外层(它本身就是最外层)。所以整个链路中,响应体只会被读取一次,不会冲突。
如果你确实需要多个中间件都读取响应体,那就得在第一次读取后把 body 存起来,然后重新构造一个新的响应对象传给下一个中间件。这种写法比较绕,我试过,代码量翻了一倍。建议从一开始就规划好"哪个中间件负责消费 body",其他中间件只做旁路处理。
4.3 中间件顺序对认证放行逻辑的影响
中间件顺序问题调试起来非常隐蔽,因为大多数时候看起来运行正常,但特定接口就会莫名报错。我碰到过的一个典型案例是:把认证中间件放在返回格式中间件外层。认证不通过时它会直接返回 401 JSON,但这个 JSON 没有经过统一返回格式中间件的包装,导致前端收到的结构和其他接口不一样,解析逻辑直接崩了。
正确顺序应该是返回格式中间件在最外层,认证中间件在它内部。这样认证失败产生的 401 响应也会被最外层包一层统一格式,前端只用写一套解析逻辑。这个顺序问题如果靠"跑一次看结果"来调整,可能要到某个特定接口触发 401 才能发现,很容易遗漏。建议你在设计中间件时画一张执行顺序图,标清楚每个中间件的"放行条件"和"失败时的响应路径",提前排掉顺序坑。
我整理了一张我们团队后来一直遵守的中间件注册顺序速查表:
| 注册顺序(从外到内) | 中间件 | 主要职责 | 失败时行为 |
|---|---|---|---|
| 1 | CORSMiddleware | 处理跨域预检 | 直接阻断非法跨域 |
| 2 | 统一返回格式中间件 | 包装响应体 | 将异常也包装为统一结构 |
| 3 | 全局异常捕获中间件 | 捕获未处理异常 | 返回 500 统一结构 |
| 4 | JWT 认证中间件 | 鉴权与权限校验 | 返回 401/403 |
| 5 | 请求日志中间件 | 记录耗时与 trace_id | 不阻断请求 |
这个顺序只要定了,一般不会再改动。每次新增中间件之前,先按这个顺序表想清楚它应该插在哪一层,避免后续返工。
4.4 静态文件与文档路由的放行策略
FastAPI 自带 /docs、/redoc、/openapi.json 这些接口文档路径,还有挂载静态文件时用的 /static 路径。这些路径如果被认证中间件拦截,团队的同学想看接口文档都打不开,非常影响开发效率。
放行逻辑很简单,但有一个细节容易被忽略:如果你是先写一个 APIRouter 前缀 /api,又挂载了静态文件目录 /static,那么中间件判断路径时,应该只对 /api 前缀做统一格式和认证处理,对 /static 直接放行。这看起来很简单,但如果你的项目里还有一个 /api/static 之类的路径,就会出问题。
我的建议是在中间件顶部统一做一个路径分类函数:
python复制def should_skip_middleware(path: str) -> bool:
skip_prefixes = ("/docs", "/redoc", "/openapi.json", "/static", "/health")
return any(path.startswith(p) for p in skip_prefixes)
然后在每个中间件 dispatch 的最开头调用它,决定是否直接 call_next。这样写的好处是,将来新增需要放行的路径,只需要改这一个函数,不用去四个中间件里分别改。
4.5 调试中间件的三个实用技巧
中间件是异步链路,调试起来比普通函数麻烦。我给三个实用经验。
第一,用日志追踪执行顺序。在中间件的 dispatch 开头和结尾分别打印 [MiddlewareA] enter 和 [MiddlewareA] exit,启动服务后看一次请求的日志输出,就能直观看到执行顺序是否符合预期。这个技巧在调顺序问题时特别管用。
第二,临时关闭中间件做对比实验。我在改造过程中经常因为中间件引入新问题而怀疑业务代码。这时候最有效的方法是给 app 加一个环境变量开关,比如 DISABLE_MIDDLEWARE=1 时把所有自定义中间件跳过。这样如果关闭中间件后接口正常,问题就一定在中间件里;如果关闭后还是报错,那就是业务代码的问题。能快速二分定位问题源头。
第三,用 TestClient 写自动化测试。FastAPI 的 TestClient 基于 httpx,能直接走完整个中间件链路。我在改造完成后写了一批接口测试,专门验证带中间件和不带中间件时的响应结构差异。有了这批测试,后续改动中间件时就能自动回归,不用担心"改了一个中间件把另一个中间件搞坏了"。
5. 改造前后对比与实际效果
改造完成后的第一个星期,我专门统计了一下代码量和开发效率的变化。
改动前:路由文件里有 40 多处重复的 JWT 解析代码(每个需要登录的接口都要写一遍),30 多处 try...except Exception 的异常处理,接口返回结构至少有三种风格。前端对接新接口时,第一件事永远是问"这个接口返回格式是什么",而不是直接写代码。
改动后:所有接口默认使用统一格式 {"code": 0, "data": ..., "message": "success"},前端封装了一个 request 工具函数,里面只解析这一种结构。新增接口时不再需要写鉴权逻辑,只要在路由里正常写业务代码就行。异常处理也统一了,前端只需要判断 code 是否为 0,非 0 就弹 message。
从代码行数来看,删掉的重复代码大约 300 行,新增的中间件代码约 200 行,净减少约 100 行。看起来不多,但这 100 行是"一次性写完后所有接口都在复用"的公共代码,边际收益是巨大的。更重要的是,新增一个接口的平均开发时间从之前的 2 小时降到了 1 小时内,因为少了很多"复制鉴权代码 + 调整返回格式"的机械劳动。
我带的一个实习生刚开始接触这套代码时,半天就能上手写新接口了。他只需要知道三件事:路由文件放哪、业务函数怎么写、遇到业务错误时 raise BizException("具体提示")。这个学习成本降低的效果,我觉得比删代码本身更有价值。
6. 关于后续扩展的一点建议
班级管理系统的改造只是一个开始。如果你跟着这篇文章的思路做完了中间件统一,后面还可以考虑几个方向。
第一,加一个接口响应时间监控中间件,把超过阈值的慢接口记录到数据库或者告警系统。学生选课高峰期经常有慢查询,我们后来就是靠记录耗时数据定位到了几个需要加索引的表。
第二,把权限映射从配置文件改成数据库表。当系统角色数量超过 5 个、权限策略越来越复杂时,配置文件会越来越难维护,数据库化更灵活。
第三,把中间件抽成独立的 Python 包,方便其他项目复用。我后来把这套中间件整理成了一个内部工具包,新项目直接 pip install 就能用,连配置项都省得重新写。
中间件这个东西,看起来就是几段代码,但用好了能把整个项目的开发体验提升一个档次。希望这篇实战记录能给你一些启发。
