0

0

Python接口参数校验设计_避免脏数据进入系统【技巧】

舞夢輝影

舞夢輝影

发布时间:2025-12-25 22:04:02

|

147人浏览过

|

来源于php中文网

原创

Pydantic BaseModel 提供自动类型转换、多级校验与错误聚合:str 用 min_length=1 拦截空白符,int 自动转类型并报错,嵌套结构逐层校验;Query/Path/Body 需分入口校验;业务规则用 @field_validator 或 @model_validator 统一处理,避免路由中手动 try/except。

python接口参数校验设计_避免脏数据进入系统【技巧】

pydantic 定义请求模型,而不是手写 if/else

直接在 FastAPI 或 Flask 中用 if 判断字段类型、长度、是否为空,短期快,长期难维护,且容易漏掉边界情况(比如空字符串当 None、数字字符串没转类型)。pydanticBaseModel 能自动完成类型转换 + 校验 + 错误聚合。

  • str 字段加 min_length=1if not value: 更准——它能拦住空白符("\t\n "
  • int 字段声明后,传入 "123" 会自动转成 123;传入 "abc" 直接报 value_error,不进业务逻辑
  • 嵌套结构(如地址对象)也能一层层校验,不用手动 dict.get("addr", {}).get("city")
from pydantic import BaseModel, Field

class CreateUserRequest(BaseModel):
    name: str = Field(..., min_length=2, max_length=20)
    age: int = Field(..., ge=0, le=150)
    email: str = Field(..., regex=r"^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$")

区分 QueryPathBody 的校验入口点

不是所有参数都该塞进同一个 BaseModel。FastAPI 会根据参数来源自动调用不同校验逻辑,混用会导致默认值失效或错误提示不清晰。

  • Query 参数(URL ?key=value)适合用 Query(default=None, min_length=1) 单独约束,避免把可选查询条件硬塞进请求体模型
  • Path 参数(如 /users/{uid})必须用 Path(..., ge=1) 显式声明校验,否则 uid=0 或负数可能绕过检查
  • Body(JSON 请求体)才用 BaseModel 类;若同时有 body + query,FastAPI 会合并报错信息,但各字段的校验上下文要分开写

自定义校验用 @field_validator,别在路由函数里 try/except

业务规则(比如“密码不能和用户名相同”“结束时间不能早于开始时间”)不适合塞进字段级约束,硬写会破坏模型复用性。用 @field_validator 在模型层面统一拦截,错误仍归到对应字段,前端能精准提示。

  • 多个字段交叉校验时,用 @model_validator(mode="after"),取 self.field1self.field2 对比
  • 避免在路由函数里捕获 ValidationError 再包装返回——FastAPI 默认已处理,重复 catch 会让堆变深、错误位置偏移
  • 自定义错误消息用 raise ValueError("起止时间顺序错误")pydantic 会自动转成标准 JSON 错误格式
from pydantic import field_validator

class TimeRangeRequest(BaseModel):
    start: datetime
    end: datetime

    @field_validator("end")
    def end_after_start(cls, v, info):
        start = info.data.get("start")
        if start and v <= start:
            raise ValueError("end must be after start")
        return v

生产环境关掉 extra="forbid" 以外的宽松模式

开发时开 extra="ignore" 看似方便,但会让前端多传字段(比如调试加的 _debug=1)静默丢弃,后期排查问题时找不到数据去向。更危险的是 extra="allow" —— 任意字段都能进模型,等于放弃字段白名单控制。

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

下载

立即学习Python免费学习笔记(深入)”;

  • 始终设 model_config = ConfigDict(extra="forbid"),多传字段直接报 extra_forbidden
  • 若需兼容旧字段,用 Field(default=None, exclude=True) 显式声明并忽略,而不是靠 ignore 模糊处理
  • Swagger UI 中看到的请求示例,会严格按模型字段生成,避免误导前端传参

最常被忽略的是:校验不是越严越好,而是要让错误发生在**离用户最近的地方**——URL 解析失败、JSON 解析失败、字段校验失败,这三个层级的错误信息必须互不干扰,且能准确定位到具体字段名和原因。否则一个 422 Unprocessable Entity 返回几十行嵌套错误,前端根本没法映射到表单控件。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

707

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

625

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

734

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

616

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1234

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

547

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

573

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

695

2023.08.11

笔记本电脑卡反应很慢处理方法汇总
笔记本电脑卡反应很慢处理方法汇总

本专题整合了笔记本电脑卡反应慢解决方法,阅读专题下面的文章了解更多详细内容。

1

2025.12.25

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 0.6万人学习

Django 教程
Django 教程

共28课时 | 2.4万人学习

SciPy 教程
SciPy 教程

共10课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号