Django REST Framework 教程：基于类的视图详解

邱行方Mountain

于 2025-06-01 09:02:18 发布

阅读量281

点赞数 3

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_01165/article/details/148360330

Django REST Framework 教程：基于类的视图详解

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

前言

在构建Web API时，视图(View)是处理HTTP请求并返回响应的核心组件。Django REST Framework提供了多种编写视图的方式，其中基于类的视图(Class-based Views)因其强大的复用性和结构化特性而广受欢迎。本文将深入探讨如何在Django REST Framework中使用基于类的视图来构建优雅的API。

从函数视图到类视图

基础APIView类

让我们从一个简单的APIView开始，这是Django REST Framework中最基础的类视图：

from rest_framework.views import APIView
from rest_framework.response import Response

class SnippetList(APIView):
    """
    列出所有代码片段或创建新片段
    """
    def get(self, request, format=None):
        snippets = Snippet.objects.all()
        serializer = SnippetSerializer(snippets, many=True)
        return Response(serializer.data)

    def post(self, request, format=None):
        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)

这种方式的优势在于：

将不同HTTP方法(get, post等)分离到不同的类方法中，结构更清晰
便于复用公共功能
符合面向对象编程原则

详情视图实现

对于处理单个对象的视图，我们可以这样实现：

class SnippetDetail(APIView):
    """
    检索、更新或删除一个代码片段实例
    """
    def get_object(self, pk):
        try:
            return Snippet.objects.get(pk=pk)
        except Snippet.DoesNotExist:
            raise Http404

    def get(self, request, pk, format=None):
        snippet = self.get_object(pk)
        serializer = SnippetSerializer(snippet)
        return Response(serializer.data)

    def put(self, request, pk, format=None):
        snippet = self.get_object(pk)
        serializer = SnippetSerializer(snippet, data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data)
        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

    def delete(self, request, pk, format=None):
        snippet = self.get_object(pk)
        snippet.delete()
        return Response(status=status.HTTP_204_NO_CONTENT)

使用Mixin提升代码复用

Django REST Framework提供了一系列Mixin类，它们封装了常见的CRUD操作模式，可以大幅减少重复代码。

List和Create操作的Mixin

from rest_framework import mixins
from rest_framework import generics

class SnippetList(mixins.ListModelMixin,
                 mixins.CreateModelMixin,
                 generics.GenericAPIView):
    queryset = Snippet.objects.all()
    serializer_class = SnippetSerializer

    def get(self, request, *args, **kwargs):
        return self.list(request, *args, **kwargs)

    def post(self, request, *args, **kwargs):
        return self.create(request, *args, **kwargs)

这里的关键点：

GenericAPIView提供基础功能
ListModelMixin添加.list()方法处理GET请求
CreateModelMixin添加.create()方法处理POST请求

Retrieve、Update和Delete操作的Mixin

class SnippetDetail(mixins.RetrieveModelMixin,
                   mixins.UpdateModelMixin,
                   mixins.DestroyModelMixin,
                   generics.GenericAPIView):
    queryset = Snippet.objects.all()
    serializer_class = SnippetSerializer

    def get(self, request, *args, **kwargs):
        return self.retrieve(request, *args, **kwargs)

    def put(self, request, *args, **kwargs):
        return self.update(request, *args, **kwargs)

    def delete(self, request, *args, **kwargs):
        return self.destroy(request, *args, **kwargs)

使用通用视图进一步简化

Django REST Framework还提供了一组预先混合好的通用视图类，可以进一步简化代码：

from rest_framework import generics

class SnippetList(generics.ListCreateAPIView):
    queryset = Snippet.objects.all()
    serializer_class = SnippetSerializer

class SnippetDetail(generics.RetrieveUpdateDestroyAPIView):
    queryset = Snippet.objects.all()
    serializer_class = SnippetSerializer

这些通用视图的特点：

ListCreateAPIView = ListModelMixin + CreateModelMixin + GenericAPIView
RetrieveUpdateDestroyAPIView = RetrieveModelMixin + UpdateModelMixin + DestroyModelMixin + GenericAPIView
自动处理各种HTTP方法
只需指定queryset和serializer_class即可

URL配置

使用类视图时，URL配置需要稍作调整：

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

urlpatterns = [
    path('snippets/', views.SnippetList.as_view()),
    path('snippets/<int:pk>/', views.SnippetDetail.as_view()),
]

urlpatterns = format_suffix_patterns(urlpatterns)

注意.as_view()方法的调用，这是将类视图转换为Django可识别的视图函数的必要步骤。