drf (学习第三部)

目录

视图

视图额基类

视图类扩展

GenericAPIView的视图子类

视图集ViewSet

路由Routers

视图

Django REST framework 提供的视图的主要作用:

• 控制序列化器的执行( 检验 , 保存 , 转换数据 ) 
• 控制数据库查询的执行( 数据库的删除 . 查询的代码写在视图中, 更新和添加写在序列化器 ) 

REST framework 提供了众多的通用视图基类和扩展类, 以简化视图的编写

.

视图的基类

　　APIView

rest_framework.views.APIView

APIView 是RESTframework 提供的所有视图的基类,继承自Django的View 父类.

drf的APIView 与Django View 的不同之处在于:

• 传入视图方法中的是REST framework 的Request 对象, 而不是Django的HttpRequeset 对象
• 视图方法可以返回RESTframework 的Responset对象, 视图会为响应数据设置 (render )符合前端要求的格式:
• 任何APIE相册旁听异常都会被捕捉到,并且处理成合适的响应信息
• 重写了as_view() , 在进行dispatch() 路由分发前, 会对http请求进行身份认证, 权限检查, 访问流量控制.

 

支持定义的类属性

• authentication_classes 列表或元祖, 身份认证类
• permissoin_classes列表或元祖, 权限检查类
• throttle_classes 列表或元祖, 流量控制类

 

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

栗子:

# Create your views here.
"""APIView是drf里面提供的所有视图类的父类
   APIView提供的功能/属性/方法是最少的,所以使用APIView基本类似我们使用django的View
"""
"""
GET   /students/ 获取多个学生信息 
POST  /students/ 添加一个学生信息

GET    /students/<pk>/  获取一个学生信息 
PUT    /students/<pk>/  修改一个学生信息
DELETE /students/<pk>/  删除一个学生信息
"""
from rest_framework.views import APIView
from students.models import Student
from .serializers import StudentModelSerializer
from rest_framework.response import Response
from rest_framework import status

class StudentAPIView(APIView):
    def get(self,request):
        # 1. 获取学生信息的数据模型
        student_list = Student.objects.all()
        # 2. 调用序列化器
        serializer = StudentModelSerializer(instance=student_list, many=True)
        # 3. 返回数据
        return Response(serializer.data)

    def post(self,request):
        # 1. 调用序列化器对用户提交的数据进行验证
        serializer = StudentModelSerializer(data=request.data)
        serializer.is_valid(raise_exception=True)

        # 2. 调用序列化器进行数据库操作
        instance = serializer.save() # save()方法返回的是添加成功以后的模型对象

        serializer = StudentModelSerializer(instance=instance)

        # 3. 返回新增数据
        return Response(serializer.data, status=status.HTTP_201_CREATED)


class Student2APIView(APIView):
    def get(self,request,pk):
        # 1. 根据pk获取模型对象
        student = Student.objects.get(pk=pk)
        # 2. 序列化器转换数据
        serializer = StudentModelSerializer(instance=student)
        # 3. 响应数据
        return Response(serializer.data)

    def put(self,request,pk):
        # 1. 通过pk查询学生信息
        student = Student.objects.get(pk=pk)

        # 3. 调用序列化器对客户端发送过来的数据进行验证
        serializer = StudentModelSerializer(instance=student, data=request.data)
        serializer.is_valid(raise_exception=True)
        # 4. 保存数据
        instance = serializer.save()

        serializer = StudentModelSerializer(instance=instance)

        # 5. 返回结果
        return Response(serializer.data, status=status.HTTP_201_CREATED)

    def delete(self, request, pk):
        # 1. 通过pk查询学生信息
        Student.objects.get(pk=pk).delete()
        return Response({"message":"ok"}, status=status.HTTP_204_NO_CONTENT)

　　GenericAPIView

同用视图类主要作用就是把视图中的独特的代码抽取出来, 让视图方法中的代码更加通用, 方便把通用代码进行简写.

rest_framework.generics.GenericAPIView

继承自 APIView,  主要添加了操作序列化器和数据库查询的方法, 作用是为了下面Mixin扩展的执行提供方法支持. 通常在使用时,可以搭配一个或多个Mixin扩展类 .

提供的关于序列化器使用的属性与方法

属性:

　　serizlizer_class 指明视图使用的序列化器

方法:

　　get_serializer_class(self)　　

　　当出现一个视图类调用多个序列化器时,那么可以通过条件判断在get_serializer_class方法中通过返回不同的序列化器类名

