Django怎麼實現檔案下載功能

這次帶給大家Django怎麼實現檔案下載功能，Django實作檔案下載功能的注意事項有哪些，以下就是實戰案例，一起來看一下。

基於Django建立的網站，如果提供檔案下載功能，最簡單的方式莫過於將靜態檔案交給Nginx等處理，但有些時候，由於網站本身邏輯，需要透過Django提供下載功能，如頁面資料匯出功能（下載動態產生的檔案）、先檢查使用者權限再下載檔案等。因此，有必要研究一下檔案下載功能在Django中的實作。

最簡單的檔案下載功能的實作

將檔案流放入HttpResponse物件即可，如：

def file_download(request):
  # do something...
  with open('file_name.txt') as f:
    c = f.read()
  return HttpResponse(c)

這種方式簡單粗暴，適合小檔案的下載，但如果這個檔案非常大，這種方式會佔用大量的內存，甚至導致伺服器崩潰

更合理的檔案下載功能

Django的HttpResponse物件允許將迭代器作為傳入參數，將上面程式碼中的傳入參數c換成一個迭代器，便可以將上述下載功能優化為對大小檔均適合；而Django更進一步，推薦使用StreamingHttpResponse物件取代HttpResponse對象，StreamingHttpResponse物件用於將檔案流傳送給瀏覽器，與HttpResponse物件非常相似，對於檔案下載功能，使用StreamingHttpResponse物件更合理。

因此，更合理的檔案下載功能，應該先寫一個迭代器，用於處理檔案，然後將這個迭代器作為參數傳遞給StreaminghttpResponse對象，如：

from django.http import StreamingHttpResponse
def big_file_download(request):
  # do something...
 
  def file_iterator(file_name, chunk_size=512):
    with open(file_name) as f:
      while True:
        c = f.read(chunk_size)
        if c:
          yield c
        else:
          break
 
  the_file_name = "file_name.txt"
  response = StreamingHttpResponse(file_iterator(the_file_name))
 
  return response

檔案下載功能再次優化

# 上述的程式碼，已經完成了將伺服器上的文件，透過文件流傳輸到瀏覽器，但文件流通常會以亂碼形式顯示到瀏覽器中，而非下載到硬碟上，因此，還要在做點優化，讓檔案流寫入硬碟。最佳化很簡單，給StreamingHttpResponse物件的Content-Type和Content-Disposition欄位賦下面的值即可，如：

response['Content-Type'] = 'application/octet-stream'
response['Content-Disposition'] = 'attachment;filename="test.pdf"'

完整程式碼如下：

from django.http import StreamingHttpResponse
def big_file_download(request):
  # do something... 
  def file_iterator(file_name, chunk_size=512):
    with open(file_name) as f:
      while True:
        c = f.read(chunk_size)
        if c:
          yield c
        else:
          break
 
  the_file_name = "big_file.pdf"
  response = StreamingHttpResponse(file_iterator(the_file_name))
  response['Content-Type'] = 'application/octet-stream'
  response['Content-Disposition'] = 'attachment;filename="{0}"'.format(the_file_name) 
  return response

具體匯出檔案格式

# 匯出Excel表格

# 1. 首先是直接匯出Excel表格

首先取得要匯出的資料、以列表方式儲存。

然後將資料寫入到Excel，以串流的方式返回頁面下載。

import xlwt
import io
import json
from django.http import HttpResponse
def set_style(name, height, bold=False):
  style = xlwt.XFStyle() # 初始化样式
  font = xlwt.Font() # 为样式创建字体
  font.name = name # 'Times New Roman'
  font.bold = bold
  font.color_index = 000
  font.height = height
  style.font = font
  # 设置单元格边框
  # borders= xlwt.Borders()
  # borders.left= 6
  # borders.right= 6
  # borders.top= 6
  # borders.bottom= 6
  # style.borders = borders
  # 设置单元格背景颜色
  # pattern = xlwt.Pattern()
  # 设置其模式为实型
  # pattern.pattern = pattern.SOLID_PATTERN
  # 设置单元格背景颜色
  # pattern.pattern_fore_colour = 0x00
  # style.pattern = pattern
  return style
