57 lines
2.6 KiB
Python
57 lines
2.6 KiB
Python
"""Uniform error payloads + exception handlers."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from fastapi import FastAPI, Request, status
|
|
from fastapi.exceptions import RequestValidationError
|
|
from fastapi.responses import JSONResponse
|
|
from sqlalchemy.exc import IntegrityError
|
|
from starlette.exceptions import HTTPException as StarletteHTTPException
|
|
|
|
|
|
class AppError(Exception):
|
|
"""Business rule violation -> HTTP 400 with a readable Chinese message."""
|
|
|
|
def __init__(self, message: str, code: str = "business_error",
|
|
status_code: int = status.HTTP_400_BAD_REQUEST) -> None:
|
|
self.message = message
|
|
self.code = code
|
|
self.status_code = status_code
|
|
super().__init__(message)
|
|
|
|
|
|
def register_exception_handlers(app: FastAPI) -> None:
|
|
@app.exception_handler(AppError)
|
|
async def _app_error(_: Request, exc: AppError) -> JSONResponse:
|
|
return JSONResponse({"code": exc.code, "message": exc.message}, status_code=exc.status_code)
|
|
|
|
@app.exception_handler(StarletteHTTPException)
|
|
async def _http_error(_: Request, exc: StarletteHTTPException) -> JSONResponse:
|
|
detail = exc.detail if isinstance(exc.detail, (str, list, dict)) else str(exc.detail)
|
|
if exc.status_code in (401, 403):
|
|
message = "登录状态已失效,请重新登录" if exc.status_code == 401 else "没有该操作的权限"
|
|
if isinstance(detail, str) and detail and detail not in ("Unauthorized", "Forbidden"):
|
|
message = detail
|
|
return JSONResponse({"code": f"http_{exc.status_code}", "message": message},
|
|
status_code=exc.status_code)
|
|
return JSONResponse({"code": f"http_{exc.status_code}", "message": detail},
|
|
status_code=exc.status_code)
|
|
|
|
@app.exception_handler(RequestValidationError)
|
|
async def _validation_error(_: Request, exc: RequestValidationError) -> JSONResponse:
|
|
fields = []
|
|
for err in exc.errors():
|
|
loc = [str(x) for x in err.get("loc", []) if x not in ("body", "query", "path")]
|
|
fields.append({"field": ".".join(loc) or "-", "message": err.get("msg", "")})
|
|
return JSONResponse(
|
|
{"code": "validation_error", "message": "提交的数据不符合要求", "fields": fields},
|
|
status_code=status.HTTP_422_UNPROCESSABLE_ENTITY,
|
|
)
|
|
|
|
@app.exception_handler(IntegrityError)
|
|
async def _integrity_error(_: Request, exc: IntegrityError) -> JSONResponse:
|
|
return JSONResponse(
|
|
{"code": "integrity_error", "message": "数据已存在或被其它记录引用,无法保存"},
|
|
status_code=status.HTTP_409_CONFLICT,
|
|
)
|