「Django REST Framework 框架」Renderers渲染器解析及应用举例

谁借莪１个温暖的怀抱￠ 2023-01-10 03:40 161阅读 0赞

### 文章目录 ###

*  内容介绍
 *  Renderers渲染器
 *  应用举例

# 内容介绍 #

开发环境为 Python3.6，Django 版本 3.0.x ，REST Framework 版本 3.12.x

全部内容索引目录  
**[看懂Django框架，没有最好只有更好][Django]**

结合前端模板进行数据渲染，可视化目标。

# Renderers渲染器 #

**1.项目配置**

# 项目settings.py中的全局设置
    REST_FRAMEWORK = { 
        'DEFAULT_RENDERER_CLASSES': [
            'rest_framework.renderers.JSONRenderer',
            'rest_framework.renderers.BrowsableAPIRenderer',
        ]
    }

**2.项目非全局设置（不推荐）**

# 方式 1
    from django.contrib.auth.models import User
    from rest_framework.renderers import JSONRenderer
    from rest_framework.response import Response
    from rest_framework.views import APIView
    
    class UserCountView(APIView):
        """ Json显示获取用户的count值 """
        renderer_classes = [JSONRenderer]
    
        def get(self, request, format=None):
            user_count = User.objects.filter(active=True).count()
            content = { 'user_count': user_count}
            return Response(content)

# 方式 2
    @api_view(['GET'])
    @renderer_classes([JSONRenderer])
    def user_count_view(request, format=None):
        """ Json显示获取用户的count值 """
        user_count = User.objects.filter(active=True).count()
        content = { 'user_count': user_count}
        return Response(content)

**3.渲染器布局**

<table> 
 <thead> 
  <tr> 
   <th align="center">渲染器类</th> 
   <th>渲染类型</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">JSONRenderer</td> 
   <td>application/json</td> 
   <td align="left">将返回数据渲染成 JSON 数据样式, 并且你可以使用 indent 媒体类型参数制定你的缩进方式, 例如 Accept: application/json; indent=4</td> 
  </tr> 
  <tr> 
   <td align="center">TemplateHTMLRenderer</td> 
   <td>text/html</td> 
   <td align="left">使用 Django 模板数据返回时, 将返回 HTML 类型数据, 并与其他返回数据不一样的是, 使用此渲染器返回数据不需要序列化, 但是在你创建并返回 Response 实例对象时需要制定 template_name 关键字参数</td> 
  </tr> 
  <tr> 
   <td align="center">StaticHTMLRenderer</td> 
   <td>text/html</td> 
   <td align="left">一个将渲染的 HTML 作为字符渲染的方式传递的渲染器</td> 
  </tr> 
  <tr> 
   <td align="center">BrowsableAPIRenderer</td> 
   <td>text/html</td> 
   <td align="left">将数据呈现为 Browsable API 的 HTML</td> 
  </tr> 
  <tr> 
   <td align="center">AdminRenderer</td> 
   <td>text/html</td> 
   <td align="left">该渲染器适用于 CRUD 样式的 WebAPI, 这些 API 也应提供用户友好的界面来管理数据</td> 
  </tr> 
  <tr> 
   <td align="center">HTMLFormRenderer</td> 
   <td>text/html</td> 
   <td align="left">将序列化数据呈现为 HTML, 次渲染器的输出不包含封闭的 标签以及隐藏的 CSRF 输入或任何提交按钮</td> 
  </tr> 
  <tr> 
   <td align="center">MultiPartRenderer</td> 
   <td>multipart/form-data; boundary=BoUnDaRyStRiNg</td> 
   <td align="left">该渲染器用于渲染 HTML 多部分表单数据, 它不适合用作响应渲染器, 而是用于使用 REST 框架的测试客户端和测试请求工厂创建测试请求</td> 
  </tr> 
 </tbody> 
</table>

# 应用举例 #

**1. JSONRenderer**

{ 
        "unicode black star": "★",
        "value": 999
    }

**2. TemplateHTMLRenderer**

class UserDetail(generics.RetrieveAPIView):
        """ 返回给定用户的模板HTML表示的视图。 """
        queryset = User.objects.all()
        renderer_classes = [TemplateHTMLRenderer]
    
        def get(self, request, *args, **kwargs):
            self.object = self.get_object()
            return Response({ 'user': self.object}, template_name='user_detail.html')

**3. StaticHTMLRenderer**

@api_view(['GET'])
    @renderer_classes([StaticHTMLRenderer])
    def simple_html_view(request):
        data = '<html><body><h1>Hello, world</h1></body></html>'
        return Response(data)

**4. BrowsableAPIRenderer**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMjg4MzI3_size_16_color_FFFFFF_t_70]  
**5. AdminRenderer**  
带有嵌套或列表化序列器作为其输入的视图将不适用于 AdminRenderer，因为 HTML 表单无法正确支持并且当你的数据中配置了正确的 URL\_FIELD\_NAME 属性时才能够正确的指向详情信息页的链接。

