0

0

Pydantic 模型序列化时如何正确使用 alias 将字段名映射为 _id

聖光之護

聖光之護

发布时间:2026-01-04 13:22:04

|

224人浏览过

|

来源于php中文网

原创

Pydantic 模型序列化时如何正确使用 alias 将字段名映射为 _id

pydantic 默认不会自动使用 `alias` 进行序列化,需显式传入 `by_alias=true` 参数才能将字段别名(如 `_id`)应用于 `model_dump()` 输出,从而适配 mongodb 等外部系统对字段命名的特殊要求。

在 Pydantic v2 中,Field(alias=...) 仅定义了输入解析时的别名映射(即支持从 {"_id": "...", "name": "..."} 初始化),但默认不参与输出序列化。若希望 model_dump() 或 model_dump_json() 输出中字段以别名形式呈现(例如将 id 输出为 _id),必须显式启用 by_alias=True。

以下为正确用法示例:

from pydantic import BaseModel, Field
from uuid import uuid4

class MyDocument(BaseModel):
    id: str = Field(default_factory=lambda: str(uuid4()), alias="_id")
    name: str

body = {"name": "skanda"}
doc = MyDocument(**body)

# ❌ 错误:默认不使用 alias,输出为 {"id": "...", "name": "skanda"}
print(doc.model_dump())
# 输出:{'id': 'a1b2c3...', 'name': 'skanda'}

# ✅ 正确:显式指定 by_alias=True,输出为 {"_id": "...", "name": "skanda"}
print(doc.model_dump(by_alias=True))
# 输出:{'_id': 'a1b2c3...', 'name': 'skanda'}

⚠️ 注意事项:

Transor
Transor

专业的AI翻译工具,支持网页、字幕、PDF、图片实时翻译

下载
  • alias 主要用于兼容不同数据源的键名约定(如 MongoDB 的 _id、REST API 的 user_id),但其作用是双向的——需配合 by_alias=True 才能影响序列化;
  • 若同时需要 JSON 序列化,可使用 model_dump_json(by_alias=True);
  • serialization_alias(Pydantic v2.4+)可用于仅影响序列化而不影响解析的场景,但本例中 alias 已足够;
  • MongoDB 驱动(如 pymongo)通常接受字典直接插入,因此 model_dump(by_alias=True) 的输出可直接用于 collection.insert_one(...)。

总结:别名不是“自动生效”的魔法,而是需主动启用的显式行为。牢记 by_alias=True 是解锁 alias 序列化能力的关键开关。

相关专题

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

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

404

2023.08.07

json是什么
json是什么

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

531

2023.08.23

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

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

308

2023.10.13

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

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

74

2025.09.10

mongodb和mysql的区别
mongodb和mysql的区别

mongodb和mysql的区别:1、数据模型;2、查询语言;3、扩展性和性能;4、可靠性。本专题为大家提供mongodb和mysql的区别的相关的文章、下载、课程内容,供大家免费下载体验。

280

2023.07.18

mongodb启动命令
mongodb启动命令

MongoDB 是一种开源的、基于文档的 NoSQL 数据库管理系统。本专题提供mongodb启动命令的文章,希望可以帮到大家。

246

2023.08.08

MongoDB删除数据的方法
MongoDB删除数据的方法

MongoDB删除数据的方法有删除集合中的文档、删除整个集合、删除数据库和删除指定字段等。本专题为大家提供MongoDB相关的文章、下载、课程内容,供大家免费下载体验。

159

2023.09.19

常用的数据库软件
常用的数据库软件

常用的数据库软件有MySQL、Oracle、SQL Server、PostgreSQL、MongoDB、Redis、Cassandra、Hadoop、Spark和Amazon DynamoDB。更多关于数据库软件的内容详情请看本专题下面的文章。php中文网欢迎大家前来学习。

957

2023.11.02

Python /与// 教程大全
Python /与// 教程大全

本专题整合了python的/和//的相关内容大全,阅读下面的文章了解更多详细内容。

0

2026.01.06

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.1万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.1万人学习

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

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