0

0

pydantic v2 如何自定义字段验证器(field_validator vs field_serializer)

冷炫風刃

冷炫風刃

发布时间:2026-01-23 19:42:08

|

219人浏览过

|

来源于php中文网

原创

field_validator用于校验并可选修改已解析字段值,不负责类型转换;它在解析阶段运行,接收同类型输入、返回同类型输出,多个按定义顺序执行,不可做I/O;field_serializer则仅在序列化时控制输出格式,与输入校验无关。

pydantic v2 如何自定义字段验证器(field_validator vs field_serializer)

field_validator 用来改值或抛错,不是做类型转换的

它在数据解析阶段运行,作用是校验并可选地修改字段原始输入值。比如把字符串转成小写、检查邮箱格式、拒绝空字符串等。注意它不负责类型转换——那是 BeforeValidator 或模型字段类型本身该干的事。

  • field_validator 接收的是已初步解析后的值(比如 str 字段收到的就是字符串,不是原始 JSON 字符串)
  • 必须返回同类型的值,或抛出 ValueError/TypeError;返回其他类型会静默失败或触发后续类型错误
  • 多个 @field_validator 按定义顺序执行,前一个的返回值是后一个的输入
  • 别在里面做 I/O 或耗时操作,它属于解析路径,影响初始化性能

field_serializer 控制输出,不影响输入和校验

它只在调用 model.model_dump()model.model_dump_json()print(model) 等序列化场景触发,对字段赋值、校验、内部存储完全无感。典型用途是脱敏、格式标准化、添加计算字段。

  • 默认不启用,需显式传 mode='json'mode='python' 才生效;不加 mode 参数时不会被调用
  • 接收的是字段当前存储的值(比如一个 datetime 对象),不是原始输入
  • 可以返回任意可序列化的类型(如 str 替代 datetime),但要确保与 return_type 注解一致,否则 IDE 和类型检查可能报错
  • 如果同时定义了 @field_validator@field_serializer,它们互不干扰:一个管“进”,一个管“出”

别把 field_validator 当成 before_validator 用

常见误操作是想在 field_validator 里把 str 转成 int,结果报 Input should be a valid integer。这是因为 Pydantic v2 的解析流程是:原始输入 → 类型转换(由字段类型驱动)→ field_validator。类型转换失败发生在 validator 之前,根本进不到你的函数里。

抖云猫AI论文助手
抖云猫AI论文助手

一款AI论文写作工具,最快 2 分钟,生成 3.5 万字论文。论文可插入表格、代码、公式、图表,依托自研学术抖云猫大模型,生成论文具备严谨的学术专业性。

下载
  • 真需要预处理原始输入(比如把 "123" 字符串转成 int),得用 BeforeValidator,配合 Annotated
  • 例如:age: Annotated[int, BeforeValidator(lambda x: int(x) if isinstance(x, str) else x)]
  • field_validator 适合在类型已确定的前提下做业务逻辑校验,比如 if value

serializer 返回 None 会导致字段被忽略(除非显式设 exclude_none=False)

这是容易被忽略的坑。当 @field_serializer 返回 None,Pydantic 默认在 model_dump() 中跳过该字段(类似 exclude_unset=True 的行为),而不是保留 null

  • 若需输出 null,必须返回 None 并设置 when_used='always' + 显式传 exclude_none=False
  • 更稳妥的做法是避免返回 None,改用空字符串、默认值或专门的标记对象
  • 调试时可用 print() 在 serializer 里确认是否被调用——它只在序列化时触发,赋值时完全不执行
字段验证和序列化的边界在 v2 里划得很清:一个守入口,一个管出口。混用或期待它做类型转换,基本都会卡在解析阶段报错。

相关专题

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

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

772

2023.06.15

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

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

661

2023.07.20

python能做什么
python能做什么

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

765

2023.07.25

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

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

679

2023.07.31

python教程
python教程

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

1385

2023.08.03

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

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

570

2023.08.04

python eval
python eval

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

579

2023.08.04

scratch和python区别
scratch和python区别

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

730

2023.08.11

c++空格相关教程合集
c++空格相关教程合集

本专题整合了c++空格相关教程,阅读专题下面的文章了解更多详细内容。

0

2026.01.23

热门下载

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

精品课程

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

共4课时 | 15.2万人学习

Django 教程
Django 教程

共28课时 | 3.4万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.2万人学习

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

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