　　就可以让视图方法执行不同发的序列化器对象了.

　　

　　返回序列化器类, 默认返回

　　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 点前请求期望返回的数据格式

提供的关于数据库查询的属性与方法

属性:

　　queryset 指明使用的数据查询集

方法:

　　get_queryset(self)

　　返回视图使用的查询集,主要要用来提供给Mixin扩展类使用, 是列表视图与详情视图获取数据的基础,

　　morning返回 queryset属性, 可以重写,例如:

　　

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

　　get_object(self)

　　返回详细视图所需的模型数据对象,主要用来提供给Mixin扩展类使用.

　　在视图中可以调用该方法获取详情信息的模型类对象.

　　

　　若详情访问的模型类对象不存在,会返回 404 

　　该方法会默认使用APIView提供的check_object_permissions 方法检查当前对象是否有权限访问

　　栗子:

　　

# url(r'^books/(?P<pk>d+)/$', views.BookDetailView.as_view()),
class BookDetailView(GenericAPIView):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer

    def get(self, request, pk):
        book = self.get_object() # get_object()方法根据pk参数查找queryset中的数据对象
        serializer = self.get_serializer(book)
        return Response(serializer.data)

其他可以设置的属性

　　pagination_class 指明分页控制类

　　filter_backends 指明过滤控制后端

为了方便学习上面的GenericAPIView 通过视图类,我们新建一个子应用.

python manage.py startapp gen

代码:

from rest_framework.generics import GenericAPIView

from students.models import Student
from .serializers import StudentModelSerializer, StudentModel2Serializer
from rest_framework.response import Response

class StudentsGenericAPIView(GenericAPIView):
    # 本次视图类中要操作的数据[必填]
    queryset = Student.objects.all()
    # 本次视图类中要调用的默认序列化器[玄天]
    serializer_class = StudentModelSerializer

    def get(self, request):
        """获取所有学生信息"""
        serializer = self.get_serializer(instance=self.get_queryset(), 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)

        instance = serializer.save()

        serializer = self.get_serializer(instance=instance)

        return Response(serializer.data)


class StudentGenericAPIView(GenericAPIView):
    queryset = Student.objects.all()

    serializer_class = StudentModelSerializer

    def get_serializer_class(self):
        """重写获取序列化器类的方法"""
        if self.request.method == "GET":
            return StudentModel2Serializer
        else:
            return StudentModelSerializer

    # 在使用GenericAPIView视图获取或操作单个数据时,视图方法中的代表主键的参数最好是pk
    def get(self,request,pk):
        """获取一条数据"""
        serializer = self.get_serializer(instance=self.get_object())

        return Response(serializer.data)

    def put(self,request,pk):

        data = request.data

        serializer = self.get_serializer(instance=self.get_object(),data=data)

        serializer.is_valid(raise_exception=True)

        serializer.save()

        serializer = self.get_serializer(instance=self.get_object())

        return Response(serializer.data)

序列化器类

from rest_framework import serializers

from students.models import Student

class StudentModelSerializer(serializers.ModelSerializer):
    class Meta:
        model= Student
        fields = "__all__"


class StudentModel2Serializer(serializers.ModelSerializer):
    class Meta:
        model= Student
        fields = ("name","class_null")

5视图扩展类

作用:

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

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

　　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 BookListView(ListModelMixin, GenericAPIView):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer

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

　　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 {}

　　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 BookDetailView(RetrieveModelMixin, GenericAPIView):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer

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

　　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):
            # If 'prefetch_related' has been applied to a queryset, we need to
            # forcibly invalidate the prefetch cache on the instance.
            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)

　　DestroyModelMixin

删除视图扩展类,提供destroy(requset,*args,**kwargs) 方法,可以快速实现删除一个存在的数据对象.

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

源代码:

class DestroyModelMixin(object):
    """
    Destroy a model instance.
    """
    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()

使用GenericAPIView和视图扩展类,实现挨批接口

代码:

"""GenericAPIView结合视图扩展类实现api接口"""
from rest_framework.mixins import ListModelMixin,CreateModelMixin
class Students2GenericAPIView(GenericAPIView,ListModelMixin,CreateModelMixin):
    # 本次视图类中要操作的数据[必填]
    queryset = Student.objects.all()
    # 本次视图类中要调用的默认序列化器[玄天]
    serializer_class = StudentModelSerializer

    def get(self, request):
        """获取多个学生信息"""
        return self.list(request)

    def post(self,request):
        """添加学生信息"""
        return self.create(request)


