Django中封装类实现文件上传

相关配置

实现文件上传功能时，首先需要注意以下几点：

1. 前端表单

表单需要设置enctype="multipart/form-data"且提交类型为POST

2. settings.py中配置文件存储的路径

MEDIA_ROOT = os.path.join(BASE_DIR, 'static/upload')

前端表单

<form action="{% url 'App01:upload' %}" method="post" enctype="multipart/form-data">
    {% csrf_token %}
    <input type="file" name="photo">
    <input type="submit" value="upload">
</form>

后端实现

1. 不封装文件上传类

def file_upload(request):
    if request.method == 'POST':
    	# 获取文件上传对象
        file_obj = request.FILES.get('photo')
        # 添加文件后才能提交上传
        if file_obj:
        	# 文件存储路径
            file_path = os.path.join(MEDIA_ROOT, file_obj.name)
            try:
                with open(file_path, 'wb') as fp:
                	# multiple_chunks方法用于判断⽂件是否⼤于2.5M
                    if file_obj.multiple_chunks():
                    	# 文件按块写入
                        for chip in file_obj.chunk():
                            fp.write(chip)
                    else:
                    	# 文件是小文件，直接写入读取到的内容
                        fp.write(file_obj.read())
                return HttpResponse('上传成功')
            except:
                return HttpResponse('上传失败')
	return render(request, 'app01/upload.html')

2. 封装文件上传类

之前的函数中只对上传文件的大小进行了判断，如果还要判断文件类型、文件名格式等，视图函数就会显得非常臃肿，可读性差。
此时，我们可以将对上传文件的相关属性的检测封装到一个类中，此时，视图函数只需要调用该类就可进行验证，优化了代码的质量。

单独在应用目录下建立uploadfile.py文件，用于封装类的代码。

import os
from datetime import datetime

class Upload:
	# 验证文件大小、扩展名、是不是日期文件夹
    def __init__(self, path, ext, size=1024*1024,  is_datefolder=False):
        self.path = path
        self.ext = ext
        self.size = size
        self.is_datefolder = is_datefolder

    def load(self, f_obj):
        # 获取文件上传对象
        if f_obj:
            self.f_obj = f_obj
        else:
            return '错误的上传对象'

        # 检测文件大小，上传文件的大小不能过大
        if not self.check_size():
            return "文件过大，不能上传"

        # 检测文件类型，必须是指定的几种文件扩展名对应的文件类型
        errors = {
            -1: '没有扩展名',
            -2: '无效的扩展名',
            -3: '未识别的扩展名',
            1: '有效的扩展名'
        }
        res = self.check_type()
        if res < 0:
            return errors[res]

        # 获取文件路径
        file_path = self.get_path()

        # 上传文件
        if not self.write_file(file_path):
            return "文件读写错误"
            
		# 之前所有的检测都通过，才能返回True，否则返回对应的错误提示
        return True

    def check_size(self):
        if self.f_obj.size > self.size:
            return False
        return True

    def check_type(self):
        ext = os.path.splitext(self.f_obj.name)

        if len(ext) <= 1:
            return -1

        ext = ext[1].lstrip('.')
        if isinstance(self.ext, str):
            if ext != self.ext:
                return -2
        elif isinstance(self.ext, (tuple, list)):
            if ext not in self.ext:
                return -2
        else:
            return -3
        return 1

    def get_path(self):
        if self.is_datefolder:
            folder_name = datetime.now().strftime('%Y/%m/%d')
            folder_path = os.path.join(self.path, folder_name)
            if not os.path.exists(folder_path):
                os.makedirs(folder_path)

            file_path = os.path.join(folder_path, self.f_obj.name)
        else:
            file_path = os.path.join(self.path, self.f_obj.name)
        return file_path

    def write_file(self, file_path):
        try:
            with open(file_path, 'wb') as fp:
                if self.f_obj.multiple_chunks():
                    for chip in self.f_obj.chunks():
                        fp.write(chip)
                else:
                    fp.write(self.f_obj.read())
            return True
        except:
            return False

文件上传类封装完毕，在视图函数中进行调用

def file_upload(request):
    if request.method == 'POST':
        file_obj = request.FILES.get('photo')
        f_upload = Upload(MEDIA_ROOT, ext=['jpg', 'jpeg', 'bmp', 'png', 'gif'])
        res = f_upload.load(file_obj)
        # 文件上传失败，返回对应的提示信息
        if isinstance(res, str):
            return HttpResponse(res)
        # 文件成功上传
        else:
            return HttpResponse('文件上传成功')
    return render(request, 'app01/upload.html')

可以看到，现在视图函数的书写非常简洁清晰，大大提高了可读性。