class AccountSerializer(serializers.ModelSerializer):
        url = serializers.CharField(source='get_absolute_url', read_only=True)
    
        class Meta:
            model = Account

**6. HTMLFormRenderer**  
不能直接使用此渲染器, 而是可以通过将序列化实例对象传递给 render\_form 模板标签在模板中使用。

{ % load rest_framework %}
    
    <form action="/submit-report/" method="post">
        { % csrf_token %}
        { % render_form serializer %}
        <input type="submit" value="Save" />
    </form>

**7.第三方组件 YAML**

# 安装
    pip install djangorestframework-yaml
    
    # 数据以 YAML 语法作为支持和返回， 在 settings.py 中调整
    REST_FRAMEWORK = { 
        'DEFAULT_PARSER_CLASSES': [
            'rest_framework_yaml.parsers.YAMLParser'，
        ]，
        'DEFAULT_RENDERER_CLASSES': [
            'rest_framework_yaml.renderers.YAMLRenderer'，
        ]，
    }

*  **8.第三方组件 XML**

# 安装
    pip install djangorestframework-xml
    
    # 数据以 XML 语法作为支持和返回， 在 settings.py 中调整
    REST_FRAMEWORK = { 
        'DEFAULT_PARSER_CLASSES': [
            'rest_framework_xml.parsers.XMLParser'，
        ]，
        'DEFAULT_RENDERER_CLASSES': [
            'rest_framework_xml.renderers.XMLRenderer'，
        ]，
    }

**9.第三方组件 JSONP**

# 安装
    pip install djangorestframework-jsonp
    
    # 在 settings.py 中调整
    # 如果需要跨域 AJAX 请求
    # 通常应该使用 CORS 的更现代方法作为的替代方法 JSONP，而该方法本质上是一种浏览器黑客，并且仅适用于全局可读的 API 端点，GET 请求未经身份验证并且不需要任何用户权限。
    REST_FRAMEWORK = { 
        'DEFAULT_RENDERER_CLASSES': [
            'rest_framework_jsonp.renderers.JSONPRenderer'，
        ]，
    }

**10.第三方组件 MessagePack**

# MessagePack 是一种快速高效的二进制序列化格式
    # Juan Riaza 维护 djangorestframework-msgpack 软件包
    # 该软件包为 REST 框架提供 MessagePack 渲染器和解析器支持

**11.第三方组件 XLSX**

# 安装
    pip install drf-renderer-xlsx
    
    # 在 settings.py 中调整
    REST_FRAMEWORK = { 
        ...
    
        'DEFAULT_RENDERER_CLASSES': [
            'rest_framework.renderers.JSONRenderer'，
            'rest_framework.renderers.BrowsableAPIRenderer'，
            'drf_renderer_xlsx.renderers.XLSXRenderer'，
        ]，
    }
    
    # 为了避免流传输的文件没有文件名(浏览器通常将其默认为没有扩展名的 download)
    # 需要使用 mixin 覆盖 Content-Disposition标头
    # 如果未提供文件名则默认为 data.xlsx。
    
    from rest_framework.viewsets import ReadOnlyModelViewSet
    from drf_renderer_xlsx.mixins import XLSXFileMixin
    from drf_renderer_xlsx.renderers import XLSXRenderer
    
    from .models import MyExampleModel
    from .serializers import MyExampleSerializer
    
    class MyExampleViewSet(XLSXFileMixin， ReadOnlyModelViewSet):
        queryset = MyExampleModel.objects.all()
        serializer_class = MyExampleSerializer
        renderer_classes = [XLSXRenderer]
        filename = 'data.xlsx'

**12.第三方组件 CSV**

# 逗号分隔的值是纯文本格式的表格数据格式
    # 可以轻松地导入电子表格应用程序中
    # Mjumbe Poe 维护 djangorestframework-csv 软件包
    # 该软件包为 REST 框架提供 CSV 渲染器支持。

**13.第三方组件 UltraJSON**

# 经过优化的 C JSON 编码器，可以显着加快 JSON 渲染速度
    # Jacob Haslehurst 维护了 drf-ujson-renderer 软件包
    # 该软件包使用 UJSON 软件包实现 JSON 呈现。

**14.第三方组件 Pandas (CSV， Excel， PNG)**

# Django REST Pandas 提供了序列化器和渲染器
    # 支持通过 Pandas DataFrame API 进行其他数据处理和输出
    # Django REST Pandas 包括用于 Pandas 样式 CSV 文件、Excel工作簿(包括 .xls 和 .xlsx)以及许多其他格式的渲染器
    # 由 S. Andrew Sheppard 作为 wq Project 的一部分进行维护。

**15.第三方组件 LaTeX**

# Rest Framework Latex 提供了一个渲染器
    # 该渲染器使用 Laulatex 输出 PDF
    # 由 Pebble (S/F Software) 维护。

[Django]: https://blog.csdn.net/qq_20288327/article/details/117383454
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMjg4MzI3_size_16_color_FFFFFF_t_70]: /images/20221119/a391ca6868a24365941e5452d8a5dd8c.png