登录/ 注册
 找回密码
 立即注册
关闭

CSDN热搜

豆瓜网 精品问答 技术交流 资源下载
返回列表 发新帖
首页 › 业界区 › 业界 ›DRF解析器

DRF解析器

癖艺泣 昨天 13:59
1、概念

解析器（Parsers）是 Django REST Framework 中的重要组件，它负责将传入的请求体内容解析为 Python 数据类型。
解析器的作用

  • 解析请求体内容（如 JSON、表单数据、XML 等）
  • 将原始数据转换为 Python 数据结构
  • 使转换后的数据可在 request.data 中访问
解析器工作流程

  • 客户端发送请求（包含 Content-Type 头）
  • DRF 根据 Content-Type 选择合适的解析器
  • 解析器解析请求体内容（首次访问request.data解析）
  • 视图可以访问和使用这些数据
2、内置解析器

2.1 BaseParser

基类，所有解释器应该继承该类，并制定media_type属性和覆盖parse方法
  1. class BaseParser:
  2.     media_type = None
  4.     def parse(self, stream, media_type=None, parser_context=None):
  5.         raise NotImplementedError(".parse() must be overridden.")
复制代码
2.1 JSONParser

最常用的解析器，解析 application/json类型的请求体，将 JSON 数据转换为 Python 字典。核心就是json.load
  1. class JSONParser(BaseParser):
  2.     media_type = 'application/json'
  3.     renderer_class = renderers.JSONRenderer
  4.     strict = api_settings.STRICT_JSON
  6.     def parse(self, stream, media_type=None, parser_context=None):
  7.         # ...
  8.         return json.load(decoded_stream, parse_constant=parse_constant)
复制代码
2.2 FormParser

解析 application/x-www-form-urlencoded类型的请求体（典型的 HTML 表单数据）,返回 QueryDict 对象
  1. class FormParser(BaseParser):
  2.     media_type = 'application/x-www-form-urlencoded'
  4.     def parse(self, stream, media_type=None, parser_context=None):
  5.         parser_context = parser_context or {}
  6.         encoding = parser_context.get('encoding', settings.DEFAULT_CHARSET)
  7.         return QueryDict(stream.read(), encoding=encoding)
复制代码
2.3 FileUploadParser

FileUploadParser用于将整个请求体内容视为一个单一的文件进行解析。它通常用于API接口，客户端直接将文件内容作为请求体发送，而不使用 multipart/form-data格式。
请求示例
  1. curl -X PUT \
  2.   http://your-api-domain/upload/sample.jpg \  # 文件名可作为URL的一部分
  3.   -H 'Content-Type: image/jpeg' \             # 设置文件的实际MIME类型
  4.   --data-binary '@/path/to/your/file.jpg'
复制代码
视图代码实现
  1. # views.py
  2. from rest_framework.views import APIView
  3. from rest_framework.response import Response
  4. from rest_framework.parsers import FileUploadParser
  5. from rest_framework import status
  7. class SimpleFileUploadView(APIView):
  8.     # 使用 FileUploadParser
  9.     parser_classes = [FileUploadParser]
  11.     def put(self, request, filename, *args, **kwargs): # 注意这里常用 PUT 方法
  12.         # 整个请求体被解析为一个文件对象，可通过 request.data 获取
  13.         uploaded_file = request.data
  15.         # 检查是否有文件数据
  16.         if not uploaded_file:
  17.             return Response(
  18.                 {"error": "No file content"},
  19.                 status=status.HTTP_400_BAD_REQUEST
  20.             )
  22.         # 通常文件名可以从URL参数或请求头中获取，这里假设从URL捕获
  23.         # 处理文件，例如保存
  24.         with open(filename, 'wb+') as destination:
  25.             for chunk in uploaded_file.chunks():
  26.                 destination.write(chunk)
  28.         return Response({
  29.             "message": "File uploaded successfully as single content",
  30.             "filename": filename,
  31.             "size": uploaded_file.size
  32.         }, status=status.HTTP_201_CREATED)
复制代码
2.4 MultiPartParser

用于解析 multipart/form-data类型的请求内容，这是浏览器通过表单上传文件时使用的编码格式。它能够同时处理普通的表单字段和文件字段。
请求示例
  1. curl -X POST \
  2.   http://your-api-domain/upload/ \
  3.   -H 'Content-Type: multipart/form-data' \
  4.   -F 'username=testuser' \
  5.   -F 'file=@/path/to/your/file.jpg'
复制代码
视图实现示例
  1. # views.py
  2. class FileUploadView(APIView):
  3.     # 指定该视图使用的解析器类
  4.     parser_classes = [MultiPartParser]
  6.     def post(self, request, *args, **kwargs):
  7.         # request.data 是一个类似字典的对象，包含所有解析后的表单数据和文件
  8.         # 获取名为 'file' 的文件对象
  9.         uploaded_file = request.data.get('file')
  10.         # 获取名为 'username' 的普通文本字段
  11.         username = request.data.get('username')
  13.         if not uploaded_file:
  14.             return Response(
  15.                 {"error": "No file provided"},
  16.                 status=status.HTTP_400_BAD_REQUEST
  17.             )
  19.         # 处理文件，例如保存到磁盘
  20.         with open(uploaded_file.name, 'wb+') as destination:
  21.             for chunk in uploaded_file.chunks():
  22.                 destination.write(chunk)
  24.         # 返回成功响应
  25.         return Response({
  26.             "message": "File uploaded successfully",
  27.             "filename": uploaded_file.name,
  28.             "username": username,
  29.             "size": uploaded_file.size
  30.         }, status=status.HTTP_201_CREATED)
复制代码
3、自定义解释器

创建自定义解析器需要继承 BaseParser 并实现 parse 方法
  1. from rest_framework.parsers import BaseParser
  2. import xml.etree.ElementTree as ET
  4. class XMLParser(BaseParser):
  5.     """
  6.     自定义 XML 解析器
  7.     """
  8.     media_type = 'application/xml'  # 处理的 Content-Type
  9.    
  10.     def parse(self, stream, media_type=None, parser_context=None):
  11.         """
  12.         将 XML 流解析为 Python 字典
  13.         """
  14.         parser_context = parser_context or {}
  15.         encoding = parser_context.get('encoding', 'utf-8')
  16.         
  17.         try:
  18.             # 读取并解析 XML
  19.             xml_text = stream.read().decode(encoding)
  20.             root = ET.fromstring(xml_text)
  21.             return self._xml_to_dict(root)
  22.         except ET.ParseError as e:
  23.             from rest_framework.exceptions import ParseError
  24.             raise ParseError(f'XML parse error - {e}')
  25.    
  26.     def _xml_to_dict(self, element):
  27.         """
  28.         将 XML 元素转换为字典
  29.         """
  30.         result = {}
  31.         for child in element:
  32.             if len(child) == 0:
  33.                 result[child.tag] = child.text
  34.             else:
  35.                 result[child.tag] = self._xml_to_dict(child)
  36.         return result
复制代码
4、配置使用

4.1 全局配置

在 settings.py 中设置默认解析器，默认为JSONParser，FormParser，MultiPartParser
  1. # settings.py
  2. REST_FRAMEWORK = {
  3.     'DEFAULT_PARSER_CLASSES': [
  4.         'rest_framework.parsers.JSONParser',
  5.         'rest_framework.parsers.FormParser',
  6.         'rest_framework.parsers.MultiPartParser',
  7.     ],
  8. }
复制代码
4.2 视图级配置
  1. class FlexibleParserView(APIView):
  2.     parser_classes = [JSONParser, FormParser, MultiPartParser]
  3.    
  4.     def post(self, request):
  5.         return Response({
  6.             "data": request.data,
  7.             "content_type": request.content_type
  8.         })
  11. @api_view(['POST'])
  12. @parser_classes([JSONParser])
  13. def json_only_view(request):
  14.     return Response({"data": request.data})
复制代码
5、解析器选择流程

DRF 通过内容协商来选择解析器，也就是根据media_type选择
  1. # rest_framework/request.py
  3. class Request:
  4.     def __init__(self, request, parsers=None, authenticators=None, negotiator=None, parser_context=None):
  5.         self.parsers = parsers or ()
  7.     @property
  8.     def data(self):
  9.         if not _hasattr(self, '_full_data'):
  10.             with wrap_attributeerrors():
  11.                 self._load_data_and_files()
  12.         return self._full_data      
  14.     def _load_data_and_files(self):
  15.         # 只加载一次
  16.         if not _hasattr(self, '_data'):
  17.             # 解析数据
  18.             self._data, self._files = self._parse()
  19.    
  20.     def _parse(self):
  21.         # 获取内容类型
  22.         media_type = self.content_type
  23.         #  # 选择解析器
  24.         parser = self.negotiator.select_parser(self, self.parsers)
  25.         # 使用选择的解析器进行解析
  26.         parsed = parser.parse(stream, media_type, self.parser_context)
  27.         return (parsed.data, parsed.files)
复制代码
来源：豆瓜网用户自行投稿发布，如果侵权，请联系站长删除
DRF解析

使用道具 举报

相关推荐
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 | 立即注册
发帖
癖艺泣
昨天 13:59

0

粉丝关注

15

主题发布

板块介绍填写区域，请于后台编辑
微信扫一扫