加入收藏 | 设为首页 | 会员中心 | 我要投稿 好传媒网 (https://www.haochuanmei.com/)- 区块链、物联平台、物联安全、数据迁移、5G!
当前位置: 首页 > 运营中心 > 网站设计 > 教程 > 正文

视图的两个基类

发布时间:2023-12-25 06:31:53 所属栏目:教程 来源:DaWei
导读: 大家是否好奇,客户端在访问 RESTful Web API 时,所访问的路径是在哪里定义的呢?为什么访问不同的路径,就可以获取不同的资源呢?这一节,就带大家揭开这样的疑惑。

在设计接口时,90%
大家是否好奇,客户端在访问 RESTful Web API 时,所访问的路径是在哪里定义的呢?为什么访问不同的路径,就可以获取不同的资源呢?这一节,就带大家揭开这样的疑惑。

在设计接口时,90% 以上都是完成增删改查操作,Django Rest framework 为我们做了大量的工作简化视图的编写,在了解视图之前,我们先看看 Django Rest framework 中各类视图都有什么关系。

1. 视图的两个基类
1.1 APIView
rest_framework.views.APIView
APIView是REST framework提供的所有视图的基类,继承自Django的View父类。

支持定义的属性:
authentication_classes :列表或元祖,身份认证类;
permissoin_classes :列表或元祖,权限检查类;
throttle_classes: 列表或元祖,流量控制类。
在APIView中仍以常规的类视图定义方法来实现 get() 、post() 或者其他请求方式的方法。

举例:
from rest_framework.views import APIView
from rest_framework.response import Response
class StudentsListView(APIView):
    '''
    学生信息视图
    '''
    def get(self, request):
        students = StudentsModel.objects.all()  # 指定要处理的学生信息数据集
        serializer = StudentsSerializer(students, many=True) # 指定要使用的序列化器,many=True表明允许同时序列化多条数据
        return Response(serializer.data) # 返回经过处理的数据       
1.2 GenericAPIView
rest_framework.generics.GenericAPIView
继承自APIVIew,主要增加了操作序列化器和数据库查询的方法,作用是为下面Mixin扩展类的执行提供方法支持。通常在使用时,可搭配一个或多个Mixin扩展类。

1.2.1 提供的关于序列化器使用的属性与方法
属性:serializer_class 指明视图使用的序列化器。

get_serializer_class(self)
返回序列化器类,默认返回serializer_class,可以重写,例如:

def get_serializer_class(self):
    if self.request.user.is_staff:
        return FullAccountSerializer
    return BasicAccountSerializer
get_serializer(self, *args, **kwargs)
返回序列化器对象,主要用来提供给 Mixin 扩展类使用,如果我们在视图中想要获取序列化器对象,也可以直接调用此方法。

注意,该方法在提供序列化器对象的时候,会向序列化器对象的context属性补充三个数据:request、format、view,这三个数据对象可以在定义序列化器时使用。

request 当前视图的请求对象

view 当前请求的类视图对象

format 当前请求期望返回的数据格式

1.2.2 提供的关于数据库查询的属性与方法
属性:queryset 指明使用的数据查询集
get_queryset(self)

返回视图使用的查询集,主要用来提供给Mixin扩展类使用,是列表视图与详情视图获取数据的基础,默认返回queryset属性,可以重写,例如:

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

返回详情视图所需的模型类数据对象,主要用来提供给Mixin扩展类使用。在试图中可以调用该方法获取详情信息的模型类对象。若详情访问的模型类对象不存在,会返回404。该方法会默认使用APIView提供的 check_object_permissions 方法检查当前对象是否有权限被访问。举例:

class StudentDetailView(GenericAPIView):
  queryset = StudentsModel.objects.all()
  serializer_class = BookInfoSerializer
  def get(self, request, pk):
      student = self.get_object() 
      serializer = self.get_serializer(student)
      return Response(serializer.data)
1.2.3 其他可以设置的属性
pagination_class 指明分页控制类;
filter_backends 指明过滤控制后端。

2. 五个扩展类
提供了几种后端视图(对数据资源进行增删改查)处理流程的实现,如果需要编写的视图属于这五种,则视图可以通过继承相应的扩展类来复用代码,减少自己编写的代码量。

这五个扩展类需要搭配 GenericAPIView 父类,因为五个扩展类的实现需要调用 GenericAPIView 提供的序列化器与数据库查询的方法。

2.1 ListModelMixin
列表视图扩展类,提供list(request, *args, **kwargs)方法快速实现列表视图,返回 200 状态码。

该 Mixin 的 list 方法会对数据进行过滤和分页。

源代码:

class ListModelMixin(object):
    """
    List a queryset.
    """
    def list(self, request, *args, **kwargs):
        # 过滤
        queryset = self.filter_queryset(self.get_queryset())
        # 分页
        page = self.paginate_queryset(queryset)
        if page is not None:
            serializer = self.get_serializer(page, many=True)
            return self.get_paginated_response(serializer.data)
        # 序列化
        serializer = self.get_serializer(queryset, many=True)
        return Response(serializer.data)
举例:

from rest_framework.mixins import ListModelMixin
class StudentsListView(ListModelMixin, GenericAPIView):
    queryset = StudentsModel.objects.all()
    serializer_class = StudentsSerializer
    def get(self, request):
        return self.list(request)
2.2 CreateModelMixin
创建视图扩展类,提供create(request, *args, **kwargs)方法快速实现创建资源的视图,成功返回 201 状态码。

如果序列化器对前端发送的数据验证失败,返回 400 错误。

源代码如下:

class CreateModelMixin(object):
    """
    Create a model instance.
    """
    def create(self, request, *args, **kwargs):
        # 获取序列化器
        serializer = self.get_serializer(data=request.data)
        # 验证
        serializer.is_valid(raise_exception=True)
        # 保存
        self.perform_create(serializer)
        headers = self.get_success_headers(serializer.data)
        return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers)
    def perform_create(self, serializer):
        serializer.save()
    def get_success_headers(self, data):
        try:
            return {'Location': str(data[api_settings.URL_FIELD_NAME])}
        except (TypeError, KeyError):
            return {}
2.3 RetrieveModelMixin
详情视图扩展类,提供retrieve(request, *args, **kwargs)方法,可以快速实现返回一个存在的数据对象。

如果存在,返回200, 否则返回404。

源代码:

class RetrieveModelMixin(object):
    """
    Retrieve a model instance.
    """
    def retrieve(self, request, *args, **kwargs):
        # 获取对象,会检查对象的权限
        instance = self.get_object()
        # 序列化
        serializer = self.get_serializer(instance)
        return Response(serializer.data)
举例:

class StudentDetailView(RetrieveModelMixin, GenericAPIView):
    queryset = StudentsModel.objects.all()
    serializer_class = StudentsSerializer
    def get(self, request, pk):
        return self.retrieve(request)
2.4 UpdateModelMixin
更新视图扩展类,提供update(request, *args, **kwargs)方法,可以快速实现更新一个存在的数据对象。

同时也提供partial_update(request, *args, **kwargs)方法,可以实现局部更新。

成功返回200,序列化器校验数据失败时,返回400错误。

源代码:

class UpdateModelMixin(object):
    """
    Update a model instance.
    """
    def update(self, request, *args, **kwargs):
        partial = kwargs.pop('partial', False)
        instance = self.get_object()
        serializer = self.get_serializer(instance, data=request.data, partial=partial)
        serializer.is_valid(raise_exception=True)
        self.perform_update(serializer)
        if getattr(instance, '_prefetched_objects_cache', None):
            # 如果 'prefetch_related' 应用在一个数据集合,那么每次查询该集合, 都须使缓存数据强制失效,用新查询的数据代替
            instance._prefetched_objects_cache = {}
        return Response(serializer.data)
    def perform_update(self, serializer):
        serializer.save()
    def partial_update(self, request, *args, **kwargs):
        kwargs['partial'] = True
        return self.update(request, *args, **kwargs)
2.5 DestroyModelMixin
删除视图扩展类,提供destroy(request, *args, **kwargs)方法,可以快速实现删除一个存在的数据对象。

成功返回 204,不存在返回 404。

源代码如下:

class DestroyModelMixin(object):
    """
    删除数据
    """
    def destroy(self, request, *args, **kwargs):
        instance = self.get_object()
        self.perform_destroy(instance)
        return Response(status=status.HTTP_204_NO_CONTENT)
    def perform_destroy(self, instance):
        instance.delete()
3. 几个可用子类视图
3.1 CreateAPIView
提供 post 方法。

继承自: GenericAPIView、CreateModelMixin。

3.2 ListAPIView
提供 get 方法。

继承自:GenericAPIView、ListModelMixin。

3.3 RetrieveAPIView
提供 get 方法。

