Django中使用Json返回数据详解

在一个网站在,大量数据与前端交互,JSON是最好的传递数据方式了。

在Django中,使用JSON传输数据,有两种方式,一种是使用Python的JSON包,一种是使用Django的JsonResponse

方法一:使用Python的JSON包

from django.shortcuts import HttpResponse
import json
def testjson(request):
    data={
        'patient_name': '唐伯虎',
        'age': '25',
        'patient_id': '19000347',
        '诊断': '相思问题'
    }
    return HttpResponse(json.dumps(data))
 我们暂且把data看成是从数据库取出来的数据,使用浏览器访问一下testjson

浏览器显示的结果如下:

{"patient_name": "\u5510\u4f2f\u864e", "age": "25", "patient_id": "19000347", "\u8bca\u65ad": "\u76f8\u601d\u95ee\u9898"}

咦,怎么是乱码了?有中文的都是乱码了?

不着急,这不是乱码,这是中文在内存中的二进制表现形式而已,使用JSON的转换工具可以看到中文的。

我们看一下Response Headers响应头,Content-Type:text/html; charset=utf-8,我明明传的是JSON啊,怎么会变成字符串类型了?

这是因为我们没有告诉浏览器,我们要传一个JSON数据,那么,怎么告诉浏览器呢?

HttpResponse是继承HttpResponseBase的,我们可以告诉浏览器,我要传application/json数据。我们稍微改一下Content-Type的值,看看会变成什么?

from django.shortcuts import HttpResponse
import json
def testjson(request):
    data={
        'patient_name': '唐伯虎',
        'age': '25',
        'patient_id': '19000347',
        '诊断': '相思问题'
    }
    return HttpResponse(json.dumps(data), content_type='application/json')

再刷新网页:

这下好了,是传输JSON了,在Preview中可以正常显示出来了。

方法二:使用JsonResponse进行传输。

from django.shortcuts import HttpResponse
import json
def testjson(request):
    data={
        'patient_name': '唐伯虎',
        'age': '25',
        'patient_id': '19000347',
        '诊断': '相思问题'
    }
    return JsonResponse(json.dumps(data))

访问网页:

 嗯,一切正常。

看一下JsonResponse的源码:

class JsonResponse(HttpResponse):
    """
    An HTTP response class that consumes data to be serialized to JSON.

    :param data: Data to be dumped into json. By default only ``dict`` objects
      are allowed to be passed due to a security flaw before EcmaScript 5. See
      the ``safe`` parameter for more information.
    :param encoder: Should be a json encoder class. Defaults to
      ``django.core.serializers.json.DjangoJSONEncoder``.
    :param safe: Controls if only ``dict`` objects may be serialized. Defaults
      to ``True``.
    :param json_dumps_params: A dictionary of kwargs passed to json.dumps().
    """

    def __init__(self, data, encoder=DjangoJSONEncoder, safe=True,
                 json_dumps_params=None, **kwargs):
        if safe and not isinstance(data, dict):
            raise TypeError(
                'In order to allow non-dict objects to be serialized set the '
                'safe parameter to False.'
            )
        if json_dumps_params is None:
            json_dumps_params = {}
        kwargs.setdefault('content_type', 'application/json')
        data = json.dumps(data, cls=encoder, **json_dumps_params)
        super().__init__(content=data, **kwargs)

其内部也是通过json.dumps来把数据转换为JSON的,其还可以转换为list类型。我们再来改一下testjson

def testjson(request):
    lidata=['唐伯虎','25','19000347','相思问题']
    return JsonResponse(lidata)

 程序报错了

TypeError at /cases/testjson
In order to allow non-dict objects to be serialized set the safe parameter to False.
Request Method:	GET
Request URL:	http://127.0.0.1:8000/cases/testjson
Django Version:	3.1.3
Exception Type:	TypeError
Exception Value:	
In order to allow non-dict objects to be serialized set the safe parameter to False.
Exception Location:	G:\xinbiancheng.cn\article\lib\site-packages\django\http\response.py, line 561, in __init__
Python Executable:	G:\xinbiancheng.cn\article\Scripts\python.exe
Python Version:	3.7.7

报错为:In order to allow non-dict objects to be serialized set the safe parameter to False,它的意思是转换为一个非字典的类型时,safe参数要设置为False,还记得上面JsonResponse的源代码吗?其中就有

if safe and not isinstance(data, dict):

有一个条件是 safe 和 判断是否是字典类型,如果不是字典就抛出异常。我们把 safe设为False,不就不会抛出异常吗?我们修改代码试试

代码修改为:

def testjson(request):
    lidata=['唐伯虎','25','19000347','相思问题']
    return JsonResponse(lidata,safe=False)

嗯,这下正常了。

这有什么用呢?有时我们从数据库取出来的数据,很多是列表类型的,特别是用cx_Oracle包在Oracle数据库取出来的数据,其不支持直接字典的输出,输出就是一个list,这时我们使用JsonResponse(data, safe=False)就可以直接输换为Json,发送到前端了。