DRF学习笔记(四)：DRF视图

fresh_nam

已于 2022-09-20 11:24:36 修改

阅读量799

点赞数 2

分类专栏： python django学习文章标签： python django

于 2021-01-09 11:57:09 首次发布

本文链接：https://blog.csdn.net/fresh_nam/article/details/112387385

版权

python 同时被 2 个专栏收录

27 篇文章 6 订阅

订阅专栏

django学习

16 篇文章 1 订阅

订阅专栏

文章目录

一、Request与Response
二、视图说明
- 1.两个基类
- - 1）APIView
  - 2）GenericAPIView
2.五个扩展类

一、Request与Response

1.Request

REST framework 传入视图的request对象不再是Django默认的HttpRequest对象，而是REST framework提供的扩展了HttpRequest类的Request类的对象。

REST framework 提供了Parser解析器，在接收到请求后会自动根据Content-Type指明的请求数据类型（如JSON、表单等）将请求数据进行parse解析，解析为类字典对象保存到Request对象中。

Request对象的数据是自动根据前端发送数据的格式进行解析之后的结果。

无论前端发送的哪种格式的数据，我们都可以以统一的方式读取数据

常用属性

.data

request.data 返回解析之后的请求体数据。类似于Django中标准的request.POST和 request.FILES属性，但提供如下特性：

包含了解析之后的文件和非文件数据
包含了对POST、PUT、PATCH请求方式解析后的数据
利用了REST framework的parsers解析器，不仅支持表单类型数据，也支持JSON数据

.query_params

request.query_params与Django标准的request.GET相同，只是更换了更正确的名称而已。

2.Response

rest_framework.response.Response

REST framework提供了一个响应类Response，使用该类构造响应对象时，响应的具体数据内容会被转换（render渲染）成符合前端需求的类型。

REST framework提供了Renderer 渲染器，用来根据请求头中的Accept（接收数据类型声明）来自动转换响应数据到对应格式。如果前端请求中未进行Accept声明，则会采用默认方式处理响应数据，我们可以通过配置来修改默认响应格式。

参数

Response(data, status=None, template_name=None, headers=None, content_type=None)

data数据不要是render处理之后的数据，只需传递python的内建类型数据即可，REST framework会使用renderer渲染器处理data。

data不能是复杂结构的数据，如Django的模型类对象，对于这样的数据我们可以使用Serializer序列化器序列化处理后（转为了Python字典类型）再传递给data参数。

说明：

data: 为响应准备的序列化处理后的数据；
status: 状态码，默认200；
template_name: 模板名称，如果使用HTMLRenderer 时需指明；
headers: 用于存放响应头信息的字典；
content_type: 响应数据的Content-Type，通常此参数无需传递，REST framework会根据前端所需类型数据来设置该参数。

常用属性

.data：传给response对象的序列化后，但尚未render处理的数据
.status_code：状态码的数字
.content：经过render处理后的响应数据

二、视图说明

1.两个基类

1）APIView

rest_framework.views.APIView

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

APIView与View的不同之处在于：

传入到视图方法中的是REST framework的Request对象，而不是Django的HttpRequeset对象；
视图方法可以返回REST framework的Response对象，视图会为响应数据设置（render）符合前端要求的格式；
任何APIException异常都会被捕获到，并且处理成合适的响应信息；
在进行dispatch()分发前，会对请求进行身份认证、权限检查、流量控制。

支持定义的属性：

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

在APIView中仍以常规的类视图定义方法来实现get() 、post() 或者其他请求方式的方法。
使用：
demo/views.py

from rest_framework.views import APIView
from rest_framework.response import Response
from demo.models import StudentInfo
from demo.serializers import StudentInfoSerializer
# Create your views here.

class StudentListView(APIView):
    def get(self, request):
        students = StudentInfo.objects.all()
        serializer = StudentInfoSerializer(students, many=True)  # 多对象序列化时many为True
        return Response(serializer.data)

添加url:
demo/urls.py

from django.urls import path, include
from demo import views
urlpatterns = [
    path('students/', views.StudentListView.as_view())
]

