首页
/ Django Ninja 中处理 PATCH 请求与表单数据上传的解决方案

Django Ninja 中处理 PATCH 请求与表单数据上传的解决方案

2025-05-28 14:51:56作者:魏侃纯Zoe

在 Django Ninja 框架中,开发者经常需要实现用户信息更新的 API 接口。一个常见的需求是使用 PATCH 方法来部分更新用户信息,同时支持表单数据和文件上传。本文将深入探讨这一技术问题的解决方案。

问题背景

在 RESTful API 设计中,PATCH 方法通常用于部分更新资源。然而,Django Ninja 在处理 PATCH 请求时,默认情况下无法正确解析表单数据和文件上传。这会导致以下问题:

  1. 表单数据字段全部为空
  2. 文件上传字段无法获取
  3. 数值类型字段验证失败

核心解决方案

中间件处理方案

针对 PATCH 请求的表单数据处理问题,最有效的解决方案是使用自定义中间件。该中间件会在请求处理前临时将 PATCH 方法转换为 POST 方法,使 Django 能够正确解析表单数据,然后再恢复原始请求方法。

from collections.abc import Callable
from typing import Any
from asgiref.sync import iscoroutinefunction, sync_to_async
from django.http import HttpRequest
from django.utils.decorators import sync_and_async_middleware

@sync_and_async_middleware
def process_put_patch(get_response: Callable) -> Callable:
    async def async_middleware(request: HttpRequest) -> Any:
        if (request.method in ("PUT", "PATCH") 
            and request.content_type != "application/json":
            initial_method = request.method
            request.method = "POST"
            request.META["REQUEST_METHOD"] = "POST"
            await sync_to_async(request._load_post_and_files)()
            request.META["REQUEST_METHOD"] = initial_method
            request.method = initial_method
        return await get_response(request)

    def sync_middleware(request: HttpRequest) -> Any:
        if (request.method in ("PUT", "PATCH") 
            and request.content_type != "application/json":
            initial_method = request.method
            request.method = "POST"
            request.META["REQUEST_METHOD"] = "POST"
            request._load_post_and_files()
            request.META["REQUEST_METHOD"] = initial_method
            request.method = initial_method
        return get_response(request)

    return async_middleware if iscoroutinefunction(get_response) else sync_middleware

文件上传替代方案

当中间件处理后文件上传仍然有问题时,可以考虑以下替代方案:

  1. 使用 Base64 编码传输文件
  2. 将文件上传拆分为单独的 API 端点
  3. 使用专门的第三方库处理文件上传

数据验证最佳实践

对于部分更新的 API,数据验证需要特别注意:

  1. 所有字段都应设置为可选
  2. 空字符串、None 和 0 应被视为有效输入
  3. 数值字段需要前端确保传递正确的数据类型
class UserMedicalInSchema(Schema):
    gender: Optional[str] = None
    height: Optional[int] = Field(None, ge=0)
    weight: Optional[int] = Field(None, ge=0)
    marital: Optional[str] = None
    children: Optional[int] = Field(None, ge=0)
    # 其他字段...

实际应用示例

以下是一个完整的用户信息更新 API 实现示例:

from ninja import Schema, Form, File
from ninja.files import UploadedFile
from typing import Optional, List

class UserUpdateSchema(Schema):
    username: Optional[str] = None
    email: Optional[str] = None
    age: Optional[int] = None

@router.patch('/me', auth=JWTAuth())
def update_user_info(
    request,
    payload: Form[UserUpdateSchema] = None,
    avatar: Optional[File[UploadedFile]] = None
):
    user = request.user
    
    # 处理文件上传
    if avatar:
        user.avatar = avatar
    
    # 处理表单数据
    if payload:
        update_data = {
            k: v for k, v in payload.dict().items() 
            if v is not None
        }
        for field, value in update_data.items():
            setattr(user, field, value)
    
    user.save()
    return {"status": "success"}

总结

在 Django Ninja 中实现支持表单数据和文件上传的 PATCH 接口需要特别注意请求方法的处理和数据验证。通过使用自定义中间件和合理的数据模型设计,可以构建出既符合 RESTful 规范又用户友好的 API 接口。对于复杂的更新场景,建议将文件上传和其他数据更新分离,或者使用 Base64 编码等替代方案。

登录后查看全文
热门项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8