Django-DRF(视图相关）

阅读原文时间：2023年07月08日阅读：4

　　drf除了在数据序列化部分简写代码以外，还在视图中提供了简写操作。所以在django原有的django.views.View类基础上，drf封装了多个子类出来提供给我们使用。

　　Django REST framwork 提供的视图的主要作用：

控制序列化器的执行（检验、保存、转换数据）
控制数据库查询的执行
调用请求类和响应类（这两个类也是由drf帮我们再次扩展了一些功能类）。

一. 请求与响应

　　1. Request

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

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

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

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

　　常用属性：

　　1. data

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

* 包含了解析之后的文件和非文件数据
- 包含了对POST、PUT、PATCH请求方式解析后的数据
- 利用了REST framework的parsers解析器，不仅支持表单类型数据，也支持JSON数据
  
  　　2. query_params
  
  　　request.query_params与Django标准的 request.GET 相同，只是更换了更正确的名称而已。

　　2. Response

from rest_framework.response import Response

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

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

　　可以在rest_framework.settings查找所有的drf默认配置项

REST_FRAMEWORK = {
'DEFAULT_RENDERER_CLASSES': ( # 默认响应渲染类
'rest_framework.renderers.JSONRenderer', # json渲染器
'rest_framework.renderers.BrowsableAPIRenderer', # 浏览API渲染器
)
}

　　构造方式：

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会根据前端所需类型数据来设置该参数。

　　常用属性（用的不多）：

　　1. data：传给response对象的序列化后，但尚未render处理的数据

　　2. status_code：状态码的数字

　　3. content：经过render处理后的响应数据

　　3. 状态码

　　为了方便设置状态码， REST Framework在rest_framework.status模块中提供了常用状态码常量。

　　3.1 信息告知---1XX

HTTP_100_CONTINUE
HTTP_101_SWITCHING_PROTOCOLS

　　3.2 成功---2XX

HTTP_200_OK
HTTP_201_CREATED
HTTP_202_ACCEPTED
HTTP_203_NON_AUTHORITATIVE_INFORMATION
HTTP_204_NO_CONTENT
HTTP_205_RESET_CONTENT
HTTP_206_PARTIAL_CONTENT
HTTP_207_MULTI_STATUS

　　3.3 重定向---3XX

HTTP_300_MULTIPLE_CHOICES
HTTP_301_MOVED_PERMANENTLY
HTTP_302_FOUND
HTTP_303_SEE_OTHER
HTTP_304_NOT_MODIFIED
HTTP_305_USE_PROXY
HTTP_306_RESERVED
HTTP_307_TEMPORARY_REDIRECT

　　3.4 客户端错误---4XX

HTTP_400_BAD_REQUEST
HTTP_401_UNAUTHORIZED
HTTP_402_PAYMENT_REQUIRED
HTTP_403_FORBIDDEN
HTTP_404_NOT_FOUND
HTTP_405_METHOD_NOT_ALLOWED
HTTP_406_NOT_ACCEPTABLE
HTTP_407_PROXY_AUTHENTICATION_REQUIRED
HTTP_408_REQUEST_TIMEOUT
HTTP_409_CONFLICT
HTTP_410_GONE
HTTP_411_LENGTH_REQUIRED
HTTP_412_PRECONDITION_FAILED
HTTP_413_REQUEST_ENTITY_TOO_LARGE
HTTP_414_REQUEST_URI_TOO_LONG
HTTP_415_UNSUPPORTED_MEDIA_TYPE
HTTP_416_REQUESTED_RANGE_NOT_SATISFIABLE
HTTP_417_EXPECTATION_FAILED
HTTP_422_UNPROCESSABLE_ENTITY
HTTP_423_LOCKED
HTTP_424_FAILED_DEPENDENCY
HTTP_428_PRECONDITION_REQUIRED
HTTP_429_TOO_MANY_REQUESTS
HTTP_431_REQUEST_HEADER_FIELDS_TOO_LARGE
HTTP_451_UNAVAILABLE_FOR_LEGAL_REASONS

　　3.5 服务器错误---5XX

HTTP_500_INTERNAL_SERVER_ERROR
HTTP_501_NOT_IMPLEMENTED
HTTP_502_BAD_GATEWAY
HTTP_503_SERVICE_UNAVAILABLE
HTTP_504_GATEWAY_TIMEOUT
HTTP_505_HTTP_VERSION_NOT_SUPPORTED
HTTP_507_INSUFFICIENT_STORAGE
HTTP_511_NETWORK_AUTHENTICATION_REQUIRED

二. 视图

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

　　Django REST framwork 提供的视图的主要作用：

控制序列化器的执行（检验、保存、转换数据）
控制数据库查询的执行

　　下面我们介绍一下两个视图基类

　　1. APIView

from rest_framework.views import APIView

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

　　APIView 与View的不同之处在于：

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

　　支持定义的类属性
authentication_classes 列表或元祖，身份认证类
permissoin_classes 列表或元祖，权限检查类
throttle_classes 列表或元祖，流量控制类

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

　　2.GenericAPIView（通用视图类）

from rest_framework.generics import GenericAPIView

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

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

属性：
- serializer_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扩展类使用，如果我们在视图中想要获取序列化器对象，也可以直接调用此方法。

　　提供的关于数据库查询的属性与方法
属性：
- queryset 指明使用的数据查询集
方法：
- get_queryset(self)
  
  返回视图使用的查询集，主要用来提供给Mixin扩展类使用，是列表视图与详情视图获取数据的基础，默认返回queryset属性，可以重写，例如：

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

* get_object(self)

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

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

　　其他可以设置的属性
* pagination_class 指明分页控制类
- filter_backends 指明过滤控制后端
  
  　　简单介绍了一下，下面我们就通过代码来感受一下。
  
  　　首先创建新的应用

python3 manage.py startapp req

　　下面所用到的序列化器类：

from students.models import Student
from rest_framework import serializers

class StudentModelSerializer(serializers.ModelSerializer):

class Meta:  
    model = Student  
    fields = \["id", "name", "age", "sex"\]  
    extra\_kwargs = {  
        "name": {"max\_length": 10, "min\_length": 4},  
        "age": {"max\_value": 150, "min\_value": 0},  
    }

def validate\_name(self, data):  
    if data == "root":  
        raise serializers.ValidationError("用户名不能为root！")  
    return data

def validate(self, attrs):  
    name = attrs.get('name')  
    age = attrs.get('age')

    if name == "alex" and age == 22:  
        raise serializers.ValidationError("alex在22时的故事。。。")

    return attrs

　　3. View与APIView

　　　　在req应用下的urls.py文件：

urlpatterns = [
# View与APIView的区别
path("student1/", views.Student1View.as_view()),
path("student2/", views.Student2APIView.as_view()),
]

　　　　在req应用下的views.py文件：

"""
测试代码：区分django的 View 和 drf的 APIView
"""
from django.views import View
from django.http import JsonResponse

class Student1View(View):
def get(self, request):
print(request) # 这是django提供的HttpRequest类
print(request.GET)
"""打印效果：

"""
data_dict = {'name': "alex", "age": 18}

    return JsonResponse(data\_dict)

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

class Student2APIView(APIView):
def get(self, request):
print(request) # rest_framework扩展后的request
print(request.query_params)
print(request.data)
"""打印效果

"""
data_dict = {'name': "alex", "age": 18}

    return Response(data\_dict, status=status.HTTP\_204\_NO\_CONTENT, headers={"name": "xiaobai"})

　　4. APIView实现接口

　　　　在req应用下的urls.py文件：

　　　　在req应用下的views.py文件：

"""
使用APIView提供学生信息的5个API接口
GET /req/student3/ # 获取全部数据
POST /req/student3/ # 添加数据

GET /req/student3/(?P\d+) # 获取一条数据
PUT /req/student3/(?P\d+) # 更新一条数据
DELETE /req/student3/(?P\d+) # 删除一条数据
"""
from students.models import Student
from req.serializers import StudentModelSerializer

class Student3APIView(APIView):
def get(self, request):
"""获取所有数据"""
student_list = Student.objects.all()
# 序列化操作
serializer = StudentModelSerializer(instance=student_list, many=True)

    return Response(serializer.data)

def post(self, request):  
    # 获取用户提交的数据  
    data\_dict = request.data  
    # 实例化序列化器对象  
    serializer = StudentModelSerializer(data=data\_dict)  
    # 数据校验  
    serializer.is\_valid(raise\_exception=True)  
    # 保存数据  
    serializer.save()

    return Response(serializer.validated\_data)

class Student4APIView(APIView):
def get(self, request, pk):
# 过滤pk对应的学生对象
student_obj = Student.objects.get(pk=pk)

    serializer = StudentModelSerializer(instance=student\_obj)

    return Response(serializer.data)

def put(self, request, pk):  
    # 过滤pk对应的学生对象  
    student\_obj = Student.objects.get(pk=pk)  
    # 获取用户提交的数据  
    data\_dict = request.data

    serializer = StudentModelSerializer(instance=student\_obj, data=data\_dict)

    serializer.is\_valid(raise\_exception=True)

    serializer.save()

    return Response(serializer.validated\_data)

def delete(self, request, pk):  
    Student.objects.filter(pk=pk).delete()  
    return Response(status=status.HTTP\_204\_NO\_CONTENT)

　　5. GenericAPIView实现接口

　　　　在req应用下的urls.py文件：

　　　　在req应用下的views.py文件：

"""
使用GenericAPIView提供学生信息的5个API接口
GET /req/student4/ # 获取全部数据
POST /req/student4/ # 添加数据

GET /req/student4/(?P\d+) # 获取一条数据
PUT /req/student4/(?P\d+) # 更新一条数据
DELETE /req/student4/(?P\d+) # 删除一条数据
"""

from rest_framework.generics import GenericAPIView

class Student5GenericAPIView(GenericAPIView):
# 当前视图类中操作的公共数据，先从数据库查询出来
queryset = Student.objects.all()
# 设置类视图中所有方法共有调用的序列化器类
serializer_class = StudentModelSerializer

def get(self, request):  
    # 获取模型数据  
    student\_list = self.get\_queryset()

    # 调用序列化器  
    serializer = self.get\_serializer(instance=student\_list, many=True)

    return Response(serializer.data)

def post(self, request):  
    """新增数据"""  
    # 获取用户提交的数据并实例化序列化器对象  
    serializer = self.get\_serializer(data=request.data)  
    # 数据校验  
    serializer.is\_valid(raise\_exception=True)  
    # 保存数据  
    serializer.save()  
    return Response(serializer.data)

class Student6GenericAPIView(GenericAPIView):
# 当前视图类中操作的公共数据，先从数据库查询出来
queryset = Student.objects.all()
# 设置类视图中所有方法共有调用的序列化器类
serializer_class = StudentModelSerializer

def get(self, request, pk):  
    """参数pk名，必须要叫pk，否则会报错。"""  
    # 获取模型对象  
    instance = self.get\_object()  
    serializer = self.get\_serializer(instance=instance)

    return Response(serializer.data)

def put(self, request, pk):  
    instance = self.get\_object()

    serializer = self.get\_serializer(instance=instance, data=request.data)

    serializer.is\_valid(raise\_exception=True)

    serializer.save()

    return Response(serializer.data)

def delete(self, request, pk):  
    # 获取模型对象  
    instance = self.get\_object()  
    # 删除模型对象  
    instance.delete()

    return Response(status=status.HTTP\_204\_NO\_CONTENT)

　　6. 五个视图扩展类

"""
使用GenericAPIView结合视图Mixin扩展类，快速实现数据接口的APIView
ListModelMixin 实现查询所有数据功能
CreateModelMixin 实现添加数据的功能
RetrieveModelMixin 实现查询一条数据功能
UpdateModelMixin 更新一条数据的功能
DestroyModelMixin 删除一条数据的功能
"""

　　　　在req应用下的urls.py文件：

　　　　在req应用下的views.py文件：

from rest_framework.mixins import ListModelMixin, CreateModelMixin

class Student7GenericAPIView(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 Student8GenericAPIView(GenericAPIView, RetrieveModelMixin, UpdateModelMixin, DestroyModelMixin):
queryset = Student.objects.all()
serializer_class = StudentModelSerializer

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)

　　7. 内置的扩展子类

　　　　在req应用下的urls.py文件：

urlpatterns = [
# View与APIView的区别
path("student1/", views.Student1View.as_view()),
path("student2/", views.Student2APIView.as_view()),
# 使用APIView
path("student3/", views.Student3APIView.as_view()),
re_path(r"^student3/(?P\d+)/$", views.Student4APIView.as_view()),
# 使用GenericAPIView
path("student4/", views.Student5GenericAPIView.as_view()),
re_path(r"^student4/(?P\d+)/$", views.Student6GenericAPIView.as_view()),
# 使用GenericAPIView，结合Mixin的扩展类
path("student5/", views.Student7GenericAPIView.as_view()),
re_path(r"^student5/(?P\d+)/$", views.Student8GenericAPIView.as_view()),
# 使用内置的扩展子类，生成API接口
path("student6/", views.Student9GenericAPIView.as_view()),
re_path(r"^student6/(?P\d+)/$", views.Student10GenericAPIView.as_view()),
]

　　　　在req应用下的views.py文件：

"""
DRF里面，内置了一些同时继承了GenericAPIView和Mixins扩展类的视图子类，
我们可以直接继承这些子类就可以生成对应的API接口
"""

"""
ListAPIView 获取所有数据
CreateAPIView 添加数据
"""
from rest_framework.generics import ListAPIView, CreateAPIView

class Student9GenericAPIView(ListAPIView, CreateAPIView):
queryset = Student.objects.all()
serializer_class = StudentModelSerializer

"""
RetrieveAPIView 获取一条数据
UpdateAPIView 更新一条数据
DestorAPIView 删除一条数据
RetrieveUpdateDestoryAPIView 上面三个的缩写
"""
from rest_framework.generics import RetrieveUpdateDestroyAPIView

class Student10GenericAPIView(RetrieveUpdateDestroyAPIView):
queryset = Student.objects.all()
serializer_class = StudentModelSerializer

　　8. 视图集

　　　　在req应用下的urls.py文件：

　　　　在req应用下的views.py文件：

"""
视图集
上面５个接口使用了８行代码生成，但是我们可以发现有一半的代码重复了
所以，我们要把这些重复的代码进行整合，但是依靠原来的类视图，其实有２方面产生冲突的

查询所有数据、添加数据是不需要声明pk的，而其他的接口需要 [路由冲突了]
查询所有数据和查询一条数据，都是属于get请求 [请求方法冲突了]
为了解决上面的２个问题，所以DRF提供了视图集来解决这个问题
"""

from rest_framework.viewsets import GenericViewSet, ModelViewSet
from rest_framework.mixins import ListModelMixin, CreateModelMixin, DestroyModelMixin, UpdateModelMixin, RetrieveModelMixin

这两个是等价的

class Student11GenericAPIView(GenericViewSet, ListModelMixin, CreateModelMixin, DestroyModelMixin, UpdateModelMixin, RetrieveModelMixin):

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

手机扫一扫

移动阅读更方便

你可能感兴趣的文章

数据可视化【原创】vue+arcgis+threejs 实现流光立体墙效果

数据可视化【原创】vue+arcgis+threejs 实现流光边界线效果

数据可视化【原创】vue+arcgis+threejs 实现海量建筑物房屋渲染，性能优化