from rest_framework.mixins import RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin
class Student2GenericAPIView(GenericAPIView,RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin):
    queryset = Student.objects.all()

    serializer_class = StudentModelSerializer

    # 在使用GenericAPIView视图获取或操作单个数据时,视图方法中的代表主键的参数最好是pk
    def get(self,request,pk):
        """获取一条数据"""
        return self.retrieve(request,pk)

    def put(self,request,pk):
        """更新一条数据"""
        return self.update(request,pk)

    def delete(self,request,pk):
        """删除一条数据"""
        return self.destroy(request,pk)

GenericAPIView的视图子类

　　CreateAPIView

提供 post方法

继承自: GenericAPIView, CreateModelMixin

　　ListAPIView

提供 get方法

继承自: GenericAPIView, ListModelMixin

　　RetrieveAPIView

提供 get方法

继承自: GenericAPIView , RetrieveModelMixin

　　DestoryAPIView

提供 delete 方法

继承自: GenericAPIView, D额storyModelMixin

　　UPdateAPIview

提供 put 和 patch 方法

继承自: GenericAIPView , UpdateModelMixin 

　　RetrieveUpdateAPIView

提供 get put patch 方法

继承自:  GenericAPIView,  RetrieveModelMixin, UpdateModelMixin

　　RetrieveUpdateDestoryAPIView

提供 get put  patch  delete 方法

继承自:GenericAPIView,  rertieveModelMixin , UpdataModelMixin , DEstoryModelMixin 

视图集ViewSet

使用视图集ViewSet, 可以将一系列逻辑相关的动作放到一个类中:
list() 提供一个数组

• retrieve() 提供单个数据
• create() 创建数据
• update()保存数据
• destory() 删除数据

ViewSet视图集类不再实现 get()  post () 等方法 ,而是实现动作 action 如 list() create()  等

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

class BookInfoViewSet(viewsets.ViewSet):

    def list(self, request):
        books = BookInfo.objects.all()
        serializer = BookInfoSerializer(books, many=True)
        return Response(serializer.data)

    def retrieve(self, request, pk=None):
        try:
            books = BookInfo.objects.get(id=pk)
        except BookInfo.DoesNotExist:
            return Response(status=status.HTTP_404_NOT_FOUND)
        serializer = BookInfoSerializer(books)
        return Response(serializer.data)

在设置路由时,我们可以如下操作:

