August Rush

一个还在努力成长的小火汁!

游龙当归海,海不迎我自来也。

We create our own demons.

You can reach me at augustrush0923@gmail.com
DRF通用视图源码分析
发布:2021年09月04日 | 作者:augustrush | 阅读量: 334

APIView

APIView是REST framework提供的所有视图的基类,继承自Django的View

APIViewView的不同之处在于:

  • 传入到视图方法中的是REST framework的Request对象(在APIView中的dispatchinitialize_requestDjango原生request进行封装),而不是DjangoHttpResquest对象;
  • 视图方法可以返回REST framework的Response对象,视图会为响应数据设置符合前端要求的格式;
  • 任何APIException异常都会被捕获到,并且处理成合适的响应信息;
  • 在进行dispatch()分发之前(在APIView中的dispatchinitial方法),会对请求进行身份认证、权限检查、流量控制。


支持定义的属性

  • authentication_classes: 列表或元组,在dispatch的initial的perform_authentication中进行身份认证
  • permissoin_classes:列表或元组,在dispatch的initial的check_permissions中进行权限认证
  • throttle_classes:列表或元组,在dispatch的initial的check_throttles中进行流量控制


APIView调用流程


实例

APIView中仍以常规的类视图定义方法来实现get()、post()或者其他请求方式的方法。

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


# path('books/', BooksGenericAPIView.as_view()),
class BooksAPIView(APIView):
    def get(self, request):
        queryset = Booksinfo.objects.all()
        serializer = BooksInfoSerializer(instance=queryset, many=True)
        return Response(serializer.data)

    def post(self, request):
        data = request.data
        queryset = Booksinfo.objects.all()
        serializer = BooksInfoSerializer(data=data)
        serializer.is_valid(raise_exception=True)
        serializer.save()
        return Response(serializer.validated_data)


GenericAPIView

GenericAPIView类继承与REST framework的APIView类,为标准列表和详细视图添加了常见的行为。

内置的每一个具体的通用视图都是通过将GenericAPIView类和一个或多个minxin类相互结合来构建的。


属性


基本属性
  • queryset:用于从此视图返回对象的查询集。通常,必须设置此属性,或覆盖get_queryset()方法。如果重写了一个视图方法,在视图方法中,应该调用get_queryset()而不是直接访问这个属性
  • Serializer_class:用于验证和反序列化输入以及序列化输出的序列化类。通常,必须设置此属性,或覆盖get_serializer_class()方法。
  • lookup_field:用于执行各个模型实例的对象查找的模型字段。默认为pk
  • lookup_url_kwarg:用于对象查找的URL关键字参数。URL conf应该包含与此值相对应的关键字参数。如果未设置,则默认使用与lookup_field相同的值。
def get_object(self):
        # 先获取数据集
    queryset = self.filter_queryset(self.get_queryset())
        # 拿到查询参数的 key
    lookup_url_kwarg = self.lookup_url_kwarg or self.lookup_field
        # 组装成 {key:value} 的形式
    filter_kwargs = {self.lookup_field: self.kwargs[lookup_url_kwarg]}
    # 查询
    obj = get_object_or_404(queryset, **filter_kwargs)
        # 最后返回
    return obj


分页

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

  • pagination_class:对列表进行分页时使用的分页类。默认值与DEFAULT_PAGINATION_CLASS设置相同,即rest_framework.pagination.PageNumberPagination。设置pagination_class = None将禁用此视图的分页。


过滤

  • filter_backends:用于过滤查询集的过滤器类的列表。默认值与DEFAULT_FILTER_BACKENDS设置的值相同。


方法


基本方法


get_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.lookup_url_kwarg:
        filter[field] = self.kwargs[field]

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


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


保存和删除钩子(hook)

以下方法由mixin类提供,可以很轻松的重写对象的保存和删除行为。

  • perform_create(self, serializer):保存新对象实例时由CreateModelMixin调用。
  • perform_update(self, serializer):在保存现有对象实例时由UpdateModelMixin调用。
  • perform_destroy(self, instance):删除对象实例时由DestroyModelMixin调用。

源码示例:

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

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

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

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_savepost_savepre_deletepost_delete 方法,这些方法不再可用。


其他方法

通常不需要重写以下方法,但如果使用GenericAPIView编写自定义视图,则可能需要调用它们。

  • get_serializer_context(self):返回包含应该提供给序列化的任何额外上下文的字典。默认包括request,viewformat键。
  • 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):给定一个查询集,使用过滤器进行过滤,返回一个新的查询集。

GenericAPIView视图例子:

