泛型视图-Django REST框架

mixins.py generics.py

泛型视图

姜戈的一般观点..。作为常见使用模式的捷径..。它们使用视图开发中发现的某些常见成语和模式，并对它们进行抽象，这样您就可以快速地编写数据的公共视图，而不必重复自己的操作。

— Django文档

基于类的视图的主要优点之一是它们允许您组合一些可重用行为。REST框架利用这一点，提供了许多预先构建的视图，这些视图提供了常用的模式。

REST框架提供的通用视图允许您快速构建与数据库模型紧密映射的API视图。

如果泛型视图不适合您的API的需要，则可以使用常规的APIView类，或者重用泛型视图所使用的混合器和基类来组成您自己的可重用泛型视图集。

实例

通常，在使用泛型视图时，您将覆盖视图，并设置几个类属性。

from django.contrib.auth.models import User
from myapp.serializers import UserSerializer
from rest_framework import generics
from rest_framework.permissions import IsAdminUser

class UserList(generics.ListCreateAPIView):
    queryset = User.objects.all()
    serializer_class = UserSerializer
    permission_classes = [IsAdminUser]

对于更复杂的情况，您还可能希望覆盖视图类上的各种方法。例如。

class UserList(generics.ListCreateAPIView):
    queryset = User.objects.all()
    serializer_class = UserSerializer
    permission_classes = [IsAdminUser]

    def list(self, request):
        # Note the use of `get_queryset()` instead of `self.queryset`
        queryset = self.get_queryset()
        serializer = UserSerializer(queryset, many=True)
        return Response(serializer.data)

对于非常简单的情况，您可能希望使用.as_view()方法。例如，您的URLconf可能包括如下内容：

url(r'^/users/', ListCreateAPIView.as_view(queryset=User.objects.all(), serializer_class=UserSerializer), name='user-list')

---

API参考

GenericAPIView

这个类扩展了REST框架的APIView类，为标准列表和详细视图添加通常需要的行为。

提供的每个具体泛型视图都是通过以下方式构建的GenericAPIView，具有一个或多个混合类。

属性

基本设置:

以下属性控制基本视图行为。

• queryset-用于从此视图返回对象的查询集。通常，必须设置此属性，或重写get_queryset()方法。如果要重写视图方法，则调用get_queryset()而不是直接访问此属性，如queryset将得到一次评估，这些结果将为所有后续请求缓存。
• serializer_class-序列化程序类，用于验证和反序列化输入，以及序列化输出。通常，必须设置此属性，或重写get_serializer_class()方法。
• lookup_field-模型字段，用于对单个模型实例执行对象查找。默认为'pk'...注意，在使用超链接API时，需要确保双管齐下API视图和如果需要使用自定义值，序列化程序类将设置查找字段。
• lookup_url_kwarg-用于对象查找的URL关键字参数。URL conf应该包含一个与此值相对应的关键字参数。如果取消设置，默认为使用与lookup_field.

分页:

当与列表视图一起使用时，以下属性用于控制分页。

• pagination_class-在分页列表结果时应使用的分页类。默认为与DEFAULT_PAGINATION_CLASS设置，即'rest_framework.pagination.PageNumberPagination'...设置pagination_class=None将禁用此视图上的分页。

过滤:

• filter_backends-用于筛选查询集的筛选器后端类的列表。默认为与DEFAULT_FILTER_BACKENDS背景。

方法

基方法:

get_queryset(self)

返回用于列表视图的查询集，该查询集应用作详细视图查找的基础。默认情况下返回由queryset属性。

应该始终使用此方法，而不是访问self.queryset直接，如self.queryset只计算一次，并为所有后续请求缓存这些结果。

可能会被重写以提供动态行为，例如返回特定于发出请求的用户的查询集。

例如：

def get_queryset(self):
    user = self.request.user
    return user.accounts.all()

get_object(self)

返回应用于详细视图的对象实例。默认情况下使用lookup_field参数来筛选基查询集。

可能会被重写以提供更复杂的行为，例如基于多个URL kwarg的对象查找。

例如：

def get_object(self):
    queryset = self.get_queryset()
    filter = {}
    for field in self.multiple_lookup_fields:
        filter[field] = self.kwargs[field]

    obj = get_object_or_404(queryset, **filter)
    self.check_object_permissions(self.request, obj)
    return obj

注意，如果您的API不包括任何对象级别的权限，则可以选择排除self.check_object_permissions，然后简单地从get_object_or_404查一下。

filter_queryset(self, queryset)

给定一个查询集，使用正在使用的过滤器后端对其进行筛选，返回一个新的查询集。

例如：

