API Guide(四)之Generic views

时间:2022-06-26 02:13:15

标签:

通用的视图

Django’s generic views... were developed as a shortcut for common usage patterns... 它们采取一些常见的习语和模式,在视图开发中创建并抽象,以便可以快速编写数据的常见视图,而无需重复。

CBV的主要优点之一是 the way they allow you to compose bits of reusable behavior. REST framework takes advantage of this by providing a number of pre-built views that provide for commonly used patterns.

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

如果通用视图不符合您的API需求,你可下拉到使用常规APIView 类,或者重用通用视图所使用的mixins和base类来构建一组您自己的可重用通用视图。

例子

通常当使用通用视图时,您将覆盖视图,并设置几个类属性。

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与一个或多个mixin类进行组合来构建的。

属性

基本设置

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

queryset - 用于从此视图返回对象的查询器。通常,您必须设置此属性,或覆盖get_queryset()方法。如果您覆盖了一个视图方法,那么重要的是调用get_queryset()而不是直接访问此属性,as queryset will get evaluated once, and those results will be cached for all subsequent requests.

serializer_class - 用于对输入进行验证和反序列化以及对输出进行序列化。通常,您必须设置此属性,或覆盖get_serializer_class()方法。

lookup_field - 用于执行个别模型实例的对象查找的模型字段。默认为‘pk‘。请注意,当使用超链接的API时,如果你需要使用一个自定义值,那么需要确保the API views and the serializer classes 都设置了查找字段。

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 属性指定的queryset。

应始终使用此方法,而不是直接访问self.queryset,因为self.queryset每执行一次,就会为所有后续请求缓存这些结果。

可能会被覆盖以提供动态行为,such as returning a queryset, that is specific to the user making the request.

例如:

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

get_object(self)

返回应用于详细视图的对象实例。默认使用lookup_field参数过滤 the base queryset。

可能会被覆盖以提供更复杂的行为,例如基于多个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)

给定一个 queryset,使用任何 filter backends 进行过滤,返回一个新的 queryset。

例如: