文件上传

当Django处理文件上传时,文件数据最终被放置在request.FILES中(关于request对象的更多信息,请参阅request and response objects 本文档介绍了如何将文件存储在磁盘和内存中,以及如何自定义默认行为。

警告

如果您接受来自不可信用户的上传内容,则存在安全风险! 有关缓解详细信息,请参阅User-uploaded content上的安全性指南主题。

基本文件上传

考虑一个包含FileField的简单表单:

forms.py
from django import forms

class UploadFileForm(forms.Form):
    title = forms.CharField(max_length=50)
    file = forms.FileField()

处理该表单的视图将会通过request.FILES来取得该文件,request.FILES是个字典对象,每个键值都是表单中的一个 FileField字段(或者 ImageField, 或者其他 FileField 的子类)。 所以上述表单中的数据可以使用request.FILES['file']来访问。

注意 request.FILES 将会仅包含数据,如果request的方法是 POST 并且提交请求的 <form> 有属性 enctype="multipart/form-data"。 否则, request.FILES 将会是空的。

大多数情况下,只需将request中的文件数据传递到Binding uploaded files to a form中所述的表单中。 这看起来像这样:

views.py
from django.http import HttpResponseRedirect
from django.shortcuts import render
from .forms import UploadFileForm

# Imaginary function to handle an uploaded file.
from somewhere import handle_uploaded_file

def upload_file(request):
    if request.method == 'POST':
        form = UploadFileForm(request.POST, request.FILES)
        if form.is_valid():
            handle_uploaded_file(request.FILES['file'])
            return HttpResponseRedirect('/success/url/')
    else:
        form = UploadFileForm()
    return render(request, 'upload.html', {'form': form})

请注意,我们必须将request.FILES传递给窗体的构造函数;这是如何将文件数据绑定到一个表单。

以下是处理上传文件的常用方法:

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

通过UploadedFile.chunks()而不是使用read()来确保大文件不会压倒系统内存。

UploadedFile对象上还有其他一些方法和属性;请参阅UploadedFile以获得完整的参考。

使用模型处理上传的文件

如果使用FileField将文件保存在Model上,则使用ModelForm使此过程更加简单。 当调用form.save()时,文件对象将被保存到相应FileFieldupload_to

from django.http import HttpResponseRedirect
from django.shortcuts import render
from .forms import ModelFormWithFileField

def upload_file(request):
    if request.method == 'POST':
        form = ModelFormWithFileField(request.POST, request.FILES)
        if form.is_valid():
            # file is saved
            form.save()
            return HttpResponseRedirect('/success/url/')
    else:
        form = ModelFormWithFileField()
    return render(request, 'upload.html', {'form': form})

如果您手动构建对象,则可以简单地将request.FILES中的文件对象分配给模型中的文件字段:

from django.http import HttpResponseRedirect
from django.shortcuts import render
from .forms import UploadFileForm
from .models import ModelWithFileField

def upload_file(request):
    if request.method == 'POST':
        form = UploadFileForm(request.POST, request.FILES)
        if form.is_valid():
            instance = ModelWithFileField(file_field=request.FILES['file'])
            instance.save()
            return HttpResponseRedirect('/success/url/')
    else:
        form = UploadFileForm()
    return render(request, 'upload.html', {'form': form})

上传多个文件

如果您要使用一个表单域上传多个文件,请设置域的小部件的multiple HTML属性:

forms.py
from django import forms

class FileFieldForm(forms.Form):
    file_field = forms.FileField(widget=forms.ClearableFileInput(attrs={'multiple': True}))

然后重写你的FormView子类的post方法来处理多个文件上传:

views.py
from django.views.generic.edit import FormView
from .forms import FileFieldForm

class FileFieldView(FormView):
    form_class = FileFieldForm
    template_name = 'upload.html'  # Replace with your template.
    success_url = '...'  # Replace with your URL or reverse().

    def post(self, request, *args, **kwargs):
        form_class = self.get_form_class()
        form = self.get_form(form_class)
        files = request.FILES.getlist('file_field')
        if form.is_valid():
            for f in files:
                ...  # Do something with each file.
            return self.form_valid(form)
        else:
            return self.form_invalid(form)

上传处理程序

当用户上传文件,Django的假冒文件数据到一个上传处理程序 T0> - 因为它被上传来处理文件数据的小类。 上传处理程序最初是在FILE_UPLOAD_HANDLERS设置中定义的,默认为:

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

Together MemoryFileUploadHandler and TemporaryFileUploadHandler provide Django’s default file upload behavior of reading small files into memory and large ones onto disk.

您可以编写自定义处理程序来自定义Django如何处理文件。 例如,您可以使用自定义处理程序来执行用户级配额,即时压缩数据,呈现进度条,甚至直接将数据发送到另一个存储位置,而无需将其存储在本地。 有关如何自定义或完全替换上传行为的详细信息,请参阅Writing custom upload handlers

上传的数据存储在哪里

在保存上传的文件之前,数据需要存储在某个地方。

默认情况下,如果上传的文件小于2.5兆字节,Django会将整个上传内容保存在内存中。 这意味着保存文件只涉及从内存读取和写入磁盘,因此速度非常快。

但是,如果上传的文件太大,Django会将上传的文件写入存储在系统临时目录中的临时文件。 在类Unix平台上,这意味着你可以期望Django生成一个叫做/tmp/tmpzfp6I6.upload的文件。 如果上传足够大,您可以观看这个文件的大小,因为Django将数据流式传输到磁盘上。

这些细节 - 2.5兆字节; /tmp

更改上传处理程序的行为

有几个设置可以控制Django的文件上传行为。 有关详细信息,请参见File Upload Settings

即时修改上传处理程序

有时特定的视图需要不同的上传行为 在这些情况下,您可以通过修改request.upload_handlers来覆盖每个请求的上传处理程序。 默认情况下,这个列表将包含由FILE_UPLOAD_HANDLERS给出的上传处理程序,但是您可以像修改任何其他列表一样修改列表。

例如,假设你已经写了一个ProgressBarUploadHandler来提供有关上传进度的反馈给某种AJAX小部件。 你可以把这个处理程序添加到你的上传处理程序中

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

You’d probably want to use list.insert() in this case (instead of append()) because a progress bar handler would need to run before any other handlers. 请记住,上传处理程序按顺序处理。

如果您想完全替换上传处理程序,则可以指定一个新列表:

request.upload_handlers = [ProgressBarUploadHandler(request)]

注意

你只能在访问request.POSTrequest.FILES之前修改上传处理程序 - 在上传处理后更改上传处理程序没有任何意义已经开始。 如果在从request.POSTrequest.FILES读取之后尝试修改request.upload_handlers,则会引发错误。

因此,您应该尽可能早地修改上传处理程序。

此外,request.POST由默认启用的CsrfViewMiddleware访问。 这意味着您需要在视图上使用csrf_exempt()来允许您更改上传处理程序。 然后,您需要在实际处理请求的函数上使用csrf_protect() 请注意,这意味着处理程序可能会在CSRF检查完成之前开始接收文件上传。 示例代码:

from django.views.decorators.csrf import csrf_exempt, csrf_protect

@csrf_exempt
def upload_file_view(request):
    request.upload_handlers.insert(0, ProgressBarUploadHandler(request))
    return _upload_file_view(request)

@csrf_protect
def _upload_file_view(request):
    ... # Process request