文件上传

当 Django 处理文件上传时，文件数据最终会被放置在 request.FILES （关于 request 对象的更多信息，请参见 request 和 response 对象 的文档）。本文档解释了文件如何存储在磁盘和内存中，以及如何自定义默认行为。

警告

如果接收不受信任的用户的上传会有安全隐患， 请阅读 用户上传内容 获取详情。

简单文件上传

考虑一个包含 FileField 的表单：

forms.py

  1. from django import forms
  3. class UploadFileForm(forms.Form):
  4.     title = forms.CharField(max_length=50)
  5.     file = forms.FileField()

处理这个表单的视图将在 request.FILES 中接收文件数据，它是一个字典，包含表单中每个 FileField （或 ImageField，或其他 FileField 子类）的键。所以上述表单中的数据将以 request.FILES['file'] 的形式被访问。

注意 request.FILES 只有当请求方法是 POST，至少有一个文件字段被实际发布，并且发布请求的 <form> 有 enctype="multipart/form-data" 属性时，才会包含数据。否则 request.FILES 将为空。

大多数情况下，你需要像 将上传的文件绑定到表单中 里描述的那样将文件数据从 request 传递给表单。示例如下：

views.py

  1. from django.http import HttpResponseRedirect
  2. from django.shortcuts import render
  3. from .forms import UploadFileForm
  5. # Imaginary function to handle an uploaded file.
  6. from somewhere import handle_uploaded_file
  8. def upload_file(request):
  9.     if request.method == 'POST':
  10.         form = UploadFileForm(request.POST, request.FILES)
  11.         if form.is_valid():
  12.             handle_uploaded_file(request.FILES['file'])
  13.             return HttpResponseRedirect('/success/url/')
  14.     else:
  15.         form = UploadFileForm()
  16.     return render(request, 'upload.html', {'form': form})

注意我们必须将 request.FILES 传入到表单的 构造方法中，只有这样文件数据才能绑定到表单中。

我们通常可能像这样处理上传文件：

  1. def handle_uploaded_file(f):
  2.     with open('some/file/name.txt', 'wb+') as destination:
  3.         for chunk in f.chunks():
  4.             destination.write(chunk)

使用 UploadedFile.chunks() 而不是 read() 是为了确保即使是大文件又不会将我们系统的内存占满。

There are a few other methods and attributes available on UploadedFile objects; see UploadedFile for a complete reference.

通过模型来处理上传的文件

如果想要在 FileField 上的 Model 保存文件，使用 ModelForm 会让这一过程变得简单。当调用 form.save() 时，文件对象将会被保存在对相应 FileField 的 upload_to 参数所指定的地方：

  1. from django.http import HttpResponseRedirect
  2. from django.shortcuts import render
  3. from .forms import ModelFormWithFileField
  5. def upload_file(request):
  6.     if request.method == 'POST':
  7.         form = ModelFormWithFileField(request.POST, request.FILES)
  8.         if form.is_valid():
  9.             # file is saved
  10.             form.save()
  11.             return HttpResponseRedirect('/success/url/')
  12.     else:
  13.         form = ModelFormWithFileField()
  14.     return render(request, 'upload.html', {'form': form})

如果你准备手工构建对象，你可以指定来自 request.FILES 的文件对象到模型里的文件对象：

  1. from django.http import HttpResponseRedirect
  2. from django.shortcuts import render
  3. from .forms import UploadFileForm
  4. from .models import ModelWithFileField
  6. def upload_file(request):
  7.     if request.method == 'POST':
  8.         form = UploadFileForm(request.POST, request.FILES)
  9.         if form.is_valid():
  10.             instance = ModelWithFileField(file_field=request.FILES['file'])
  11.             instance.save()
  12.             return HttpResponseRedirect('/success/url/')
  13.     else:
  14.         form = UploadFileForm()
  15.     return render(request, 'upload.html', {'form': form})

If you are constructing an object manually outside of a request, you can assign a File like object to the FileField:

  1. from django.core.management.base import BaseCommand
  2. from django.core.files.base import ContentFile
  4. class MyCommand(BaseCommand):
  5.     def handle(self, *args, **options):
  6.         content_file = ContentFile(b'Hello world!', name='hello-world.txt')
  7.         instance = ModelWithFileField(file_field=content_file)
  8.         instance.save()

上传多个文件

如果你想使用一个表单字段上传多个文件，则需要设置字段的 widget 的 multiple HTML 属性。

forms.py

  1. from django import forms
  3. class FileFieldForm(forms.Form):
  4.     file_field = forms.FileField(widget=forms.ClearableFileInput(attrs={'multiple': True}))

然后覆盖 FormView 子类的 post 方法来控制多个文件上传：

