登录
首页 >  文章 >  python教程

DjangoRESTFramework更新用户资料全攻略

时间:2026-04-13 22:36:53 134浏览 收藏

本文深入剖析了在 Django REST Framework 中实现安全、可靠的用户资料更新功能的完整方案,直击 Token 认证场景下常见的核心陷阱——如误用 `create()` 方法、错误访问 `request.auth`、校验后未调用 `save()` 导致数据不持久化等,并通过重构序列化器的 `update()` 方法、精准绑定 `request.user`、合理配置权限与认证,以及推荐使用 `UpdateAPIView` 等实践,手把手带你构建语义清晰、职责分明、生产就绪的资料更新接口,助你避开坑、写出更健壮、更符合 DRF 设计哲学的 API 代码。

Django REST Framework 中实现用户资料更新的完整实践指南

本文详解如何在 DRF 中正确实现基于 Token 认证的用户资料(如 first_name)更新功能,涵盖序列化器逻辑修正、视图层数据绑定、权限与认证配置,并指出原始代码中 create() 方法误用、request.auth 访问时机错误等关键问题。

本文详解如何在 DRF 中正确实现基于 Token 认证的用户资料(如 first_name)更新功能,涵盖序列化器逻辑修正、视图层数据绑定、权限与认证配置,并指出原始代码中 create() 方法误用、request.auth 访问时机错误等关键问题。

在 Django REST Framework(DRF)中实现用户资料更新,绝非仅靠定义序列化器和视图即可完成——尤其当涉及认证上下文(如 TokenAuthentication)时,数据流向、对象绑定与状态一致性必须精准把控。原始代码存在多个典型误区:ProfileSerializer.create() 被错误用于更新场景(create 仅适用于新建对象),且在 create() 内尝试访问 validated_data.auth(该字段根本不存在于 validated_data 中);同时,视图中虽调用 serializer.is_valid(),却未调用 serializer.save() 或手动更新模型实例,导致数据“校验通过但未持久化”。

✅ 正确实现路径:分离职责,明确语义

首先,应区分「创建」与「更新」行为。用户资料修改属于 partial update,推荐使用 update() 方法而非 create()。同时,request.auth 是认证成功后由 DRF 注入的 Token 实例,只能在视图方法内、认证通过后访问,不可在序列化器方法中假设其存在。

以下是优化后的完整实现:

1. 修正 serializers.py

from rest_framework import serializers
from django.contrib.auth.models import User  # 注意:此处应与 CustomUser 一致;若使用自定义用户模型,请替换为对应类

class ProfileSerializer(serializers.ModelSerializer):
    class Meta:
        model = User  # 或 CustomUser,需确保与实际模型一致
        fields = ('first_name',)  # 可扩展为 email、last_name 等
        read_only_fields = ('id',)  # 防止客户端篡改主键

    def update(self, instance, validated_data):
        # instance 是当前登录用户对象(由视图传入)
        instance.first_name = validated_data.get('first_name', instance.first_name)
        instance.save()
        return instance

⚠️ 注意:update() 方法接收 instance(待更新的对象)和 validated_data(已校验的数据),这是 DRF 更新逻辑的标准契约。

2. 重构 views.py —— 显式获取并更新用户

from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import status, permissions
from rest_framework.authentication import TokenAuthentication
from django.contrib.auth.models import User
from .serializers import ProfileSerializer

class ProfileAPIView(APIView):
    serializer_class = ProfileSerializer
    permission_classes = [permissions.IsAuthenticated]  # ✅ 强烈建议改为 IsAuthenticated
    authentication_classes = [TokenAuthentication]

    def post(self, request):
        # request.user 即认证后的用户对象,安全可靠
        user = request.user
        serializer = ProfileSerializer(user, data=request.data, partial=True)
        if serializer.is_valid(raise_exception=True):
            serializer.save()  # 触发 ProfileSerializer.update()
            return Response({"msg": "Profile updated successfully"}, status=status.HTTP_200_OK)
        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

✅ 关键改进:

  • 使用 permissions.IsAuthenticated 替代 AllowAny,防止未认证用户滥用接口;
  • 直接传入 request.user 作为 instance,避免重复查库(如 Token.objects.get(...));
  • 采用 partial=True 支持单字段更新(如仅提交 {"first_name": "Alice"});
  • 调用 serializer.save(),真正触发 update() 逻辑。

3. (可选)更简洁方案:使用 UpdateAPIView

若无需自定义逻辑,DRF 内置的通用视图可大幅简化代码:

from rest_framework.generics import UpdateAPIView

class ProfileAPIView(UpdateAPIView):
    serializer_class = ProfileSerializer
    permission_classes = [permissions.IsAuthenticated]
    authentication_classes = [TokenAuthentication]

    def get_object(self):
        return self.request.user

? 重要注意事项

  • 模型一致性:确保 ProfileSerializer.Meta.model 与项目实际用户模型(CustomUser 或 User)严格匹配,否则会引发 AttributeError 或静默失败。
  • Token 认证前提:前端请求头必须携带 Authorization: Token ,否则 request.auth 为 None,request.user 将是匿名用户。
  • 字段验证:如需对 first_name 做长度或格式限制,可在 ProfileSerializer 中添加 validators 或重写字段定义。
  • 安全性增强:生产环境应配合 CSRF 保护(TokenAuthentication 通常用于 API 场景,可忽略 CSRF)、速率限制及敏感字段白名单控制。

通过以上重构,你将获得一个健壮、符合 DRF 设计哲学、易于维护的用户资料更新接口——它不再依赖脆弱的 Token.objects.get() 查询,不混淆 create/update 语义,且充分利用框架提供的认证上下文与序列化生命周期。

今天关于《DjangoRESTFramework更新用户资料全攻略》的内容介绍就到此结束,如果有什么疑问或者建议,可以在golang学习网公众号下多多回复交流;文中若有不正之处,也希望回复留言以告知!

资料下载
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>