Django REST Framework 教程：深入理解请求与响应处理-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01050/article/details/148360329

Django REST Framework 教程：深入理解请求与响应处理

django-rest-framework 项目地址: https://gitcode.com/gh_mirrors/dja/django-rest-framework

作为 Django REST Framework 的核心组件，请求(Request)和响应(Response)对象构成了 Web API 开发的基础。本文将深入探讨这些关键组件的工作原理和最佳实践。

请求对象：超越传统 HttpRequest

Django REST Framework 扩展了 Django 原生的 HttpRequest，提供了更加强大灵活的 Request 对象。这个增强主要体现在以下几个方面：

多格式数据处理：通过 request.data 属性，可以统一处理各种 HTTP 方法(POST、PUT、PATCH)和各种数据格式(JSON、表单数据等)
内容协商：自动根据客户端请求的 Accept 头来决定返回数据的格式
认证支持：内置了对多种认证方案的支持

与 Django 原生的 request.POST 相比，request.data 提供了更全面的功能：

# Django 原生方式 - 仅处理表单数据，仅限 POST 方法
request.POST  

# REST Framework 方式 - 处理任意数据，支持多种方法
request.data

响应对象：智能的内容协商

REST Framework 的 Response 类是一个智能的响应生成器：

return Response(data)  # 自动根据客户端需求渲染合适的内容类型

它的核心优势在于：

自动内容协商（JSON、HTML等）
与 Django 模板系统无缝集成
支持多种渲染器

HTTP 状态码的最佳实践

在 API 开发中，直接使用数字状态码不仅可读性差，还容易出错。REST Framework 提供了语义化的状态码常量：

from rest_framework import status

# 不推荐
return Response(serializer.errors, status=400)

# 推荐
return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

使用这些常量不仅提高代码可读性，还能减少因记错状态码而导致的错误。

API 视图装饰器与类

REST Framework 提供了两种方式来创建 API 视图：

函数视图装饰器 @api_view

@api_view(['GET', 'POST'])
def snippet_list(request):
    # 视图逻辑

类视图基类 APIView

class SnippetList(APIView):
    def get(self, request):
        # GET 方法处理
    def post(self, request):
        # POST 方法处理

这些封装提供了以下功能：

自动请求解析
内容协商
适当的错误响应(如 405 Method Not Allowed)
处理格式错误的输入数据

实战示例：重构代码片段 API

让我们看一个完整的示例，展示如何使用这些概念重构视图：

from rest_framework import status
from rest_framework.decorators import api_view
from rest_framework.response import Response
from snippets.models import Snippet
from snippets.serializers import SnippetSerializer

@api_view(['GET', 'POST'])
def snippet_list(request):
    """
    列出所有代码片段，或创建新片段
    """
    if request.method == 'GET':
        snippets = Snippet.objects.all()
        serializer = SnippetSerializer(snippets, many=True)
        return Response(serializer.data)

    elif request.method == 'POST':
        serializer = SnippetSerializer(data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data, status=status.HTTP_201_CREATED)
        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

这个重构后的版本具有以下改进：

代码更简洁
错误处理更明确
支持多种内容类型
自动生成可浏览的 API 界面

格式后缀：增强 API 灵活性

通过添加格式后缀，我们可以让 API 支持多种数据格式：

首先修改视图函数，添加 format 参数：
```
def snippet_list(request, format=None):
```

然后更新 URL 配置：

from django.urls import path
from rest_framework.urlpatterns import format_suffix_patterns
from snippets import views

urlpatterns = [
    path('snippets/', views.snippet_list),
    path('snippets/<int:pk>/', views.snippet_detail),
]

urlpatterns = format_suffix_patterns(urlpatterns)

这样，API 就可以通过以下方式访问：