def filter_queryset(self, queryset):
    filter_backends = [CategoryFilter]

    if 'geo_route' in self.request.query_params:
        filter_backends = [GeoRouteFilter, CategoryFilter]
    elif 'geo_point' in self.request.query_params:
        filter_backends = [GeoPointFilter, CategoryFilter]

    for backend in list(filter_backends):
        queryset = backend().filter_queryset(self.request, queryset, view=self)

    return queryset

get_serializer_class(self)

返回应该用于序列化程序的类。默认情况下返回serializer_class属性。

可以重写以提供动态行为，例如使用不同的序列化程序进行读和写操作，或向不同类型的用户提供不同的序列化程序。

例如：

def get_serializer_class(self):
    if self.request.user.is_staff:
        return FullAccountSerializer
    return BasicAccountSerializer

保存和删除钩子:

Mixin类提供了以下方法，并提供了对象保存或删除行为的简单重写。

• perform_create(self, serializer)-由CreateModelMixin保存新对象实例时。
• perform_update(self, serializer)-由UpdateModelMixin保存现有对象实例时。
• perform_destroy(self, instance)-由消心痛模型删除对象实例时。

这些钩子对于设置请求中隐含的属性特别有用，但并不是请求数据的一部分。例如，您可以根据请求用户或基于URL关键字参数在对象上设置属性。

def perform_create(self, serializer):
    serializer.save(user=self.request.user)

这些覆盖点对于添加保存对象之前或之后发生的行为也特别有用，例如发送电子邮件确认或记录更新。

def perform_update(self, serializer):
    instance = serializer.save()
    send_email_confirmation(user=self.request.user, modified=instance)

还可以通过引发ValidationError()...如果需要在数据库保存时应用一些验证逻辑，这可能很有用。例如：

def perform_create(self, serializer):
    queryset = SignupRequest.objects.filter(user=self.request.user)
    if queryset.exists():
        raise ValidationError('You have already signed up')
    serializer.save(user=self.request.user)

注*这些方法取代了旧的2.x版本。pre_save, post_save, pre_delete和post_delete方法，这些方法不再可用。

其他方法:

您通常不需要覆盖以下方法，但如果要使用以下方法编写自定义视图，则可能需要调用它们GenericAPIView.

• get_serializer_context(self)-返回包含应提供给序列化程序的任何额外上下文的字典。默认包含'request', 'view'和'format'钥匙。
• get_serializer(self, instance=None, data=None, many=False, partial=False)-返回序列化器实例。
• get_paginated_response(self, data)-返回分页样式Response对象。
• paginate_queryset(self, queryset)-在需要的情况下对查询集进行分组，或者返回一个页面对象，或者None如果未为此视图配置分页。
• filter_queryset(self, queryset)-给定一个查询集，使用正在使用的过滤器后端对其进行筛选，返回一个新的查询集。

---

米辛

Mixin类提供用于提供基本视图行为的操作。请注意，Mixin类提供操作方法，而不是定义处理程序方法，如.get()和.post()，直接。这允许更灵活的行为组合。

可以从rest_framework.mixins.

李斯特米辛

提供一个.list(request, *args, **kwargs)方法，实现列出一个查询集。

如果填充了queryset，则返回200 OK响应，将查询集的序列化表示形式作为响应的主体。响应数据可以选择性地分页。

CreateModelMixin

提供一个.create(request, *args, **kwargs)方法，它实现了创建和保存一个新的模型实例。

如果创建了一个对象，则返回201 Created响应，将对象的序列化表示形式作为响应的主体。如果表示包含名为url，然后Location响应的头将填充该值。

如果为创建对象提供的请求数据无效，则400 Bad Request将返回响应，并将错误详细信息作为响应的主体。

检索模型

提供一个.retrieve(request, *args, **kwargs)方法，实现在响应中返回现有模型实例。

如果可以检索对象，则返回200 OK响应，将对象的序列化表示形式作为响应的主体。否则它将返回404 Not Found.

UpdateModelMixin

提供一个.update(request, *args, **kwargs)方法，实现更新和保存现有模型实例。

还提供了一个.partial_update(request, *args, **kwargs)方法，类似于update方法，但更新的所有字段都是可选的。这允许对HTTP的支持PATCH请求。

如果更新对象，则返回200 OK响应，将对象的序列化表示形式作为响应的主体。

如果为更新对象提供的请求数据无效，则400 Bad Request将返回响应，并将错误详细信息作为响应的主体。

消心痛模型

提供一个.destroy(request, *args, **kwargs)方法，该方法实现删除现有模型实例。

如果删除对象，则返回204 No Content响应，否则它将返回404 Not Found.