项目的根路径urls.py添加：

urlpatterns = [
	......
    path('demo/', include('demo.urls')),
]

结果：
在这里插入图片描述

2）GenericAPIView

rest_framework.generics.GenericAPIView

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

提供的关于序列化器使用的属性与方法
属性：
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 当前请求期望返回的数据格式

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

queryset 指明使用的数据查询集
方法：
get_queryset(self)

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

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

返回详情视图所需的模型类数据对象，主要用来提供给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 指明过滤控制后端

2.五个扩展类

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

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

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 demo.models import StudentInfo
from demo.serializers import StudentInfoSerializer
from rest_framework.mixins import ListModelMixin
from rest_framework.generics import GenericAPIView
# Create your views here.

class StudentListView(ListModelMixin, GenericAPIView):
    queryset = StudentInfo.objects.all()
    serializer_class = StudentInfoSerializer

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

结果：
在这里插入图片描述

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

举例：
demo/views.py

from demo.models import StudentInfo, ClassInfo
from demo.serializers import StudentInfoSerializer, ClassInfoSerializer
from rest_framework.mixins import ListModelMixin, CreateModelMixin
from rest_framework.generics import GenericAPIView
class ClassView(CreateModelMixin, GenericAPIView):
    queryset = ClassInfo.objects.all()
    serializer_class = ClassInfoSerializer
    def post(self, request):
        return self.create(request)

demo/urls.py

from django.urls import path, include
from demo import views
urlpatterns = [
    path('students/', views.StudentListView.as_view()),
    path('class/', views.ClassView.as_view()),  #添加了这句
]

结果：
在这里插入图片描述

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)

举例：

from demo.models import StudentInfo, ClassInfo
from demo.serializers import StudentInfoSerializer, ClassInfoSerializer
from rest_framework.mixins import ListModelMixin, CreateModelMixin, RetrieveModelMixin
from rest_framework.generics import GenericAPIView
class ClassView(CreateModelMixin, GenericAPIView, RetrieveModelMixin):
    queryset = ClassInfo.objects.all()
    serializer_class = ClassInfoSerializer
    def post(self, request):
        return self.create(request)
	#下面是添加内容
    def get(self, request, pk):
        return self.retrieve(request)

添加url:

from django.urls import path, include
from demo import views
urlpatterns = [
    path('students/', views.StudentListView.as_view()),
    path('class/', views.ClassView.as_view()),
    path('class/<int:pk>/', views.ClassView.as_view()),  #添加了这一行
]

结果：
在这里插入图片描述

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):
            # 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)

举例：

from demo.models import StudentInfo, ClassInfo
from demo.serializers import StudentInfoSerializer, ClassInfoSerializer
from rest_framework.mixins import ListModelMixin, CreateModelMixin, RetrieveModelMixin, UpdateModelMixin
from rest_framework.generics import GenericAPIView
class ClassView(CreateModelMixin, GenericAPIView, RetrieveModelMixin, UpdateModelMixin):
    queryset = ClassInfo.objects.all()
    serializer_class = ClassInfoSerializer
    def post(self, request):
        return self.create(request)

    def get(self, request, pk):
        return self.retrieve(request)
	# 添加了下面内容
    def put(self, request, pk):
        return self.update(request)

结果：
在这里插入图片描述

5）DestroyModelMixin

删除视图扩展类，提供destroy(request, *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()

举例：

from demo.models import StudentInfo, ClassInfo
from demo.serializers import StudentInfoSerializer, ClassInfoSerializer
from rest_framework.mixins import ListModelMixin, CreateModelMixin, RetrieveModelMixin, UpdateModelMixin, DestroyModelMixin
from rest_framework.generics import GenericAPIView
class ClassView(CreateModelMixin, GenericAPIView, RetrieveModelMixin, UpdateModelMixin, DestroyModelMixin):
    queryset = ClassInfo.objects.all()
    serializer_class = ClassInfoSerializer
    def post(self, request):
        return self.create(request)

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

    def put(self, request, pk):
        return self.update(request)
    # 添加了以下内容
    def delete(self, request, pk):
        return self.destroy(request)