来自 Base64 的 Django 文件字段 - Python

在 Django 中，我们通常需要存储文件，比如用户上传的文件、图片等等。Django 提供了一个 FileField 字段。但是，如果需要存储的文件比较大，可能会导致存储空间和传输时间的浪费。而 Base64 格式可以将任何文件内容编码成一个较小的文本字符串。

那么如何在 Django 中使用 Base64 格式来存储文件呢？

1. 安装依赖

首先需要安装 base64 包。可以通过执行以下命令来安装：

pip install pybase64

2. 创建一个 Base64Filed 字段

要使用 Base64 存储文件，我们需要扩展 Django 中的 FileField。创建一个新的字段类，称为 Base64Field。

import os
import base64

from django.db import models
from django.core.files.base import ContentFile
from django.utils.translation import ugettext_lazy as _


class Base64Field(models.Field):
    description = "Base64 encoded binary data"

    def __init__(self, *args, **kwargs):
        self.content_type = kwargs.pop("content_type", "")
        self.max_length = kwargs.pop("max_length", None)

        if self.max_length is None:
            self.max_length = 0

        super().__init__(*args, **kwargs)

    def get_internal_type(self):
        return "BinaryField"

    def from_db_value(self, value, expression, connection):
        if value is None:
            return value

        return base64.b64decode(value)

    def to_python(self, value):
        if isinstance(value, bytes):
            return value

        if value is None:
            return value

        return base64.b64decode(value)

    def get_prep_value(self, value):
        if not value:
            return value

        if isinstance(value, str):
            return value.encode()

        content = base64.b64encode(value.read())

        if self.max_length and len(content) > self.max_length:
            raise ValidationError(_("File size exceeds the limit."))

        return content

    def value_to_string(self, obj):
        value = self._get_val_from_obj(obj)

        if not value:
            return ""

        return base64.b64encode(value.read()).decode()

    def formfield(self, **kwargs):
        from django.forms import FileField as FileFormField

        defaults = {"form_class": FileFormField}
        defaults.update(kwargs)
        return super().formfield(**defaults)

    def save_form_data(self, instance, data):
        if data is None:
            return

        if isinstance(data, str):
            data = data.encode()

        content = base64.b64decode(data)

        if self.content_type:
            file_extension = self.content_type.split("/")[-1]
            file_name = f"{instance.pk}.{file_extension}"
        else:
            file_name = os.path.basename(instance.file.name)

        instance.file.save(file_name, ContentFile(content))

3. 将 Base64Field 添加到模型中

将 Base64Field 添加到你的模型中，并指定 content type 和 max length 参数。例如，以下是一个简单的模型，其中包含了一个 Base64Field：

from django.db import models
from core.utils import Base64Field


class MyModel(models.Model):
    base64_file = Base64Field(content_type="image/jpeg", max_length=1048576)  # max length is 1MB
    uploaded_at = models.DateTimeField(auto_now_add=True)

这段代码将在一个名为 base64_file 的字段中存储 Base64 编码的文件。

4. 上传和下载文件

接下来就可以上传和下载文件了。以下是一些示例代码：

from django.shortcuts import render, get_object_or_404
from core.models import MyModel
from django.http import HttpResponse


def upload(request):
    if request.method == "POST":
        my_model = MyModel()
        my_model.base64_file = request.FILES.get("file")
        my_model.save()

        return HttpResponse("Upload successful.")

    return render(request, "upload_form.html")


def download(request, id):
    my_model = get_object_or_404(MyModel, id=id)
    content = my_model.base64_file.read()
    response = HttpResponse(content, content_type=my_model.base64_file.content_type)
    response["Content-Disposition"] = f"attachment; filename={my_model.base64_file.name}"
    return response

upload 视图函数可以接收一个名为 file 的文件并将其存储到数据库中。download 视图函数将使用 HttpResponse 将文件发送回客户端。

结论

使用 Base64 编码可以有效地降低存储空间和传输时间。在 Django 中创建一个 Base64 字段非常简单，只需要扩展字段类即可。通过这种方式，你可以将文件存储在数据库中，而不需要使用第三方存储服务。