def write_excel(data, name, header):
  # 打开一个Excel工作簿
  file = xlwt.Workbook()
  # 新建一个sheet，如果对一个单元格重复操作，会引发异常，所以加上参数cell_overwrite_ok=True
  table = file.add_sheet(name, cell_overwrite_ok=True)
  if data is None:
    return file
  # 写标题栏
  row0 = [u'业务', u'状态', u'北京', u'上海', u'广州', u'深圳', u'状态小计']
  for i in range(0, len(row0)):
    table.write_merge(0, 0, i, i, row0[i], set_style('Times New Roman', 220, True))
  table.write_merge(0, 2, 7, 9, "单元格合并", set_style('Times New Roman', 220, True))
  """
  table.write_merge(x, x + m, y, w + n, string, sytle)
x表示行，y表示列，m表示跨行个数，n表示跨列个数，string表示要写入的单元格内容，style表示单元格样式。其中，x，y，w，h，都是以0开始计算的。
  """
  l = 0
  n = len(header)
  # 写入数据
  for line in data:
    for i in range(n):
      table.write(l, i, line[header[i]])
    l += 1
  # 直接保存文件
  # file.save("D:/excel_name.xls")
  # 写入IO
  res = get_excel_stream(file)
  # 设置HttpResponse的类型
  response = HttpResponse(content_type='application/vnd.ms-excel')
  from urllib import parse
  response['Content-Disposition'] = 'attachment;filename=' + parse.quote("excel_name") + '.xls'
  # 将文件流写入到response返回
  response.write(res)
  return response
def get_excel_stream(file):
  # StringIO操作的只能是str，如果要操作二进制数据，就需要使用BytesIO。
  excel_stream = io.BytesIO()
  # 这点很重要，传给save函数的不是保存文件名，而是一个BytesIO流（在内存中读写）
  file.save(excel_stream)
  # getvalue方法用于获得写入后的byte将结果返回给re
  res = excel_stream.getvalue()
  excel_stream.close()
  return res

2. 匯出json檔案

匯出json檔案不像Excel那麼麻煩，只需要拼接json格式資料即可，直接匯出到本機還是很簡單，但是匯出到網頁，怎麼像匯出excel一樣不儲存到本機，直接將串流回傳？

def write_json(data):
  try:
    json_stream = get_json_stream(data)
    response = HttpResponse(content_type='application/json')
    from urllib import parse
    response['Content-Disposition'] = 'attachment;filename=' + parse.quote("test") + '.json'
    response.write(json_stream)
    return response
  except Exception as e:
    print(e)
def get_json_stream(data):
  # 开始这里我用ByteIO流总是出错，但是后来参考廖雪峰网站用StringIO就没问题
  file = io.StringIO()
  data = json.dumps(data)
  file.write(data)
  res = file.getvalue()
  file.close()
  return res

3. 匯出壓縮套件

由於匯出兩個文件無法同時都返回，所以考慮將這兩個文件放入包中，然後將包以流的方式返回。

思考？此時匯出的是zip套件中，我要怎麼將這兩個檔案流寫入zip中，好像有點不太合理。後來在老闆指導下先將要打包的檔案儲存到本地，打包到zip後，將本地的檔案刪除，隨後將該zip檔案流讀取，寫入到response，並返回zip檔案流。

def write_zip(e_data, j_data, export_name):
  try:
    # 保存到本地文件
    # 返回文件名，注意此时保存的方法和前面导出保存的json、excel文件区别
    j_name = write_json(j_data, export_name[1])
    e_name = write_excel(e_data, export_name[1])
    # 本地文件写入zip，重命名，然后删除本地临时文件
    z_name='export.zip'
    z_file = zipfile.ZipFile(z_name, 'w')
    z_file.write(j_name)
    z_file.write(e_name)
    os.remove(j_name)
    os.remove(e_name)
    z_file.close()
    # 再次读取zip文件，将文件流返回,但是此时打开方式要以二进制方式打开
    z_file = open(z_name, 'rb')
    data = z_file.read()
    z_file.close()
    os.remove(z_file.name)
    response = HttpResponse(data, content_type='application/zip')
    from urllib import parse
    response['Content-Disposition'] = 'attachment;filename=' + parse.quote(z_name)
    return response
  except Exception as e:
    logging.error(e)
    print(e)

我相信看了本文案例你已經掌握了方法，更多精彩請關注php中文網其它相關文章！

推薦閱讀：

vue使用xe-utils函數庫的步奏詳解

vue2.0 路由不顯示router-view如何處理

Native怎麼使用fetch實作圖片上傳功能

以上是Django怎麼實現檔案下載功能的詳細內容。更多資訊請關注PHP中文網其他相關文章！