Django Rest Framework之解析器

深藏阁楼爱情的钟 2021-12-20 04:21 245阅读 0赞

# 基本代码结构 #

urls.py:

from django.conf.urls import url, include
    from web.views.s5_parser import TestView
    
    urlpatterns = [
        url(r'test/', TestView.as_view(), name='test'),
    ]

views.py:

from rest_framework.views import APIView
    from rest_framework.response import Response
    from rest_framework.request import Request
    from rest_framework.parsers import JSONParser
    
    
    class TestView(APIView):
        # JSONParser：请求头content-type为application/json
        # FormParser：请求头content-type为application/x-www-form-urlencoded
        # MultiPartParser: 请求头content-type为multipart/form-data
        #  FileUploadParser：上传文件
        parser_classes = [JSONParser, FormParser, MultiPartParser, FileUploadParser, ]
    
        def post(self, request, *args, **kwargs):
            print(request.content_type)
    
            # 获取请求的值，并使用对应的JSONParser进行处理
            print(request.data)
    
            # application/x-www-form-urlencoded 或 multipart/form-data时，request.POST中才有值
            print(request.POST)
            print(request.FILES)
    
            return Response('POST请求，响应内容')
    
        def put(self, request, *args, **kwargs):
            return Response('PUT请求，响应内容')

parser\_classes属性变量中的值，是各种解析器对象。前端会向后台发送不同类型的请求，而django后台的drf接口必须通过配置解析器才能获取到相关请求数据。常用的解析器主要是“JSONParser”和“FormParser”这两个解析器。

# 源码分析 #

*  ## 为什么会使用parser\_classes属性变量，它有什么用？ ##

![1196328-20190301110118755-1702838485.png][]

同样还是从APIView类的入口方法dispatch入口，在dispatch方法中，调用了initialize\_request方法。这个方法在前文中已经说过，是用来封装django原生的request请求的。由上图知道，django原生的request请求数据被封装到了Request对象中，在实例化该对象时，将解析数据的解析器初始化到了parsers属性变量中。

![1196328-20190301110645206-462319371.png][]

跳转到get\_parsers方法中，可以看到，同样也是返回的是列表生成式。

![1196328-20190301110805203-136130359.png][]

再跳转回APIView类中，可以看到属性变量parser\_classes定义的地方。同样也可以通过settings配置文件进行全局配置。如果不需要进行全局配置，那就要在自定义的视图类中对parser\_classes属性变量进行重新赋值，即：“parser\_classes = \[JSONParser, FormParser, MultiPartParser, FileUploadParser,\]”。这列表元素都是解析器对象，只要这样配置好，drf就会根据parser\_classes中的解析器去解析数据。

*  ## 为什么从request.data中获取数据? ##

![1196328-20190301124432669-25489114.png][]

既然要分析为什么是从data中获取数据，那么分析的入口点当然就是data了。我们知道，django原生的request请求，会被drf通过Request对象封装，那么就跳转到Request类定义中看看这个“data”的实现。在data方法的实现中可以看到前端请求的数据是通过“\_load\_data\_and\_files”方法获取的，并且返回值是“\_full\_data”属性变量。先跳转到“\_load\_data\_and\_files”方法中:

![1196328-20190301125026121-928202133.png][]

![1196328-20190301130644551-553390267.png][]

在“\_load\_data\_and\_files”方法中可知，是通过调用“\_parse”方法去获取请求数据的，并且将请求数据保存在“\_data”和“\_files”属性变量中。除文件相关的数据外的数据都保存在了“\_data”中，而“\_data”中的数据又都赋值到“\_full\_data”属性变量中。又由上一张图可知，“data”方法的返回值是“\_full\_data”,即：data方法获取到的数据就是“\_full\_data”中的数据。

再往下看，“content\_type”属性变量是用来保存请求头的，所以，在基本代码结构中看到，只有设置了某些请求头才会通过“request.POST”来获取请求数据。

下面跳转到“\_parse”方法中：

![1196328-20190301130552408-888719822.png][]

![1196328-20190301131151071-507991944.png][]

![1196328-20190301132532370-149557338.png][]

在“\_parse”方法中，可以看到将获取到的请求头保存到了“media\_type”变量中。然后又通过调用“select\_parser(self, self.parsers)”方法，来选择所需要的解析器（参数“self.parsers”就是我们在自定义视图中“parser\_classes”的值）。

又通过，parser\_classes中解析器对象中的parser方法来解析请求到的数据，即：“parsed = parser.parse(steam, media\_type, self.parser\_context)”。这里以“JSONParser”对象为例，由上图可知，media\_type属性变量中保存的是该解析器所对应的请求头，self.parser\_context中，保存的是从前端请求中获取到的请求头。

再来到“JSONParser”类的“parse”方法中可知，再通过返回“json.load”来处理请求数据。返回的请求数据就会保存到“Request”类的“\_parse”方法中的parsed变量中。而\_parse方法的返回值为元组，第一个元素就是需要的数据。这些数据会在“\_load\_data\_and\_files”方法中，赋值给“Request”类的“\_data”属性方法，而\_data中的数据会赋值给“\_full\_data”中。因此，“Request”类中“data”方法返回值是“\_full\_data”，这样，就可以通过“request.data”获取请求数据。

# 全局配置 #

REST_FRAMEWORK = {
        'DEFAULT_PARSER_CLASSES':[
            'rest_framework.parsers.JSONParser'
            'rest_framework.parsers.FormParser'
            'rest_framework.parsers.MultiPartParser'
        ]
    }

配置加入不同的解析器，就会解析不同类型的请求数据，当然是可以同时配置加入多个解析器的。同样的，配置了全局解析器后，那么，在自定义的视图类中，就可以不用通过“parser\_classes”属性变量进行添加解析器的。

转载于:https://www.cnblogs.com/cjaaron/p/10456044.html

[1196328-20190301110118755-1702838485.png]: /images/20211220/2641e22e0a1f449d933c97e8e90569b7.png
[1196328-20190301110645206-462319371.png]: /images/20211220/514e9863a0fd47c882f0ff4d3d242d83.png
[1196328-20190301110805203-136130359.png]: /images/20211220/76888f955d7445d8aa46dc09ce3ab55d.png
[1196328-20190301124432669-25489114.png]: /images/20211220/0350f1c2770147448825b1bee129885d.png
[1196328-20190301125026121-928202133.png]: /images/20211220/8792b65ec0df49bbb1721f29788d9f38.png
[1196328-20190301130644551-553390267.png]: /images/20211220/e3620133d3864e459ac82ae649c274cf.png
[1196328-20190301130552408-888719822.png]: /images/20211220/4cead1933e2a4aa1a1884bb51f9ef6a3.png
[1196328-20190301131151071-507991944.png]: /images/20211220/839d615a7f4340bb93bf4379e8f99f05.png
[1196328-20190301132532370-149557338.png]: /images/20211220/ab2d41034b4e46f392f9378367e9cc45.png