views.py

  1. from django.views.generic.edit import FormView
  2. from .forms import FileFieldForm
  4. class FileFieldFormView(FormView):
  5.     form_class = FileFieldForm
  6.     template_name = 'upload.html'  # Replace with your template.
  7.     success_url = '...'  # Replace with your URL or reverse().
  9.     def post(self, request, *args, **kwargs):
  10.         form_class = self.get_form_class()
  11.         form = self.get_form(form_class)
  12.         files = request.FILES.getlist('file_field')
  13.         if form.is_valid():
  14.             for f in files:
  15.                 ...  # Do something with each file.
  16.             return self.form_valid(form)
  17.         else:
  18.             return self.form_invalid(form)

上传 Handlers

当一个用户上传文件时，Django 会把文件数据传递给 upload handler —— 这是一个很小的类，它用来在上传时处理文件数据。上传处理模块最初定义在 FILE_UPLOAD_HANDLERS 里，默认为：

  1. ["django.core.files.uploadhandler.MemoryFileUploadHandler",
  2.  "django.core.files.uploadhandler.TemporaryFileUploadHandler"]

MemoryFileUploadHandler 和 TemporaryFileUploadHandler 提供 Django 默认文件上传行为，小文件读入内存，大文件存在磁盘上。

你可以编写自定义的 handlers 来自定义 Django 如何处理文件。比如，你可以使用自定义的 handlers 来强制处理用户层面的配额，动态压缩数据，渲染进度条，甚至可以将数据发送到其他存储地址而不是本地。查看 编写自定义上传处理程序 来了解你如何自定义或者完全替换上传行为。

上传数据的存储

在保存上传的文件之前，数据需要保存到某处。

默认情况下，如果上传的文件小于2.5兆，Django 将把文件的所有内容保存到内存里。这意味着保存文件只涉及从内存中读取和写入磁盘，因此这很快。

但如果上传的文件很大，Django 会把文件写入系统临时目录的临时文件里存储。在类 Unix 平台里这意味着 Django 会生成一个类似名为 /tmp/tmpzfp6I6.upload 的文件。如果上传的文件非常大，你可以查看这个文件的大小增长，因为 Django 将数据流式传输到磁盘上。

2.5 megabytes; /tmp; 等这些细节只是合理的默认值，在下一节要介绍它们如何被自定义。

改变上传处理行为

这里有一些控制 Django 文件上传行为的配置，请查看 File Upload Settings 。

动态修改上传处理程序

有时候某些视图需要不同的上传行为。在这些例子里，你可以基于每个请求覆盖上传处理程序。默认情况下，这个列表将包含由 FILE_UPLOAD_HANDLERS 设置的上传处理程序，但你可以像修改其他列表一样修改这个列表。

比如，假设你正在编写 ProgressBarUploadHandler ，来提供在上传过程中的反馈给 Ajax widget。你需要添加这个处理程序到你的上传处理模块：

  1. request.upload_handlers.insert(0, ProgressBarUploadHandler(request))

你或许想在这里使用 list.insert() （而不是 append() ），因为进度条处理程序需要在其他处理程序之前使用。记住，上传处理程序是按顺序处理的。

如果你想完全替换上传处理程序，你需要指定新列表：

  1. request.upload_handlers = [ProgressBarUploadHandler(request)]

备注

你只能在访问 request.POST 或 request.FILES 之前修改上传处理程序，开始上传处理后修改上传处理程序没有意义。如果你从读取 request.POST 或 request.FILES 之后尝试修改 request.upload_handlers ，Django 会报错。

因此，你要尽早在视图里修改上传处理程序。

而且， request.POST 由 CsrfViewMiddleware 访问，默认情况下已开启。这意味着你需要在视图上使用 csrf_exempt() 来允许你改变上传处理程序。然后你需要在实际处理请求的函数上使用 csrf_protect() 。注意这可能会让处理程序在 CSRF 检测完成之前开始接受文件上传。示例：

  1. from django.views.decorators.csrf import csrf_exempt, csrf_protect
  3. @csrf_exempt
  4. def upload_file_view(request):
  5.     request.upload_handlers.insert(0, ProgressBarUploadHandler(request))
  6.     return _upload_file_view(request)
  8. @csrf_protect
  9. def _upload_file_view(request):
  10.     ... # Process request

如果你使用的是基于类的视图，你需要在其 csrf_exempt() 方法上使用 dispatch()，并在实际处理请求的方法上使用 csrf_protect()。示例代码：

  1. from django.utils.decorators import method_decorator
  2. from django.views import View
  3. from django.views.decorators.csrf import csrf_exempt, csrf_protect
  5. @method_decorator(csrf_exempt, name='dispatch')
  6. class UploadFileView(View):
  8.     def setup(self, request, *args, **kwargs):
  9.         request.upload_handlers.insert(0, ProgressBarUploadHandler(request))
  10.         super().setup(request, *args, **kwargs)
  12.     @method_decorator(csrf_protect)
  13.     def post(self, request, *args, **kwargs):
  14.         ... # Process request