Django REST Framework：使用 PATCH 请求部分更新模型-js教程-PHP中文网

Django REST Framework：使用 PATCH 请求部分更新模型

霞舞

发布： 2025-08-23 21:34:02

原创

827人浏览过

django rest framework：使用 patch 请求部分更新模型

本文旨在解决在使用 Django REST Framework (DRF) 时，如何通过 PATCH 请求仅更新模型的特定字段，避免因序列化器验证导致的必填字段缺失错误。我们将深入探讨 update 方法的正确使用姿势，并提供修改后的代码示例，确保仅更新所需字段。

在使用 Django REST Framework (DRF) 进行 API 开发时，经常需要实现对模型的部分更新。通常情况下，我们会使用 PATCH 请求来实现这一功能。然而，当模型的序列化器中存在必填字段时，即使我们只想更新部分字段，DRF 仍然会要求提供所有必填字段的值，这会导致不必要的麻烦。本文将详细介绍如何正确处理这种情况，确保通过 PATCH 请求仅更新指定的字段。

理解 DRF 的 update 方法和 partial_update 方法

DRF 的 ModelViewSet 提供了默认的 update 和 partial_update 方法用于更新模型实例。当接收到 PUT 请求时，DRF 会调用 update 方法，该方法期望接收完整的模型数据。而当接收到 PATCH 请求时，DRF 会调用 partial_update 方法，该方法允许只更新部分字段。

关键在于 partial_update 方法会将 partial=True 传递给 update 方法，然后在 update 方法中，这个 partial 参数会被传递给序列化器。序列化器在验证数据时，会根据 partial 参数的值来决定是否需要验证所有字段。

解决 username 必填错误

根据提供的代码，问题出现在 CustomUserViewSet 的 update 方法中。尽管使用了 PATCH 请求，但 update 方法并没有正确地处理 partial 参数，导致序列化器仍然要求提供 username 字段。

要解决这个问题，需要修改 update 方法，使其能够正确地接收和使用 partial 参数。以下是修改后的代码：

无阶未来模型擂台/AI 应用平台

无阶未来模型擂台/AI 应用平台，一站式模型+应用平台

查看详情

class CustomUserViewSet(viewsets.ModelViewSet):
    serializer_class = s.CustomUserSerializer   
    queryset = m.CustomUser.objects.all()

    def update(self, request, *args, **kwargs):
        partial = kwargs.pop('partial', False)
        print("custom user update")
        print(request.data)  # <QueryDict: {'detail': ['{"fileObj":19}']}>
        instance = self.get_object()
        serializer = self.get_serializer(instance, data=request.data, partial=partial)
        if serializer.is_valid():
            self.perform_update(serializer)
            return Response(serializer.data)
        else:
            print(serializer.errors)  # check error.
            return Response(serializer.errors, status=400) # 建议返回错误状态码

登录后复制

在这个修改后的 update 方法中，我们首先使用 kwargs.pop('partial', False) 获取 partial 参数的值，并将其传递给 serializer。这样，当接收到 PATCH 请求时，序列化器就会知道这是一个部分更新，从而不会强制要求提供所有必填字段的值。

前端代码注意事项

确保前端代码发送的是 PATCH 请求，并且 Content-Type 设置为 multipart/form-data 或者 application/json。

如果使用 multipart/form-data，需要注意数据类型的转换。例如，JSON 数据需要使用 JSON.stringify() 进行序列化，然后再添加到 FormData 中。

 var formData = new FormData();
 var status = {
     fileObj:this.fileObj.id
 }
 console.log("syncdata to user table",status);
 console.log("syncdata for user:",request);
 formData.append("detail",JSON.stringify(status));
 axios.patch(
     `/api/customusers/3/`,formData,{
     headers: {
         'Content-Type': 'multipart/form-data'
     }
     }
 ).then(function (response) {
     console.log("syncdata customuser is saved:",response); 
 })
 .catch(function (response) {
     console.log("syncdata customuser failed:",response);
 });

登录后复制

或者使用 application/json：

import axios from 'axios';

const status = {
    fileObj: this.fileObj.id
};

axios.patch(
    `/api/customusers/3/`,
    { detail: status }, // 直接发送 JSON 对象
    {
        headers: {
            'Content-Type': 'application/json'
        }
    }
)
.then(response => {
    console.log("syncdata customuser is saved:", response);
})
.catch(error => {
    console.error("syncdata customuser failed:", error);
});

登录后复制

总结

通过正确地处理 partial 参数，我们可以轻松地实现对模型的特定字段的更新，而无需提供所有必填字段的值。这不仅简化了 API 的使用，也提高了开发效率。在实际开发中，需要根据具体的需求选择合适的数据格式和请求方式，并确保前端和后端代码能够正确地配合工作。同时，建议在 update 方法中添加错误处理，返回适当的错误状态码，以便前端能够更好地处理错误情况。

以上就是Django REST Framework：使用 PATCH 请求部分更新模型的详细内容，更多请关注php中文网其它相关文章！