urlpatterns = [
    url(r'^books/$', BookInfoViewSet.as_view({'get':'list'}),
    url(r'^books/(?P<pk>d+)/$', BookInfoViewSet.as_view({'get': 'retrieve'})
]

常用视图集父类

　　ViewSet

继承自APIView 与ViewSetMixin, 作用也与/APIView基本类似,提供了身份认证,权限校验,流量管理等.

ViewSet主要通过继承ViewSetMixin来实现在调用as_view() 时传入字典( 如'get'  'list ') de 映射处理工作

在ViewSet中, 没有提供任何动作action方法, 需要我们自己实现action方法.

　　GenericViewSet

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

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

栗子:

from rest_framework.viewsets import GenericViewSet
from rest_framework.mixins import ListModelMixin,CreateModelMixin,RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin
class Student4ViewSet(GenericViewSet,ListModelMixin,CreateModelMixin,RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

url的定义

urlpatterns = [
    path("students7/", views.Student4ViewSet.as_view({"get": "list", "post": "create"})),
    re_path("students7/(?P<pk>d+)/", views.Student4ViewSet.as_view({"get": "retrieve","put":"update","delete":"destroy"})),

]

　　ModelBiewSet

继承自 GenericViewSet  ,

同时包括了 ListModelMixin ,RetrieveModelMixin , CreateModelMixin , UpdateModelMixin,  DestorModelMixin

　　ReadOnlyModelViewSet

继承自 GenericviewSet 

同时包括了 ListModelMixin , RetrieveModelMixin .

视图集中定义附加action动作

在视图集中,除了上述默认的方法动作外, 还可以添加自定义动作.

栗子:

from rest_framework.viewsets import ModelViewSet,ReadOnlyModelViewSet
class StudentModelViewSet(ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

    def login(self,request):
        """学生登录功能"""
        return Response({"message":"登录成功"})

url的定义:

urlpatterns = [
    path("students8/", views.StudentModelViewSet.as_view({"get": "list", "post": "create"})),
    re_path("students8/(?P<pk>d+)/",
            views.StudentModelViewSet.as_view({"get": "retrieve", "put": "update", "delete": "destroy"})),

    path("stu/login/",views.StudentModelViewSet.as_view({"get":"login"}))

]

　　action属性

在视图集中吗我们可以通过action对象属性来获取当前请求视图集时的action 动作是那个 

栗子:

from rest_framework.viewsets import ModelViewSet
from students.models import Student
from .serializers import StudentModelSerializer
from rest_framework.response import Response
class StudentModelViewSet(ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

    def get_new_5(self,request):
        """获取最近添加的5个学生信息"""
        # 操作数据库
        print(self.action) # 获取本次请求的视图方法名
        
        
通过路由访问到当前方法中.可以看到本次的action就是请求的方法名

路由Routers

对于视图集ViewSet ,我们除了可以子组件动手指明请求方式与动作 action 之间的对应关系外, 还可以使用Routers来帮助我妈妈快速实现路由信息.

REST framework 提供了俩个router

• SimpleRouter
• DefaultRouter

　　使用方法

1  )   创建router对象 ,并注册视图集, 例如

from rest_framework import routers

router = routers.DefaultRouter()
router.register('student4', StudentModelViewSet, base_name='student')

register ( prefix , Viewset,  base_name ) 

• prefix  该视图集的路由前缀
• viewset  视图集
• base_name  路由别名的前缀

如上述代码会形成的路由如下:

^books/$    name: book-list
^books/{pk}/$   name: book-detail

2  )  添加路由数据可以有俩种方式:

方式1 :

urlpatterns = [
    ...
]
urlpatterns += router.urls

urlpatterns = [
    ...
    url(r'^', include(router.urls))
]

使用路由类给视图集生成了路由地址

from rest_framework.viewsets import ModelViewSet,ReadOnlyModelViewSet
class StudentModelViewSet(ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

    def login(self,request):
        """学生登录功能"""
        print(self.action)
        return Response({"message":"登录成功"})

路由代码:

from django.urls import path, re_path
from . import views
urlpatterns = [
    ...
]

"""使用drf提供路由类router给视图集生成路由列表"""
# 实例化路由类
# drf提供一共提供了两个路由类给我们使用,他们用法一致,功能几乎一样
from rest_framework.routers import DefaultRouter
router = DefaultRouter()

# 注册视图集
# router.register("路由前缀",视图集类)
router.register("router_stu",views.StudentModelViewSet)

# 把生成的路由列表追加到urlpatterns
print( router.urls )
urlpatterns += router.urls

上面的代码就是成功生成了路由地址 ( 增/删/改/查一条/查多条的功能  ) 但是不会自动我们在视图集自定义方法的路由.

所以我们如果也要给自定义方法生成路由, 则需要进行action 动作的声明.

　　视图集中附加action的声明

在视图集中, 如果想要让Router自动帮助我们为自定义的动作生成路由信息,需要使用

rest_framework.decorators.action 装饰器.

以action 装饰的方法名会作为action动作名, 与list, retrieve等同.

action装饰器可以接收俩个参数:

　　methods:声明该action对应的请求方式, 列表传递.

　　detail: 声明该action 的路径是否与单一资源对应,及是否是　

xxx/<pk>/action方法名/

　　　　True 表示路径格式是 'xxx/<pk> /action方法

　　　　False 表示路径格式是 xxx/action方法名/

栗子:

from rest_framework.viewsets import ModelViewSet
from rest_framework.decorators import action

class StudentModelViewSet(ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

    # methods 设置当前方法允许哪些http请求访问当前视图方法
    # detail 设置当前视图方法是否是操作一个数据
    # detail为True，表示路径名格式应该为 router_stu/{pk}/login/
    @action(methods=['get'], detail=True)
    def login(self, request,pk):
        """登录"""
        ...

    # detail为False 表示路径名格式应该为 router_stu/get_new_5/
    @action(methods=['put'], detail=False)
    def get_new_5(self, request):
        """获取最新添加的5个学生信息"""
        ...

由路由器自动为此视图集自定义action 方法形成的路由会是如下内容:

^router_stu/get_new_5/$    name: router_stu-get_new_5
^router_stu/{pk}/login/$   name: router_stu-login

　　路由router形成URl的方式

1  ) SimpleRouter

 2  )  DefaultRouter

 DefaultRouter与SimpleRouter的区别是, DefaultRouter 会多附带一个默认的API根视图,返回一个包含所有列表视图的超链接响应数据.