Django Ninja 中处理 PATCH 请求与可选字段的最佳实践
2025-05-28 03:24:23作者:段琳惟
在 Django Ninja 框架中处理 PATCH 请求时,开发者经常会遇到一个常见问题:如何区分客户端想要将字段设置为 None 和客户端根本没有发送该字段的情况。这个问题在 RESTful API 设计中尤为重要,因为 PATCH 请求的本意是部分更新资源,而不是完全替换。
问题背景
当使用 Django Ninja 的 ModelSchema 并设置 fields_optional="__all__"
时,请求负载会包含所有可能的键,即使客户端没有发送某些字段,这些未发送的字段也会被设置为 None。这使得服务器无法区分以下两种情况:
- 客户端明确想要将字段值设置为 None
- 客户端没有发送该字段,意味着不应修改该字段
解决方案探索
使用 exclude_unset 参数
Django Ninja 提供了 .dict(exclude_unset=True)
方法,可以过滤掉未设置的字段。这是目前最常用的解决方案:
@api.patch("/{id}", response=RespSchema)
def patch_view(request, employee_id, body: ReqSchema):
employee = get_object_or_404(Employee, id=employee_id)
filtered_dict = body.dict(exclude_unset=True)
for attr, value in filtered_dict.items():
setattr(employee, attr, value)
这种方法有效地区分了未设置的字段和显式设置为 None 的字段。
可选字段与默认值的区别
在定义 Schema 时,开发者需要注意两种不同的字段定义方式:
- 可选字段:使用
Optional[str]
表示该字段可以完全从请求中省略 - 可空字段:使用
str = None
表示该字段必须提供,但可以设置为 None
正确的用法应该是:
class TheSchema(Schema):
optional_field: Optional[str] # 可以省略
nullable_field: Optional[str] = None # 必须提供但可为None
未来可能的改进
Django Ninja 可能会引入 PatchDict
类型标记,使 PATCH 操作更加优雅:
@api.patch("/patch")
def patch(request, payload: PatchDict[SomeSchema]):
print(payload) # 只包含客户端实际发送的字段
这种设计将使 PATCH 操作更加直观,自动处理字段过滤逻辑。
实际应用建议
对于当前版本的 Django Ninja,建议采用以下模式处理 PATCH 请求:
- 为 PATCH 操作创建专门的 Schema,所有字段都设为 Optional
- 在视图函数中使用
.dict(exclude_unset=True)
获取实际修改的字段 - 使用循环将这些字段应用到模型实例
class EmployeePatchSchema(Schema):
name: Optional[str]
age: Optional[int]
department: Optional[str]
@api.patch("/employees/{id}")
def update_employee(request, id: int, payload: EmployeePatchSchema):
employee = get_object_or_404(Employee, id=id)
update_data = payload.dict(exclude_unset=True)
for field, value in update_data.items():
setattr(employee, field, value)
employee.save()
return employee
这种方法既保持了代码的简洁性,又正确处理了部分更新的需求。
总结
Django Ninja 提供了灵活的工具来处理 PATCH 请求和可选字段。通过合理使用 Schema 定义和 .dict(exclude_unset=True)
方法,开发者可以轻松实现符合 REST 原则的部分更新操作。未来随着框架的发展,可能会提供更加简洁的语法糖来进一步简化这一常见模式。
登录后查看全文
热门项目推荐
- QQwen3-Next-80B-A3B-InstructQwen3-Next-80B-A3B-Instruct 是一款支持超长上下文(最高 256K tokens)、具备高效推理与卓越性能的指令微调大模型00
- QQwen3-Next-80B-A3B-ThinkingQwen3-Next-80B-A3B-Thinking 在复杂推理和强化学习任务中超越 30B–32B 同类模型,并在多项基准测试中优于 Gemini-2.5-Flash-Thinking00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~0265cinatra
c++20实现的跨平台、header only、跨平台的高性能http库。C++00AI内容魔方
AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。02- HHunyuan-MT-7B腾讯混元翻译模型主要支持33种语言间的互译,包括中国五种少数民族语言。00
GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile06
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
热门内容推荐
最新内容推荐
项目优选
收起

OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K

deepin linux kernel
C
22
6

Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0

React Native鸿蒙化仓库
C++
192
273

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392

openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189

为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64

本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K

Elasticsearch
国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8