增加自定义参数字段校验返回自定义格式，自定义错误提示消息

cloud-java · cloud-java · commit c0bb3c61ac56 · 2023-12-01T17:09:17.000+08:00
diff --git a/README.md b/README.md
@@ -1,4 +1,12 @@
 ## FastAPI 框架精讲
+
+# 如何设置虚拟环境
+1. cd 项目目录
+2. virtualenv venv
+3. cd venv/bin
+4. source activate
+5. cd 项目目录
+6. pip3 install -i https://pypi.tuna.tsinghua.edu.cn/simple -r requirements.txt
 > 整体的介绍 FastAPI，快速上手开发，结合 API 交互文档逐个讲解核心模块的使用
 
 ![drf-tutorial](./coronavirus/static/fastapi-tutorial.png)
@@ -347,4 +355,6 @@ FastAPI 项目中 Jinja2 配置，使用 Jinja2 渲染 COVID-19 查询页面，
 
 #### 9.1 课程总结
 
-回顾课程内容与重难点，总结经验、心得以及扩展建议。
+回顾课程内容与重难点，总结经验、心得以及扩展建议。## 
+> 整体的介绍 FastAPI，快速上手开发，结合 API 交互文档逐个讲解核心模块的使用
+ 框架精讲## h 框架精讲
diff --git a/requirements.txt b/requirements.txt
@@ -1,4 +1,6 @@
 aiofiles==0.6.0
+annotated-types==0.6.0
+anyio==3.7.1
 atomicwrites==1.4.0
 attrs==20.3.0
 bcrypt==3.2.0
@@ -11,7 +13,8 @@ cryptography==3.3.1
 dnspython==2.0.0
 ecdsa==0.14.1
 email-validator==1.1.2
-fastapi==0.63.0
+exceptiongroup==1.2.0
+fastapi==0.104.1
 h11==0.11.0
 idna==2.10
 importlib-metadata==3.3.0
@@ -24,18 +27,20 @@ pluggy==0.13.1
 py==1.10.0
 pyasn1==0.4.8
 pycparser==2.20
-pydantic==1.7.3
+pydantic==2.5.2
+pydantic_core==2.14.5
 pyparsing==2.4.7
 pytest==6.2.1
 python-jose==3.2.0
 python-multipart==0.0.5
 requests==2.25.1
 rsa==4.6
 six==1.15.0
+sniffio==1.3.0
 SQLAlchemy==1.3.22
-starlette==0.13.6
+starlette==0.27.0
 toml==0.10.2
-typing-extensions==3.7.4.3
+typing_extensions==4.8.0
 urllib3==1.26.2
 uvicorn==0.13.2
 zipp==3.4.0
diff --git a/run.py b/run.py
@@ -7,12 +7,14 @@
 from fastapi import FastAPI, Request
 from fastapi.middleware.cors import CORSMiddleware
 from fastapi.staticfiles import StaticFiles
+from pydantic import ValidationError
 
+import tutorial.chapter03
 from coronavirus import application
 from tutorial import app03, app04, app05, app06, app07, app08
 
