DRF渲染器

在 Django REST Framework (DRF) 中，渲染器（Renderer）是负责将 API 响应数据转换成不同格式（如 JSON、HTML、XML 等）的组件。渲染器决定了 API 的输出格式，因此理解和正确配置渲染器对于构建灵活和可扩展的 API 是至关重要的。以下是关于 DRF 渲染器的详细介绍。

默认渲染器

DRF 默认使用 JSONRenderer 来将响应数据渲染为 JSON 格式。这对于大多数 RESTful API 是非常合适的，因为 JSON 是一种广泛使用的数据交换格式。

# settings.py
REST_FRAMEWORK = {
    'DEFAULT_RENDERER_CLASSES': (
        'rest_framework.renderers.JSONRenderer',
    ),
}

常用渲染器

除了默认的 JSONRenderer 外，DRF 还提供了其他一些常用的渲染器：

BrowsableAPIRenderer：用于渲染可浏览的 API 页面，这对于开发和调试非常有用。
TemplateHTMLRenderer：用于渲染 HTML 模板，这在需要返回 HTML 响应的情况下非常有用。
XMLRenderer：用于渲染 XML 格式的响应数据。
YAMLRenderer：用于渲染 YAML 格式的响应数据。

配置渲染器

你可以在全局配置文件中配置渲染器，也可以在具体的视图或视图集上配置渲染器。

全局配置

在全局配置中设置默认的渲染器类：

# settings.py
REST_FRAMEWORK = {
    'DEFAULT_RENDERER_CLASSES': (
        'rest_framework.renderers.JSONRenderer',
        'rest_framework.renderers.BrowsableAPIRenderer',
    ),
}

视图级别配置

你可以在具体的视图或视图集中覆盖默认的渲染器配置：

from rest_framework import generics
from rest_framework.renderers import JSONRenderer, TemplateHTMLRenderer
from .models import MyModel
from .serializers import MyModelSerializer

class MyModelDetail(generics.RetrieveAPIView):
    queryset = MyModel.objects.all()
    serializer_class = MyModelSerializer
    renderer_classes = [JSONRenderer, TemplateHTMLRenderer]

    def get(self, request, *args, **kwargs):
        instance = self.get_object()
        serializer = self.get_serializer(instance)
        return Response(serializer.data, template_name='my_template.html')

自定义渲染器

有时你可能需要创建自定义渲染器来处理特定的响应格式。自定义渲染器需要继承 BaseRenderer 并实现 render 方法。

from rest_framework.renderers import BaseRenderer

class PlainTextRenderer(BaseRenderer):
    media_type = 'text/plain'
    format = 'txt'

    def render(self, data, accepted_media_type=None, renderer_context=None):
        return str(data).encode(self.charset)

在视图或全局配置中使用自定义渲染器：

# settings.py
REST_FRAMEWORK = {
    'DEFAULT_RENDERER_CLASSES': (
        'path.to.PlainTextRenderer',
    ),
}

基于请求的内容协商

DRF 支持基于请求的内容协商，客户端可以通过在请求头中指定 Accept 来选择期望的响应格式。

GET /api/resource/ HTTP/1.1
Host: example.com
Accept: application/json

示例项目配置

以下是一个示例项目配置，展示了如何使用多种渲染器：

# settings.py
REST_FRAMEWORK = {
    'DEFAULT_RENDERER_CLASSES': (
        'rest_framework.renderers.JSONRenderer',
        'rest_framework.renderers.BrowsableAPIRenderer',
        'rest_framework.renderers.TemplateHTMLRenderer',
        'rest_framework.renderers.XMLRenderer',
        'path.to.PlainTextRenderer',
    ),
}

在视图中：

from rest_framework import generics
from rest_framework.renderers import JSONRenderer, TemplateHTMLRenderer, XMLRenderer
from .models import MyModel
from .serializers import MyModelSerializer

class MyModelDetail(generics.RetrieveAPIView):
    queryset = MyModel.objects.all()
    serializer_class = MyModelSerializer
    renderer_classes = [JSONRenderer, TemplateHTMLRenderer, XMLRenderer]

    def get(self, request, *args, **kwargs):
        instance = self.get_object()
        serializer = self.get_serializer(instance)
        return Response(serializer.data, template_name='my_template.html')

通过上述配置和视图，客户端可以通过指定不同的 Accept 请求头来获取不同格式的响应：

Accept: application/json 返回 JSON 格式的数据。
Accept: text/html 返回 HTML 页面。
Accept: application/xml 返回 XML 格式的数据。
Accept: text/plain 返回纯文本数据。

总结

Django REST Framework 提供了强大的渲染器功能，支持多种输出格式，并允许开发者轻松扩展和自定义渲染器。通过正确配置渲染器，可以满足不同客户端的需求，提供灵活的 API 响应格式。希望这些示例和配置方法能够帮助你在项目中更好地使用 DRF 的渲染器功能。