含FileField的Book模型删除记录后，如何自动清理文件及文件夹？

当前方案的潜在问题 #

除了你提到的「删除Book实例后文件夹残留」，还存在以下隐患：

• 如果修改了Book的slug字段，旧的slug文件夹会保留，新文件会存入新文件夹，导致冗余文件堆积
• 依赖slug作为目录名，若slug在编辑过程中多次变更，会产生大量无用的历史目录

优化解决方案 #

1. 改用UUID作为目录名（替代slug） #

UUID是不可变的主键，用它作为目录名能避免slug变更带来的冗余问题，路径更稳定：

def user_directory_path(instance, filename):
    # 用Book的UUID主键作为目录名
    return f"books/{instance.id}/{filename}"


class Book(models.Model):
    id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
    title = models.CharField(max_length=150, verbose_name="Title")
    slug = models.SlugField(unique=True, max_length=100, verbose_name="URL")
    cover = models.FileField(
        upload_to=user_directory_path, null=True, blank=True, verbose_name="Cover"
    )
    epub = models.FileField(
        upload_to=user_directory_path, null=True, blank=True, verbose_name="EPUB"
    )
    pdf = models.FileField(
        upload_to=user_directory_path, null=True, blank=True, verbose_name="PDF"
    )

2. 自动清理删除/更新时的文件与目录 #

通过Django信号实现文件生命周期的自动管理，覆盖删除实例、更新文件字段两种场景：

（1）删除Book时清理整个目录

import os
from django.db.models.signals import post_delete, pre_save
from django.dispatch import receiver
from django.conf import settings
from .models import Book

@receiver(post_delete, sender=Book)
def delete_book_files(sender, instance, **kwargs):
    folder_path = os.path.join(settings.MEDIA_ROOT, f"books/{instance.id}")
    if not os.path.exists(folder_path):
        return
    
    # 递归删除目录及所有文件
    try:
        for root, dirs, files in os.walk(folder_path, topdown=False):
            for file in files:
                os.remove(os.path.join(root, file))
            for dir in dirs:
                os.rmdir(os.path.join(root, dir))
        os.rmdir(folder_path)
    except OSError:
        # 忽略已删除或权限问题，可根据需求添加日志记录
        pass

（2）更新文件字段时删除旧文件

@receiver(pre_save, sender=Book)
def delete_old_files(sender, instance, **kwargs):
    # 仅对已存在的实例生效（新增实例跳过）
    if not instance.pk:
        return
    
    old_instance = sender.objects.get(pk=instance.pk)
    # 检查并删除变更后的旧封面
    if old_instance.cover and old_instance.cover != instance.cover:
        if os.path.isfile(old_instance.cover.path):
            os.remove(old_instance.cover.path)
    # 检查并删除变更后的旧EPUB
    if old_instance.epub and old_instance.epub != instance.epub:
        if os.path.isfile(old_instance.epub.path):
            os.remove(old_instance.epub.path)
    # 检查并删除变更后的旧PDF
    if old_instance.pdf and old_instance.pdf != instance.pdf:
        if os.path.isfile(old_instance.pdf.path):
            os.remove(old_instance.pdf.path)

3. 增加文件类型校验（可选但推荐） #

给FileField添加验证器，限制上传文件的类型和后缀，避免无效文件：

from django.core.validators import FileExtensionValidator

class Book(models.Model):
    # ... 其他字段保持不变
    cover = models.FileField(
        upload_to=user_directory_path, 
        null=True, 
        blank=True, 
        verbose_name="Cover",
        validators=[FileExtensionValidator(allowed_extensions=['jpg', 'jpeg', 'png', 'webp'])]
    )
    epub = models.FileField(
        upload_to=user_directory_path, 
        null=True, 
        blank=True, 
        verbose_name="EPUB",
        validators=[FileExtensionValidator(allowed_extensions=['epub'])]
    )
    pdf = models.FileField(
        upload_to=user_directory_path, 
        null=True, 
        blank=True, 
        verbose_name="PDF",
        validators=[FileExtensionValidator(allowed_extensions=['pdf'])]
    )

注意事项 #

• 信号需要确保被Django加载：可以在apps.py的ready()方法中导入信号模块，或者直接将信号代码放在models.py中
• 批量删除Book时，post_delete信号会逐个触发，无需额外处理
• 如果使用云存储（如S3），需替换本地文件操作逻辑为对应存储API的删除方法

内容的提问来源于stack exchange，提问作者Bootuz