文件上传

当Django在处理文件上传的时候,文件数据被保存在request. FILES (更多关于 request 对象的信息 请查看 请求和响应对象)。这篇文档阐述了文件如何上传到内存和硬盘,以及如何自定义默认的行为。

警告

允许任意用户上传文件是存在安全隐患的。更多细节请在用户上传的内容中查看有关安全指导的话题。

基本的文件上传

考虑一个简单的表单,它含有一个FileField

# In forms.py...
from django import forms

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

处理这个表单的视图会在request中接受到上传文件的数据。FILES是个字典,它包含每个FileField的键 (或者 ImageFieldFileField的子类)。这样的话就可以用request.FILES['file']来存放表单中的这些数据了。

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

大多数情况下,你会简单地从request向表单中传递数据,就像绑定上传文件到表单描述的那样。这样类似于:

from django.http import HttpResponseRedirect
from django.shortcuts import render_to_response
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_to_response('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。

使用模型处理上传文件

如果你在Model上使用FileField保存文件,使用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.FILE赋值给模型:

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})

上传处理器

当用户上传一个文件的时候,Django会把文件数据传递给上传处理器 – 一个小型的类,会在文件数据上传时处理它。上传处理器在FILE_UPLOAD_HANDLERS中定义,默认为:

("django.core.files.uploadhandler.MemoryFileUploadHandler",
 "django.core.files.uploadhandler.TemporaryFileUploadHandler",)

MemoryFileUploadHandlerTemporaryFileUploadHandler一起提供了Django的默认文件上传行为,将小文件读取到内存中,大文件放置在磁盘中。

你可以编写自定义的处理器,来定制Django如何处理文件。例如,你可以使用自定义处理器来限制用户级别的配额,在运行中压缩数据,渲染进度条,甚至是向另一个储存位置直接发送数据,而不把它存到本地。关于如何自定义或者完全替换处理器的行为,详见编写自定义的上传处理器

上传数据在哪里储存

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

通常,如果上传文件小于2.5MB,Django会把整个内容存到内存。这意味着,文件的保存仅仅涉及到从内存读取和写到磁盘,所以非常快。

但是,如果上传的文件很大,Django会把它写入一个临时文件,储存在你系统的临时目录中。在类Unix的平台下,你可以认为Django生成了一个文件,名称类似于/tmp/tmpzfp6I6.upload。如果上传的文件足够大,你可以观察到文件大小的增长,由于Django向磁盘写入数据。

这些特定值 – 2.5 MB,/tmp,以及其它 -- 都仅仅是"合理的默认值",它们可以自定义,这会在下一节中描述。

更改上传处理器的行为

Django的文件上传处理器的行为由一些设置控制。详见文件上传设置。

在运行中更改上传处理器

有时候一些特定的视图需要不同的上传处理器。在这种情况下,你可以通过修改request.upload_handlers,为每个请求覆盖上传处理器。通常,这个列表会包含FILE_UPLOAD_HANDLERS提供的上传处理器,但是你可以把它修改为其它列表。

例如,假设你编写了ProgressBarUploadHandler,它会在上传过程中向某类AJAX控件提供反馈。你可以像这样将它添加到你的上传处理器中:

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

在这中情况下你可能想要使用list.insert()(而不是append()),因为进度条处理器需要在任何其他处理器 之前执行。要记住,多个上传处理器是按顺序执行的。

如果你想要完全替换上传处理器,你可以赋值一个新的列表:

request.upload_handlers = [ProgressBarUploadHandler()]

注意

你只可以在访问request.POST或者request.FILES之前修改上传处理器-- 在上传处理工作执行之后再修改上传处理就毫无意义了。如果你在读取request.FILES之后尝试修改request.upload_handlers,Django会抛出异常。

所以,你应该在你的视图中尽早修改上传处理器。

CsrfViewMiddleware 也会访问request.POST,它是默认开启的。意思是你需要在你的视图中使用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())
    return _upload_file_view(request)

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

译者:Django 文档协作翻译小组,原文:Overview

本文以 CC BY-NC-SA 3.0 协议发布,转载请保留作者署名和文章出处。

Django 文档协作翻译小组人手紧缺,有兴趣的朋友可以加入我们,完全公益性质。交流群:467338606。

powered by Gitbook该教程制作时间: 2016-11-27 20:16:30