class BooksGenericAPIView(GenericAPIView):
    queryset = Booksinfo.objects.all()
    serializer_class = BooksInfoSerializer

    def get(self, request):
        books = self.get_queryset()
        serializer = self.get_serializer(instance=books, many=True)
        return Response(serializer.data)

    def post(self, request):
        data = request.data
        serializer = self.get_serializer(data=data)
        serializer.is_valid(raise_exception=True)
        serializer.save()
        return Response(serializer.validated_data)


Mixins

mixin类用于提供基本视图行为的操作。mixin类提供了操作方法,而不是直接定义处理方法。


ListModelMixin

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

如果查询集已填充,则返回200 OK响应,并将queryset的序列化表示形式作为响应的主体。响应数据可以设置分页。

例子:

class BooksMixinView(ListModelMixin, GenericAPIView):
    queryset = Booksinfo.objects.all()
    serializer_class = BooksInfoSerializer

    def get(self, request):
        return self.list(request)


CreateModelMixin

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

如果创建了一个对象,则会返回一个201 Created响应,并将该对象的序列化表示形式作为响应的主体。如果表示包含名为url的键,则响应的Locationheader将填充该值。

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

示例:

class BooksMixinView(CreateModelMixin, GenericAPIView):
    queryset = Booksinfo.objects.all()
    serializer_class = BooksInfoSerializer

    def post(self, request):
        return self.create(request)


RetrieveModelMixin

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

如果可以获取对象,则返回 200 OK 响应,并将对象的序列化表示作为响应的主体。否则,将返回一个 404 Not Found

示例:

class BooksDetailMixinView(RetrieveModelMixin, GenericAPIView):
    queryset = Booksinfo.objects.all()
    serializer_class = BooksInfoSerializer

    def get(self, request, pk):
        return self.retrieve(request)


UpdateModelMixin

提供 .update(request, *args, **kwargs) 方法,实现更新和保存现有模型实例。还提供了一个 .partial_update(request, *args, **kwargs) 方法,它与更新方法类似,只是更新的所有字段都是可选的。这允许支持 HTTP PATCH 请求。

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

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

示例:

class BooksDetailMixinView(UpdateModelMixin, GenericAPIView):
    queryset = Booksinfo.objects.all()
    serializer_class = BooksInfoSerializer

    def put(self, request, pk):
        return self.update(request, partial=True)


DestroyModelMixin

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

如果一个对象被删除,则返回一个 204 No Content ,否则它将返回一个 404 Not Found

示例:

class BooksDetailMixinView(DestroyModelMixin, GenericAPIView):
    queryset = Booksinfo.objects.all()
    serializer_class = BooksInfoSerializer

    def delete(self, request, pk):
        return self.destroy(request)


内置视图类列表

以下类是具体的通用视图。通常情况下,都可以直接使用它们,除非需要高度的自定义行为。


CreateAPIVIew

仅用于创建实例。

提供一个post请求的处理方法。

继承自:CreateModelMixin, GenericAPIView


ListAPIView

仅用于创建实例。

提供一个post请求的处理方法。

继承自: CreateModelMixin, GenericAPIView


RetrieveAPIView

仅用于查询单个模型实例。

提供一个 get 请求的处理方法。

继承自: GenericAPIView, RetrieveModelMixin


DestroyAPIView

仅用于删除单个模型实例。

提供一个 delete 请求的处理方法。

继承自: GenericAPIView, DestroyModelMixin


UpdateAPIView

仅用于更新单个模型实例。

提供 putpatch 请求的处理方法。

继承自: GenericAPIView, UpdateModelMixin


ListCreateAPIView

既可以获取也可以实例集合,也可以创建实例列表

提供 getpost 请求的处理方法。

继承自: GenericAPIView, ListModelMixinCreateModelMixin


RetrieveUpdateAPIView

既可以查询也可以更新单个实例

提供 getputpatch 请求的处理方法。

继承自: GenericAPIView, RetrieveModelMixinUpdateModelMixin


RetrieveDestroyAPIView

既可以查询也可以删除单个实例

提供 getdelete 请求的处理方法。

继承自: GenericAPIView, RetrieveModelMixinDestroyModelMixin


RetrieveUpdateDestroyAPIView

同时支持查询,更新,删除

提供 getputpatchdelete 请求的处理方法。

继承自: GenericAPIView, RetrieveModelMixinUpdateModelMixinDestroyModelMixin

上一篇:探索JWT 下一篇:DRF视图集


  • 标签云

  • 支付宝扫码支持一下

  • 微信扫码支持一下



基于Nginx+Supervisord+uWSGI+Django1.11.1+Python3.6.5构建

版权所有 © 2020-2021 August Rush

京ICP备20007446号-1 & 豫公网安备 41100202000460号

网站地图 & RSS | Feed