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 在模型层面统一拦截,错误仍归到对应字段,前端能精准提示。

人民网AIGC-X
人民网AIGC-X

国内科研机构联合推出的AI生成内容检测工具

下载
  • 多个字段交叉校验时,用 @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" —— 任意字段都能进模型,等于放弃字段白名单控制。

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

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

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

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

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

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
Python Flask框架
Python Flask框架

本专题专注于 Python 轻量级 Web 框架 Flask 的学习与实战,内容涵盖路由与视图、模板渲染、表单处理、数据库集成、用户认证以及RESTful API 开发。通过博客系统、任务管理工具与微服务接口等项目实战,帮助学员掌握 Flask 在快速构建小型到中型 Web 应用中的核心技能。

104

2025.08.25

Python Flask Web框架与API开发
Python Flask Web框架与API开发

本专题系统介绍 Python Flask Web框架的基础与进阶应用,包括Flask路由、请求与响应、模板渲染、表单处理、安全性加固、数据库集成(SQLAlchemy)、以及使用Flask构建 RESTful API 服务。通过多个实战项目,帮助学习者掌握使用 Flask 开发高效、可扩展的 Web 应用与 API。

81

2025.12.15

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

455

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

546

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

334

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

82

2025.09.10

Python FastAPI异步API开发_Python怎么用FastAPI构建异步API
Python FastAPI异步API开发_Python怎么用FastAPI构建异步API

Python FastAPI 异步开发利用 async/await 关键字,通过定义异步视图函数、使用异步数据库库 (如 databases)、异步 HTTP 客户端 (如 httpx),并结合后台任务队列(如 Celery)和异步依赖项,实现高效的 I/O 密集型 API,显著提升吞吐量和响应速度,尤其适用于处理数据库查询、网络请求等耗时操作,无需阻塞主线程。

28

2025.12.22

Python 微服务架构与 FastAPI 框架
Python 微服务架构与 FastAPI 框架

本专题系统讲解 Python 微服务架构设计与 FastAPI 框架应用,涵盖 FastAPI 的快速开发、路由与依赖注入、数据模型验证、API 文档自动生成、OAuth2 与 JWT 身份验证、异步支持、部署与扩展等。通过实际案例,帮助学习者掌握 使用 FastAPI 构建高效、可扩展的微服务应用,提高服务响应速度与系统可维护性。

251

2026.02.06

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

76

2026.03.11

热门下载

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

精品课程

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

共4课时 | 22.5万人学习

Django 教程
Django 教程

共28课时 | 4.9万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.9万人学习

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

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