为什么我们在Django中扩展HTTPResponse?

时间:2018-07-10 06:14:35

标签: django

我正在看django-jquery-file-upload

这是响应文件

MIMEANY = '*/*'
MIMEJSON = 'application/json'
MIMETEXT = 'text/plain'


def response_mimetype(request):
    """response_mimetype -- Return a proper response mimetype, accordingly to
    what the client accepts, as available in the `HTTP_ACCEPT` header.

    request -- a HttpRequest instance.

    """
    can_json = MIMEJSON in request.META['HTTP_ACCEPT']
    can_json |= MIMEANY in request.META['HTTP_ACCEPT']
    return MIMEJSON if can_json else MIMETEXT


class JSONResponse(HttpResponse):
    """JSONResponse -- Extends HTTPResponse to handle JSON format response.

    This response can be used in any view that should return a json stream of
    data.

    Usage:

        def a_iew(request):
            content = {'key': 'value'}
            return JSONResponse(content, mimetype=response_mimetype(request))

    """
    def __init__(self, obj='', json_opts=None, mimetype=MIMEJSON, *args, **kwargs):
        json_opts = json_opts if isinstance(json_opts, dict) else {}
        content = json.dumps(obj, **json_opts)
        super(JSONResponse, self).__init__(content, mimetype, *args, **kwargs)

我不明白form_valid(views)的构造方式。

def form_valid(self, form):
    self.object = form.save()
    files = [serialize(self.object)]
    data = {'files': files}
    response = JSONResponse(data, mimetype=response_mimetype(self.request))
    response['Content-Disposition'] = 'inline; filename=files.json'
    return response

使用JSON响应而不是HTTPResponse有什么好处?

1 个答案:

答案 0 :(得分:1)

一个JSONResponse实际上是一个HTTPResponse。我们仅为方便程序员而添加了一些默认功能,以使出错更加困难。

class JSONResponse(HttpResponse):

    # ...

    def __init__(self, obj='', json_opts=None, mimetype=MIMEJSON, *args, **kwargs):
        json_opts = json_opts if isinstance(json_opts, dict) else {}
        content = json.dumps(obj, **json_opts)
        super(JSONResponse, self).__init__(content, mimetype, *args, **kwargs)

JSON响应基本上执行两件事:

  1. 它默认将mimetype设置为application/json,这样,如果您自己不提供它,那就是MIME类型,从而浏览器(或消耗响应的其他服务),知道这是JSON响应;
  2. 它会自动以JSON字符串(带有json.dumps(..))转储Pyhon对象。因此,您可以传递字典,而不是传递JSON流,而JSONResponse将确保它生成有效的JSON流。

它还允许将特定参数传递到此转储(json_opts)以稍微改变转储过程(例如,转储非Vanilla Python对象)。

这也使向 all JSON响应添加某些逻辑变得更加容易。例如,如果以后有JSON-2.0标准,那么我们可以重写JSONResponse逻辑,并且所有JSONResponse都将使用新逻辑,而不是在 ad hoc中修补所有出现的问题时尚。

但是对于浏览器来说,根本没有区别,因为它只看到HTTP响应,并填充了一些值。这些值是由应用程序程序员填充还是由Django库填充。

JSON,是 J ava S cript O bject N 前缀,并且是一种流行的格式(例如(例如XML)在应用程序之间传输数据。 JavaScript,Python,Haskell,Java等都具有编码和解码JSON的方法。因此,它通常用于在以不同语言编写的系统之间传输数据(例如,浏览器运行JavaScript,而Django网络服务器运行Python)。

在Django中,有许多代码可以为程序员带来便利。以FormView为例:它将确保程序员不必本身必须初始化Form,等等。这将导致代码更短,更优雅,但同时错误更少(因为通用部分封装在此类中)。