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开放平台

下载
  • 真需要预处理原始输入(比如把 "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 里划得很清:一个守入口,一个管出口。混用或期待它做类型转换,基本都会卡在解析阶段报错。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
json数据格式
json数据格式

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

457

2023.08.07

json是什么
json是什么

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

549

2023.08.23

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

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

337

2023.10.13

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

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

82

2025.09.10

python中print函数的用法
python中print函数的用法

python中print函数的语法是“print(value1, value2, ..., sep=' ', end=' ', file=sys.stdout, flush=False)”。本专题为大家提供print相关的文章、下载、课程内容,供大家免费下载体验。

193

2023.09.27

python print用法与作用
python print用法与作用

本专题整合了python print的用法、作用、函数功能相关内容,阅读专题下面的文章了解更多详细教程。

19

2026.02.03

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

254

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

1089

2024.03.01

Python异步编程与Asyncio高并发应用实践
Python异步编程与Asyncio高并发应用实践

本专题围绕 Python 异步编程模型展开,深入讲解 Asyncio 框架的核心原理与应用实践。内容包括事件循环机制、协程任务调度、异步 IO 处理以及并发任务管理策略。通过构建高并发网络请求与异步数据处理案例,帮助开发者掌握 Python 在高并发场景中的高效开发方法,并提升系统资源利用率与整体运行性能。

37

2026.03.12

热门下载

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

精品课程

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

共4课时 | 22.5万人学习

Django 教程
Django 教程

共28课时 | 5万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.9万人学习

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

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