29.渲染器Renderer

什么是渲染器

    渲染器就是将服务器生成的数据格式转为http请求的格式

 

渲染器触发及参数配置

在DRF配置参数中，可用的渲染器作为一个类的列表进行定义
但与解析器不同的是，渲染器的列表是有顺序关系的
REST框架将对传入请求执行内容协商，根据请求的类型确定最合适的渲染器以满足类型要求
内容协商过程会检查请求头部的 Accept 属性，以确定客户期望的媒体类型。
URL上的格式后缀可用于显式地请求特定的内容类型

 

# DEFAULT_RENDERER_CLASSES 设置全局渲染器集合
# Django默认的渲染器
REST_FRAMEWORK = {
'DEFAULT_RENDERER_CLASSES': (
'rest_framework.renderers.JSONRenderer',
'rest_framework.renderers.BrowsableAPIRenderer',
)
}

局部指定渲染器

单独指定的优先级高于全局的解析器配置,单独指定什么，就只能用什么渲染器

 

# 类属性指定
class TestApi(APIView):
   # 通过renderer_classes指定该视图的渲染器，值是一个元组or list
    renderer_classes = (JSONRenderer,)
    def post(self, request):
        return Response('xxx')

 

#函数装饰器指定
from rest_framework.decorators import parser_classes
@api_view(['POST'])
@renderer_classes((JSONRenderer,))
def testApi(request):
    ...

 

渲染器类的顺序

指定渲染器类时，要考虑清楚为每种媒体类型分配什么样的优先级
如果客户端未明确指定它可以接受的内容类型，例如发送 Accept: */* 属性值，或者根本没有Accept 属性值
那么REST框架将选择settings列表中的第一个渲染器用于渲染响应内容
如果包含可根据请求的不同，同时提供常规网页和API响应的视图，可以使用TemplateHTMLRenderer 作为默认渲染器

渲染器区别

JSONRenderer

使用utf-8编码将响应内容渲染为json格式的数据。

TemplateHTMLRenderer

使用Django的标准模板渲染器将数据渲染为HTML格式

与其他渲染器不同，此时传递给Response 的数据不需要序列化 可能还要使用 template_name 参数，指定你要渲染的HTML模板 TemplateHTMLRenderer使用 response.data 作为上下文字典创建 RequestContext ，并确定要使用哪个模板

模板的查询规则   

                        1. 显式指定的 template_name 参数

                        2. 在TemplateHTMLRenderer上显式设置的 .template_name 属性

                        3. view.get_template_names() 方法调用的返回结果

StaticHTMLRenderer

一个简单的渲染器，只返回渲染好的HTML内容数据 与其他渲染器不同，传递给响应对象的数据应该是要返回内容的字符串形式

BrowsableAPIRenderer

可以将数据渲染为HTML页面，提供可浏览的API页面

AdminRenderer

将数据渲染为类似管理员后台界面的HTML页面 具有嵌套序列化器或序列化器列表的视图将无法正常使用 AdminRenderer

HTMLFormRenderer

将序列化程序返回的数据呈现为HTML表单 此渲染器的输出不包括封闭的 <form></form> 标签，隐藏的CSRF标签或任何提交按钮

MultiPartRenderer

渲染HTML分成多个部分的表单数据 不适合作为响应的渲染器 用于创建测试请求，使用REST框架的测试客户端和测试请求工厂方法

自定义渲染器

自定义渲染器，首先要继承 BaseRenderer 类

设置 .media_type 和 .format 属性

重写.render(self, data, media_type=None, renderer_context=None) 方法

render()方法应返回一个bytestring对象，它将用作HTTP响应的主体

.render() 参数：

         data，请求数据，由 Response() 实例化

         media_type=None，可选参数

         如果提供，则是内容协商的媒体类型

         renderer_context=None，可选参数,如果提供，则是由视图提供的上下文信息的字典。。

from django.utils.encoding import smart_unicode
from rest_framework import renderers

class PlainTextRenderer(renderers.BaseRenderer):
     media_type = 'text/plain'
     format = 'txt'
     #默认情况下，渲染器使用UTF-8 编码，要使用其他编码，设置charset
     #charset = 'xxx'
     def render(self, data, media_type=None, renderer_context=None):
          return data.encode(self.charset)

 

'''
如果希望渲染器同时支持一系列媒体类型。在这种情况下，可以将media_type 设置为 */*
未指定渲染器的媒体类型，则应确保在使用该 content_type 属性返回响应时明确指定媒体类型
    return Response(data, content_type='image/png')
'''