drf序列化器之请求响应以及视图

Posted baicai37

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了drf序列化器之请求响应以及视图相关的知识，希望对你有一定的参考价值。

1. http请求处理

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

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

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

  • 控制数据库查询的执行

  • 调用请求类和响应类[这两个类也是由drf帮我们再次扩展了一些功能类。

 

为了方便我们学习，所以先创建一个子应用req

python manage.py startapp req

注册子应用：

INSTALLED_APPS = [
    ‘django.contrib.admin‘,
    ‘django.contrib.auth‘,
    ‘django.contrib.contenttypes‘,
    ‘django.contrib.sessions‘,
    ‘django.contrib.messages‘,
    ‘django.contrib.staticfiles‘,

    # 注册 rest_framework　的子应用
    ‘rest_framework‘,
    ‘req‘,     # 请求与响应
]

注册路由

# 子应用路由
from django.urls import path
from . import views
urlpatterns = [
    path("students1/",views.StutentView.as_view()),
]


# 总路由
from django.contrib import admin
from django.urls import path,include

urlpatterns = [
    path(‘admin/‘, admin.site.urls),
    path(‘req/‘, include("req.urls")),
]

1.1. 请求与响应

我们先看一下django的request和response

from django.shortcuts import render,HttpResponse
from django.http import JsonResponse
from django.views import View

# Create your views here.
# django视图中的请求和响应
class StutentView(View):
    def get(self,request):
        print(request)  # <WSGIRequest: GET ‘/req/students1/‘>，WSGIRequest的实例对象，WSGIRequest是HttpRequest的子类
        response = HttpResponse("ok")
        print(response)    # <HttpResponse status_code=200, "text/html; charset=utf-8">
        return response

案例：drf的视图

路由：

# 子路由
from django.urls import path
from . import views
urlpatterns = [
    path("students1/",views.StutentView.as_view()),
    path("students2/",views.StudentAPIView.as_view()),
]

# 总路由
from django.contrib import admin
from django.urls import path,include

# 2.x之后django把url拆分成了两个路由函数
# django.urls.path 专门编写字符串路由
# django.urls.re_path 专门编写正则路由
urlpatterns = [
    path(‘admin/‘, admin.site.urls),
    path(‘req/‘, include("req.urls")),
]

视图

from django.shortcuts import render,HttpResponse
from django.http import JsonResponse
from django.views import View

# Create your views here.
# django视图中的请求和响应
class StutentView(View):
    def get(self,request):
        print(request)  # <WSGIRequest: GET ‘/req/students1/‘>
        response = HttpResponse("ok")
        print(response)    # <HttpResponse status_code=200, "text/html; charset=utf-8">
        return response


from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework.request import Request
from rest_framework import status
class StudentAPIView(APIView):
    # 继承的视图类决定了方法中的request对象到底是那个请求对象。
    def get(self,request):
        print(request)    # <rest_framework.request.Request object at 0x7f17d5b07080>
        # rest_framework.request.Request是drf自己独立声明的，不适django的子类
        # drf的request对象中有一个属性叫 _request，这个属性对应的就是django的HttpRequest对象

        response = Response("ok")
        # rest_framework.response.Response
        # drf的response对象就是django的HttpResponse的子类
        print(response)
        return response

小结：

"""
在django中，我们可以在视图里面使用request和response接收和返回数据给客户端，
主要是因为当前视图类继承了django.views.View的原因

在drf中，我们可以在视图里面使用request和response接收和返回数据给客户端，
这里主要是因为视图类集成了rest_framework.views.APIView，所有有好看的界面。
"""

1.1.1 Request

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

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

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

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

1.1.1.1 常用属性

1）.data

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

  • 包含了解析之后的文件和非文件数据

  • 包含了对POST、PUT、PATCH请求方式解析后的数据

  • 利用了REST framework的parsers解析器，不仅支持表单类型数据，也支持JSON数据

2）.query_params

request.query_params返回解析之后的查询字符串数据（http://127.0.0.1:8000/req/students2/?name="oldboy"），就是查询地址?后面一堆k,v

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

1.1.2 Response

rest_framework.response.Response

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

REST framework提供了Renderer 渲染器，用来根据请求头中的Accept（接收数据类型声明）来自动转换响应数据到对应格式。如果前端请求中未进行Accept声明，则会采用默认方式处理响应数据，我们可以通过配置来修改默认响应格式。【简而言之，就是Renderer能通过请求找的Accept查询出客户端支持和希望的数据类型，把视图的结果以客户端能识别的格式返回】

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

1.1.2.1 构造方式

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.1.2.2 常用属性

1）.data

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

2）.status_code

状态码的数字

3）.content

经过render处理后的响应数据

1.1.2.3 状态码

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

1）信息告知 - 1xx
HTTP_100_CONTINUE
HTTP_101_SWITCHING_PROTOCOLS
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）重定向 - 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
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
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

Request和Reponse视图中使用案例

from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework.request import Request
from rest_framework import status
class StudentAPIView(APIView):
    # 继承的视图类决定了方法中的request对象到底是那个请求对象。这里是APIView所以request是drf中的
    def get(self,request):
        print(request)
        # rest_framework.request.Request是drf自己独立声明的，不适django的子类
        # drf的request对象中有一个属性叫 _request，这个属性对应的就是django的HttpRequest对象

        response = Response("ok")
        # rest_framework.response.Response
        # drf的response对象就是django的HttpResponse的子类
        print(response)
        return response

    def post(self,request):
        """请求对象的学习"""
        print(request.data)  # 接受http请求体数据,目前默认的配置中只能接受表单和json数据，
        # 其他格式的数据不能request.data来获取
        """打印效果：
        如果客户端上传的是json：
        {‘title‘: ‘西游记‘, ‘price‘: 20, ‘pub_date‘: ‘2020-10-10‘, ‘read‘: 200, ‘comment‘: 20}
        如果客户端上传的是表单
        <QueryDict: {‘title‘: [‘老男孩‘]}>
        """
        print(request.query_params)  # 这里其实本质上就是django.http.request.HttpRequest对象的GET属性
        
        """
        请求: /req/students2/?name=xiaoming
        打印效果：
        <QueryDict: {‘name‘: [‘xiaoming‘]}>
        """
        return Response(data="ok", status=status.HTTP_201_CREATED, headers={"company": "laonanhai"})

2. 视图

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

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

  • 控制数据库查询的执行[数据库的删除/查询代码写在视图中，更新和添加写在序列化器]

为了方便演示，所以视图里面的内容知识，我们另外创建一个子应用来展示

python manage.py startapp demo

注册子应用

INSTALLED_APPS = [
    ‘django.contrib.admin‘,
    ‘django.contrib.auth‘,
    ‘django.contrib.contenttypes‘,
    ‘django.contrib.sessions‘,
    ‘django.contrib.messages‘,
    ‘django.contrib.staticfiles‘,

    # 注册 rest_framework　的子应用
    ‘rest_framework‘,
    ‘req‘,     # 请求与响应
    ‘demo‘,     # 视图类的学习
]

注册路由，

# 总路由
from django.contrib import admin
from django.urls import path,include
# 新版的django把url拆分成了2个路由函数
# django.urls.path 专门编写字符串路由
# django.urls.re_path 专门编写正则路由
urlpatterns = [
    path(‘admin/‘, admin.site.urls),
    path(‘req/‘, include("req.urls")),
    path("demo/",include("demo.urls")),
]

# 子路由

2.2 视图

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

drf视图的四大核心：APIView、GenericAPIView、视图集和视图扩展类

2.2.1 2个视图基类

2.2.1.1 APIView

rest_framework.views.APIView

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

drf的APIView与djangoView的不同之处在于：

  • 传入到视图方法中的是REST framework的Request对象，而不是Django的HttpRequeset对象；

  • 视图方法可以返回REST framework的Response对象，视图会为响应数据设置（render）符合前端要求的格式；

  • 任何APIException异常都会被捕获到，并且处理成合适的响应信息；

  • 重写了as_view()，在进行dispatch()路由分发前，会对http请求进行身份认证、权限检查、访问流量控制。

支持定义的类属性

  • authentication_classes 列表或元组，身份认证类

  • permissoin_classes 列表或元组，权限检查类

  • throttle_classes 列表或元祖，流量控制类

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

views.py

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

serializers.py

from rest_framework import serializers
from students.models import Student
class StudentModelSerializer(serializers.ModelSerializer):
    """学生序列化器"""
    class Meta:
        model = Student
        fields = "__all__"

demo/urls.py

from django.urls import path,re_path
from . import views
urlpatterns = [
    path("students1/",views.Student1APIView.as_view()),
    re_path("students2/(?P<pk>d+)/", views.Student2APIView.as_view()),
]

2.2.1.2 GenericAPIView

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

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

      注意，该方法在提供序列化器对象的时候，会向序列化器对象的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()

    • 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通用视图类，我们新建一个子应用。

 

以上是关于drf序列化器之请求响应以及视图的主要内容，如果未能解决你的问题，请参考以下文章

drf入门规范序列化器组件视图组件请求与响应

067.Python框架Django之DRF视图类

python drf 序列化器之数据的增删改查（详细）

DRF视图类关系详解

drf序列化大总结

drf框架 2 drf框架的请求生命周期(as_view和dispatch方法), 请求解析渲染响应异常, 序列化组件 ，ORM配置回顾(media文件配置)，应用在settings.py中(代码片