django的HttpResponse对象

本文详细介绍了Django框架中HttpResponse类及其子类的功能与用法,包括如何创建HttpResponse对象、设置响应头、处理不同类型的HTTP响应等。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

HttpResponse objects

class HttpResponse

相对于django自动创建的HttpRequest对象,HttpResponse对象需要去我们自己创建,每个view都也应该返回一个HttpResponse对象,
HttpResponse class在django.http模块中

用处

  1. 传递字符串

    >>> from django.http import HttpResponse
    >>> response = HttpResponse("Here's the text of the Web page.")
    >>> response = HttpResponse("Text only, please.", content_type="text/plain")
    >>>> from django.http import HttpResponse
    >>> response = HttpResponse("Here's the text of the Web page.")
    >>> response = HttpResponse("Text only, please.", content_type="text/plain")
    

2.传递迭代器


属性

  1. HttpResponse.content:bytestring
  2. HttpResponse.charset:字符集
  3. HttpResponse.status_code:status_code
  4. HttpResponse.reason_phrase:
  5. HttpResponse.streaming:总是false
  6. HttpResponse.closed:True if the response has been closed.

方法

  1. HttpResponse.init(content=”, content_type=None, status=200, reason=None, charset=None):
    初始化HttpResponse

    • 参数content:应该是字符串迭代器,如果不是迭代器,将返回字符串,如果都不是的话,将会转成字符串
    • 参数content_type:可选的MIME type
    • 参数status:状态码
    • 参数reason:HTTP response phrase
    • 参数charset:编码字符集
  2. HttpResponse.setitem(header, value):
    设置header和value。字符串

  3. HttpResponse.delitem(header):
    删除指定header
  4. HttpResponse.getitem(header):
    获取指定header
  5. HttpResponse.setdefault(header, value):
    设置指定header,除非已经设置过
  6. HttpResponse.set_cookie(key, value=”, max_age=None, expires=None, path=’/’, domain=None, secure=None, httponly=False):
    设置cookie,参数类似于class http.cookies.Morsel
  7. HttpResponse.set_signed_cookie(key, value, salt=”, max_age=None, expires=None, path=’/’, domain=None, secure=None, httponly=True):类似set_cookie
  8. HttpResponse.delete_cookie(key, path=’/’, domain=None):
  9. HttpResponse.write(content):
  10. HttpResponse.flush():
  11. HttpResponse.tell():
  12. HttpResponse.getvalue():False,返回流对象
  13. HttpResponse.readable():False,返回流对象
  14. HttpResponse.seekable():False,返回流对象
  15. HttpResponse.writable():True,返回流对象
  16. HttpResponse.writelines(lines):字符串列表。,返回流对象

子类

django.http包含许多HttpResponse subclasses,用于处理不同类型的HTTP responses

  1. class HttpResponseRedirect:

    构造函数的第一个参数(重定向的路径)是必须的,可以是全路径,没有域名的绝对路径,或者相似路径,status code = 302.

    `class HttpResponseRedirect(HttpResponseRedirectBase):
        status_code = 302
    `
    
  2. class HttpResponsePermanentRedirect:
    永久重定向,status code = 301

  3. class HttpResponseNotModified:
    构造函数不包含任何参数,页面未发生任何变化,status code = 304

  4. class HttpResponseBadReques:status code = 400

  5. class HttpResponseNotFound:status code = 404
  6. class HttpResponseForbidden:status code = 403
  7. class HttpResponseNotAllowed:status code = 405
    构造函数参数1为:a list of permitted methods(e.g. [‘GET’, ‘POST’]).
  8. class HttpResponseGone:status code = 410
  9. class HttpResponseServerError:status code = 500

JsonResponse

class JsonResponse(data, encoder=DjangoJSONEncoder, safe=True, json_dumps_params=None, **kwargs)
HttpResponse子类,用于创建json格式的response。继承不部分父类的方法,与父类有两点不同:

  • 默认的Content-Type header 设置成application/json.
  • 参数一data,要求是字典类实例,如果safe设置成False,data可以是任意JSON-serializable对象

StreamingHttpResponse

class StreamingHttpResponse
生成流数据,当生成Response需要花费太多时间或者大量内存时使用,比如生成大型csv文件
StreamingHttpResponse并不是HttpResponse的子类,


FileResponse

StreamingHttpResponse的子类,操作作二进制文件,

>>> from django.http import FileResponse
>>> response = FileResponse(open('myfile.png', 'rb'))

文件会自动关闭

### 使用DjangoHttpResponse实现文件下载 在Django中,`HttpResponse`对象可以用来发送HTTP响应给客户端浏览器。要实现在网页上点击链接或按钮触发文件下载功能,可以通过设置合适的MIME类型和头部信息来告知浏览器这是一个待下载的文件而不是直接显示的内容。 对于简单的文本文件或其他纯二进制流形式的小型静态资源来说,在视图函数里创建一个`HttpResponse`实例并填充相应内容即可完成基本操作[^1]: ```python from django.http import HttpResponse import os def download_file(request): file_path = '/path/to/file.txt' if os.path.exists(file_path): with open(file_path, 'rb') as fh: response = HttpResponse(fh.read(), content_type="application/vnd.ms-excel") # 对于Excel文件 response['Content-Disposition'] = 'attachment; filename=' + os.path.basename(file_path) return response else: raise Http404 ``` 这段代码展示了如何读取服务器上的指定路径下的文件,并将其作为附件返回给用户端进行下载。这里特别注意设置了两个重要的属性:一个是`content_type`指定了文件的具体类型;另一个是`Content-Disposition`头用于指示浏览器该文件应被当作附件处理以及建议保存时使用的默认名称。 当涉及到较大的文件或者需要更高效的方式传输大容量数据时,则推荐采用`FileResponse`类替代普通的`HttpResponse`,因为前者支持高效的流式传输机制,能够减少内存占用并提高性能表现。 ```python from django.http import FileResponse def stream_download_largefile(request): filepath = "/path/to/largefile.zip" return FileResponse(open(filepath, 'rb'), as_attachment=True, filename=os.path.basename(filepath)) ``` 此方法适用于任何类型的文件下载场景,无论是图片、文档还是压缩包等形式都可以轻松应对。同时,通过调整参数还可以控制是否强制下载或是允许在线预览等功能特性。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值