继承自: GenericAPIView、RetrieveModelMixin。

3.4 DestoryAPIView
提供 delete 方法。

继承自:GenericAPIView、DestoryModelMixin。

3.5 UpdateAPIView
提供 put 和 patch 方法。

继承自:GenericAPIView、UpdateModelMixin。

3.6 RetrieveUpdateAPIView
提供 get、put、patch方法。

继承自: GenericAPIView、RetrieveModelMixin、UpdateModelMixin。

3.7 RetrieveUpdateDestoryAPIView
提供 get、put、patch、delete方法。

继承自:GenericAPIView、RetrieveModelMixin、UpdateModelMixin、DestoryModelMixin。

4.视图集ViewSet
使用视图集ViewSet,可以将一系列逻辑相关的动作放到一个类中:

list() 提供一组数据;
retrieve() 提供单个数据;
create() 创建数据;
update() 保存数据;
destory() 删除数据。
ViewSet 视图集类不再实现 get()、post() 等方法,而是实现动作 action 如 list() 、create() 等。

视图集只在使用 as_view() 方法的时候,才会将 action 动作与具体请求方式对应上。如:

class StudentsViewSet(viewsets.ViewSet):
    def list(self, request):
          '''
          列出符合条件的多条(所有)记录
          '''
        students = StudentsModel.objects.all() # 查询所有数据集
        serializer = StudentsSerializer(students, many=True)
        return Response(serializer.data)
    def retrieve(self, request, pk=None):
          '''
          列出符合条件的单条记录
          '''
        # 此处使用try...except,如果数据不存在,就可捕获异常,返回404(查询的资源不存在)
        try:
            students = StudentsModel.objects.get(id=pk) # 查询id=pk参数的数据,因为id不可重复,因而查到的数据必定是单条数据
        except StudentsModel.DoesNotExist:
            return Response(status=status.HTTP_404_NOT_FOUND)
        serializer = StudentsSerializer(students)
        return Response(serializer.data)
在设置路由时,我们可以如下操作:

urlpatterns = [
    paht('books/', StudentsViewSet.as_view({'get':'list'}),
    path('books/<pk:int>/', StudentsViewSet.as_view({'get': 'retrieve'})
]
5. 常用视图集父类
5.1 ViewSet
继承自APIView与ViewSetMixin,作用也与APIView基本类似,提供了身份认证、权限校验、流量管理等。ViewSet 主要通过继承 ViewSetMixin 来实现在调用as_view()时传入字典(如{'get':'list'})的映射处理工作。在 ViewSet 中,没有提供任何动作 action 方法,需要我们自己实现 action 方法。

5.2 GenericViewSet
使用 ViewSet 通常并不方便,因为 list、retrieve、create、update、destory 等方法都需要自己编写,而这些方法与前面讲过的 Mixin 扩展类提供的方法同名,所以我们可以通过继承 Mixin 扩展类来复用这些方法而无需自己编写。但是 Mixin 扩展类依赖于GenericAPIView,所以还需要继承GenericAPIView。

GenericViewSet 就帮助我们完成了这样的继承工作,继承自GenericAPIView与ViewSetMixin,在实现了调用 as_view() 时传入字典(如{'get':'list'})的映射处理工作的同时,还提供了GenericAPIView 提供的基础方法,可以直接搭配 Mixin 扩展类使用。

举例:

from rest_framework import mixins
from rest_framework.viewsets import GenericViewSet
from rest_framework.decorators import action
class StudentsViewSet(mixins.ListModelMixin, mixins.RetrieveModelMixin, GenericViewSet):
    queryset = StudentsModel.objects.all()
    serializer_class = StudentsSerializer
路由定义:

urlpatterns = [
    paht('books/', StudentsViewSet.as_view({'get':'list'}),
    path('books/<pk:int>/', StudentsViewSet.as_view({'get': 'retrieve'})
]
5.3 ModelViewSet
继承自GenericViewSet,同时包括了 ListModelMixin、RetrieveModelMixin、CreateModelMixin、UpdateModelMixin、DestoryModelMixin。

5.4 ReadOnlyModelViewSet
继承自GenericViewSet,同时包括了ListModelMixin、RetrieveModelMixin。
 

(编辑:好传媒网)

【声明】本站内容均来自网络,其相关言论仅代表作者个人观点,不代表本站立场。若无意侵犯到您的权利,请及时与联系站长删除相关内容!

    推荐文章