---

具体视图类

以下类是具体的泛型视图。如果您使用的是泛型视图，这通常是您要处理的级别，除非您需要大量定制的行为。

视图类可以从rest_framework.generics.

CreateAPIView

用于只创建端点。

提供一个post方法处理程序。

扩展：GenericAPIView, CreateModelMixin

ListAPIView

用于只读端点表示模型实例的集合.

提供一个get方法处理程序。

扩展：GenericAPIView, 李斯特米辛

检索APIView

用于只读端点表示单模型实例.

提供一个get方法处理程序。

扩展：GenericAPIView, 检索模型

销毁APIView

用于只删除的端点单模型实例.

提供一个delete方法处理程序。

扩展：GenericAPIView, 消心痛模型

UpdateAPIView

用于只更新的端点单模型实例.

提供put和patch方法处理程序。

扩展：GenericAPIView, UpdateModelMixin

ListCreateAPIView

用于读写端点表示模型实例的集合.

提供get和post方法处理程序。

扩展：GenericAPIView, 李斯特米辛, CreateModelMixin

检索程序APIView

用于读取或更新端点表示单模型实例.

提供get, put和patch方法处理程序。

扩展：GenericAPIView, 检索模型, UpdateModelMixin

检索-D雌激素-APIView

用于读或删除端点表示单模型实例.

提供get和delete方法处理程序。

扩展：GenericAPIView, 检索模型, 消心痛模型

检索更新-D雌激素-APIView

用于读-写-删除端点表示单模型实例.

提供get, put, patch和delete方法处理程序。

扩展：GenericAPIView, 检索模型, UpdateModelMixin, 消心痛模型

---

自定义泛型视图

通常，您希望使用现有的泛型视图，但使用一些稍微定制的行为。如果您发现自己在多个地方重用了一些定制的行为，您可能希望将行为重构为一个公共类，然后您可以根据需要应用于任何视图或视图集。

创建自定义混合器

例如，如果您需要基于URL conf中的多个字段查找对象，您可以创建一个混合类，如下所示：

class MultipleFieldLookupMixin(object):
    """
    Apply this mixin to any view or viewset to get multiple field filtering
    based on a `lookup_fields` attribute, instead of the default single field filtering.
    """
    def get_object(self):
        queryset = self.get_queryset()             # Get the base queryset
        queryset = self.filter_queryset(queryset)  # Apply any filter backends
        filter = {}
        for field in self.lookup_fields:
            if self.kwargs[field]: # Ignore empty fields.
                filter[field] = self.kwargs[field]
        obj = get_object_or_404(queryset, **filter)  # Lookup the object
        self.check_object_permissions(self.request, obj)
        return obj

然后，只要您需要应用自定义行为，就可以简单地将此混合应用于视图或视图集。

class RetrieveUserView(MultipleFieldLookupMixin, generics.RetrieveAPIView):
    queryset = User.objects.all()
    serializer_class = UserSerializer
    lookup_fields = ['account', 'username']

如果您有需要使用的自定义行为，则使用自定义混合器是一个很好的选择。

创建自定义基类

如果您在多个视图中使用混合视图，则可以更进一步，创建您自己的基本视图集，然后可以在整个项目中使用这些视图。例如：

class BaseRetrieveView(MultipleFieldLookupMixin,
                       generics.RetrieveAPIView):
    pass

class BaseRetrieveUpdateDestroyView(MultipleFieldLookupMixin,
                                    generics.RetrieveUpdateDestroyAPIView):
    pass

如果您的自定义行为需要在整个项目的大量视图中重复使用，那么使用自定义基类是一个很好的选择。

---

作为创造

在3.0版本之前，REST框架混合处理PUT作为更新或创建操作，取决于对象是否已经存在。

允许PUT因为创建操作是有问题的，因为它必须公开有关对象存在或不存在的信息。同样不明显的是，透明地允许重新创建先前删除的实例肯定比简单地返回更好的默认行为。404答复。

两种风格“PUT为404“和”PUT因为CREATE“在不同的情况下是有效的，但是从3.0版开始，我们使用404作为默认行为，因为它更简单、更明显。

如果您需要通用的PUT作为创建行为，则可能需要包括以下内容这，这个AllowPUTAsCreateMixin班级，等级作为你观点的混合体。

---

第三方包

以下第三方包提供了其他通用视图实现。

Django REST框架散装

这个Django-REST-框架-批量包实现泛型视图混合以及一些常见的具体泛型视图，以允许通过API请求应用批量操作。

Django REST多模型

Django REST多模型提供用于通过单个API请求发送多个序列化模型和/或查询集的通用视图(和混合视图)。