-# from fastapi.exceptions import RequestValidationError
-# from fastapi.responses import PlainTextResponse
+from fastapi.exceptions import RequestValidationError
+from fastapi.responses import PlainTextResponse,JSONResponse
 # from starlette.exceptions import HTTPException as StarletteHTTPException
 
 app = FastAPI(
@@ -37,23 +39,53 @@
 #     return PlainTextResponse(str(exc.detail), status_code=exc.status_code)
 #
 #
+
+
+# @app.exception_handler(ValidationError)  # 重写HTTPException异常处理器
+# async def http_exception_handler(request, exc):
+#     print("&&&"*90)
+#     """
+#     :param request: 这个参数不能省
+#     :param exc:
+#     :return:
+#     """
+#     return PlainTextResponse(str(exc.detail), status_code=exc.status_code)
+# 1.用户自定义异常类型，只要该类继承了Exception类即可
+@app.exception_handler(tutorial.chapter03.ValDtoError)
+async def request_validation_exception_handler2(request: Request, exc: tutorial.chapter03.ValDtoError):
+    print(f"===>参数校验异常{request.method} {request.url}")
+    return JSONResponse({"message":exc.message})
 # @app.exception_handler(RequestValidationError)  # 重写请求验证异常处理器
 # async def validation_exception_handler(request, exc):
+#
 #     """
 #     :param request: 这个参数不能省
 #     :param exc:
 #     :return:
 #     """
-#     return PlainTextResponse(str(exc), status_code=400)
+#     print("222"*10)
+#     # 自定义错误输出信息
+#     errors = []
+#     for error in exc.errors():
+#         print(error)
+#         print(type(error))
+#         errors.append({
+#             "loc": error["loc"],
+#             "msg": error["msg"],
+#             "type": error["type"]
+#         })
+#     # raise HTTPException(status_code=422, detail=errors)
+#
+#     return PlainTextResponse(str(errors), status_code=400)
 
 
-@app.middleware('http')
-async def add_process_time_header(request: Request, call_next):  # call_next将接收request请求做为参数
-    start_time = time.time()
-    response = await call_next(request)
-    process_time = time.time() - start_time
-    response.headers['X-Process-Time'] = str(process_time)  # 添加自定义的以“X-”开头的请求头
-    return response
+# @app.middleware('http')
+# async def add_process_time_header(request: Request, call_next):  # call_next将接收request请求做为参数
+#     start_time = time.time()
+#     response = await call_next(request)
+#     process_time = time.time() - start_time
+#     response.headers['X-Process-Time'] = str(process_time)  # 添加自定义的以“X-”开头的请求头
+#     return response
 
 
 app.add_middleware(
diff --git a/tutorial/chapter03.py b/tutorial/chapter03.py
@@ -4,10 +4,10 @@
 
 from datetime import date
 from enum import Enum
-from typing import Optional, List
+from typing import Optional, List, Annotated
 
 from fastapi import APIRouter, Query, Path, Body, Cookie, Header
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, Field, BeforeValidator
 
 app03 = APIRouter()
 
@@ -45,7 +45,7 @@ def filepath(file_path: str):
 
 @app03.get("/path_/{num}")
 def path_params_validate(
-    num: int = Path(..., title="Your Number", description="不可描述", ge=1, le=10),
+        num: int = Path(..., title="Your Number", description="不可描述", ge=1, le=10),
 ):
     return num
 
@@ -65,30 +65,49 @@ def type_conversion(param: bool = False):
     return param
 
 
+class ValDtoError(Exception):
+    # 初始化
+    def __init__(self, message):
+        self.message = message
+
+    # 类一般返回值
+    def __str__(self):
+        return "参数校验异常！" + self.message
+
+
 @app03.get("/query/validations")  # 长度+正则表达式验证，比如长度8-16位，以a开头。其它校验方法看Query类的源码
 def query_params_validate(
-    value: str = Query(..., min_length=8, max_length=16, regex="^a"),  # ...换成None就变成选填的参数
-    values: List[str] = Query(["v1", "v2"], alias="alias_name")
+        value: str = Query(..., min_length=8, max_length=16, regex="^a"),  # ...换成None就变成选填的参数
+        values: List[str] = Query(["v1", "v2"], alias="alias_name")
 ):  # 多个查询参数的列表。参数别名
     return value, values
 
 
 """Request Body and Fields 请求体和字段"""
 
 
+def curr_page_v(v: int) -> int:
+    if 111 > v:
+        raise ValDtoError('开始页不能小于0!')
+    return v
+
+
 class CityInfo(BaseModel):
     name: str = Field(..., example="Beijing")  # example是注解的作用，值不会被验证
     country: str
     country_code: str = None  # 给一个默认值
     country_population: int = Field(default=800, title="人口数量", description="国家的人口数量", ge=800)
 
+    currPage: Annotated[int, BeforeValidator(curr_page_v)]
+
     class Config:
         schema_extra = {
             "example": {
                 "name": "Shanghai",
                 "country": "China",
                 "country_code": "CN",
                 "country_population": 1400000000,
+                "price": "210.0"
             }
         }
 
@@ -104,11 +123,11 @@ def city_info(city: CityInfo):
 
 @app03.put("/request_body/city/{name}")
 def mix_city_info(
-    name: str,
-    city01: CityInfo,
-    city02: CityInfo,  # Body可以是多个的
-    confirmed: int = Query(ge=0, description="确诊数", default=0),
-    death: int = Query(ge=0, description="死亡数", default=0),
+        name: str,
+        city01: CityInfo,
+        city02: CityInfo,  # Body可以是多个的
+        confirmed: int = Query(ge=0, description="确诊数", default=0),
+        death: int = Query(ge=0, description="死亡数", default=0),
 ):
     if name == "Shanghai":
         return {"Shanghai": {"confirmed": confirmed, "death": death}}
@@ -117,9 +136,9 @@ def mix_city_info(
 
 @app03.put("/request_body/multiple/parameters")
 def body_multiple_parameters(
-    city: CityInfo = Body(..., embed=True),  # 当只有一个Body参数的时候，embed=True表示请求体参数嵌套。多个Body参数默认就是嵌套的
-    confirmed: int = Query(ge=0, description="确诊数", default=0),
-    death: int = Query(ge=0, description="死亡数", default=0),
+        city: CityInfo = Body(..., embed=True),  # 当只有一个Body参数的时候，embed=True表示请求体参数嵌套。多个Body参数默认就是嵌套的
+        confirmed: int = Query(ge=0, description="确诊数", default=0),
+        death: int = Query(ge=0, description="死亡数", default=0),
 ):
     print(f"{city.name} 确诊数：{confirmed} 死亡数：{death}")
     return city.dict()
