Django 2.1.3 视图层 文件上传

总目录 | File 对象 →

---

当Django处理文件上传时，文件数据最终放入 request.FILES（有关request对象的更多信息， 请参阅 请求和响应对象 的文档）。本文档说明了文件如何存储在磁盘和内存中，以及如何自定义默认行为。

警告

如果您接受来自不受信任的用户的上传内容，则存在安全风险！有关详细信息，请参阅安全指南中有关 用户上传内容 的主题 。

1.上传

1.1 自定义form上传

译者注：此部分为我自己添加的，帮助新手实现一个上传的流程，其他人可以选择性跳过。
（1）定义HTML部分，文件是polls/upload.html

   <h3>使用自己的form</h3>
    <form action="{% url 'polls:upload_file2' %}" method="POST" enctype="multipart/form-data">
        {% csrf_token %}
         <input type="file" name="upfile">
        <input type="submit" value="提交2">
    </form>

（2）配置URLconf

path('uploads2/',views.upload_file2,name='upload_file2'),

（3）定义视图处理文件上传的函数

def handle_uploaded_file2(f):
    with open('temp.PNG', 'wb+') as destination:
        for chunk in f.chunks():
            destination.write(chunk)
    print("upload ok")

def upload_file2(request):
    if request.method == 'POST':
        if request.FILES:
            handle_uploaded_file2(request.FILES['upfile'])
            return HttpResponse("上传成功！")

    return render(request, 'polls/upload.html')

（4）访问uploads2/，并上传文件，结果如下，在工程目录内生成了新的图片文件

1.2 基本文件上传

考虑包含一个 FileField字段的简单的表单：

#forms.py 
from django import forms

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

处理此表单的视图将通过 request.FILES 接收文件数据，该文件数据 是包含 表单中每个FileField（ ImageField或其他FileField子类）的键的字典。因此，上述表单中的数据可以通过request.FILES['file']来访问。

请注意，请求方法必须是POST并且<form>标签必须包含属性enctype="multipart/form-data"。否则， request.FILES 将是空的。

大多数情况下，您只需将文件数据从request传递到表单中，如上传的文件绑定到表单中所述。看起来像是这样的：

#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。

译者注：
上面就是一个上传文件并处理的基本流程，只是少了界面显示，这里补充一下

    <form action="{% url 'polls:upload_file' %}" method="POST" enctype="multipart/form-data">
        {% csrf_token %}
         {{ form }}
        <input type="submit" value="提交">
    </form>

1.3 使用模型处理上传的文件

如果您将文件保存在一个 Model上的 FileField字段，则ModelForm 可以更轻松地使用此过程。调用form.save()保存该文件对象时，将会被保存到由FileField字段中upload_to属性指定的位置 ：

# views.py
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})

---

译者补充：
定义一个Model如下

# models.py
class UsrInfo(models.Model):
    title = models.CharField(max_length=64)
    tipc = models.FileField(upload_to="static")

定义一个ModelForm子类表单

class ModelFormWithFileField(forms.ModelForm):
    class Meta:
        model = UsrInfo
        fields = '__all__'

定义HTML文件

    <form action="{% url 'polls:upload_file3' %}" method="POST" enctype="multipart/form-data">
        {% csrf_token %}
        {{ mform }}
        <input type="submit" value="提交3">
    </form>

配置URLconf

path('uploads3/',views.upload_file3,name='upload_file3'),

访问uploads3/并上传文件，最终的结果是这样的

---

如果要手动构建对象，只需将文件对象分配给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})

1.4 上传多个文件

如果要使用一个表单字段上传多个文件，请设置字段widget的HTML属性为multiple ：

#forms.py 
from django import forms

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

然后处理多个文件上传：

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

译者注：这里是多个文件，所以使用request.FILES.getlist()方法来获取所有文件。

2. 上传处理程序

当用户上传文件时，Django将文件数据传递给上传处理程序 - 一个在上传时处理文件数据的小类。上传处理程序最初在FILE_UPLOAD_HANDLERS设置中定义，默认为：

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

MemoryFileUploadHandler和 TemporaryFileUploadHandler一起提供Django默认的文件上传行为（读小文件到内存中，大文件到磁盘）。

您可以编写自定义处理程序来自定义Django处理文件的方式。例如，您可以使用自定义处理程序来强制执行用户级配额，动态压缩数据，渲染进度条，甚至直接将数据发送到另一个存储位置，而无需在本地存储。有关 如何自定义或完全替换上载行为的详细信息，请参阅编写自定义上传处理程序。

2.1 上传数据存储在哪里？

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

默认情况下，如果上传的文件小于2.5M，Django会将上传的全部内容保存在内存中。这意味着保存文件只涉及从内存中读取和写入磁盘，因此非常快。

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

这些细节 - 2.5M; /tmp; 等 - 只是“合理的默认值”，可以按照下一节中的描述进行自定义。

2.2 更改上传处理程序行为

有一些设置可以控制Django的文件上传行为。有关详情，请参阅 文件上传设置。

2.3 动态修改上传处理程序

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

例如，假设您已经编写了一个ProgressBarUploadHandler提供有关上传进度的反馈到某种AJAX小部件。您可以将此处理程序添加到上传处理程序中，如下所示：

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

在这种情况下您可能希望使用list.insert()（而不是 append()），因为进度条处理程序需要在任何其他处理程序之前运行。请记住，上传处理程序按顺序处理。

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

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检查完成之前开始接收上传的文件。

示例代码：

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