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

在 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 编码等替代方案。