django怎么返回json

Django如何返回JSON数据：从基础到高级实践

在Web开发中，JSON（JavaScript Object Notation）已成为前后端数据交换的主流格式，Django作为Python的重量级Web框架，提供了多种方式来返回JSON响应，本文将详细介绍Django中返回JSON数据的各种方法，从基础到高级,帮助你选择最适合项目需求的方案。

使用JsonResponse返回JSON

Django的django.http模块提供了JsonResponse类,这是返回JSON数据最直接的方式。

基本用法

from django.http import JsonResponse
from django.views import View
class MyJsonView(View):
    def get(self, request):
        data = {
            'name': 'Django',
            'version': '4.2',
            'features': ['ORM', 'Admin', 'Authentication']
        }
        return JsonResponse(data)

处理非字典数据

JsonResponse默认只能序列化字典类型的数据，如果需要返回其他类型（如列表），需要设置safe=False：

data = [1, 2, 3, 4, 5]
return JsonResponse(data, safe=False)

自定义JSON编码器

对于复杂对象（如日期时间、自定义类实例）,可以自定义JSON编码器：

from django.http import JsonResponse
from datetime import datetime
class CustomJsonEncoder(json.JSONEncoder):
    def default(self, obj):
        if isinstance(obj, datetime):
            return obj.strftime('%Y-%m-%d %H:%M:%S')
        return super().default(obj)
data = {
    'current_time': datetime.now()
}
return JsonResponse(data, encoder=CustomJsonEncoder)

使用DRF（Django REST Framework）

对于复杂的API项目，Django REST Framework（DRF）提供了更强大和灵活的JSON响应处理能力。

安装DRF

pip install djangorestframework

配置settings.py

INSTALLED_APPS = [
    ...
    'rest_framework',
]

使用Serializer和APIView

from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import serializers
class ProductSerializer(serializers.Serializer):
    id = serializers.IntegerField()
    name = serializers.CharField(max_length=100)
    price = serializers.FloatField()
class ProductView(APIView):
    def get(self, request):
        products = [
            {'id': 1, 'name': 'Laptop', 'price': 999.99},
            {'id': 2, 'name': 'Phone', 'price': 699.99}
        ]
        serializer = ProductSerializer(products, many=True)
        return Response(serializer.data)

使用ModelViewSet

from rest_framework import viewsets
from .models import Product
from .serializers import ProductSerializer
class ProductViewSet(viewsets.ModelViewSet):
    queryset = Product.objects.all()
    serializer_class = ProductSerializer

使用Django模板返回JSON

虽然不常见,但有时你可能需要通过模板系统返回JSON数据：

from django.http import HttpResponse
from django.template import loader
def json_view(request):
    data = {'message': 'Hello from template'}
    template = loader.get_template('json_template.html')
    context = {'data': data}
    return HttpResponse(template.render(context, request), content_type='application/json')

对应的模板文件json_template.html：

{{ data|json_script:"json-data" }}

处理JSON响应的最佳实践

状态码管理：始终使用适当的HTTP状态码

return JsonResponse({'error': 'Not found'}, status=404)

错误处理：统一错误响应格式

try:
    # 业务逻辑
except Exception as e:
    return JsonResponse({'error': str(e)}, status=400)

性能优化：对于大型数据集，考虑使用django.core.serializers或pandas进行高效序列化
安全性：避免直接将用户输入序列化为JSON，防止JSON注入攻击

高级技巧

流式JSON响应

对于大型数据集,可以使用流式响应：

from django.http import StreamingHttpResponse
import json
def large_json_response(request):
    def generate():
        data = {'items': []}
        for i in range(10000):
            data['items'].append({'id': i, 'value': f'item_{i}'})
            yield json.dumps(data) + '\n'
    return StreamingHttpResponse(generate(), content_type='application/json')

结合缓存

from django.views.decorators.cache import cache_page
from django.http import JsonResponse
@cache_page(60 * 15)  # 缓存15分钟
def cached_json_view(request):
    data = {'cached_data': 'This data is cached'}
    return JsonResponse(data)

Django提供了多种返回JSON数据的方式：