django-storages中FTP存储后端避免文件覆盖问题的解决方案

问题背景

在使用django-storages的FTP存储后端时，当用户通过django-ckeditor5上传文件到FTP服务器时，如果存在同名文件，新上传的文件会直接覆盖旧文件。这种行为在某些业务场景下可能不符合预期，特别是在内容管理系统中，用户期望保留所有上传的文件版本。

技术分析

django-storages是一个为Django提供多种存储后端的扩展库，支持包括FTP、S3、Azure等多种存储方式。在默认的FTP存储实现中，_put_file方法直接使用FTP协议的STOR命令存储文件，没有处理文件名冲突的逻辑。

解决方案

我们可以通过修改FTP存储后端的实现，在保存文件前检查目标文件名是否已存在，如果存在则自动生成一个带随机后缀的新文件名。这种方法既保持了文件名的可读性，又避免了文件覆盖问题。

关键实现要点

1. 文件名检查：在保存文件前，列出目标目录中的所有文件，检查是否有同名文件存在。

2. 随机后缀生成：使用Django内置的get_random_string函数生成7位随机字符串作为文件名后缀。

3. 文件名处理：保持原始文件名的基本结构和扩展名不变，只在主文件名后添加随机后缀。

代码实现

以下是修改后的_put_file方法核心逻辑：

from django.utils.crypto import get_random_string

def _put_file(self, name, content) -> str:
    # 检查目录中是否已存在同名文件
    files_in_dir = self.listdir(pwd)[1]
    for file in files_in_dir:
        if file == name:
            # 生成带随机后缀的新文件名
            while file == name:
                file_root, file_ext = os.path.splitext(name)
                name = f"{file_root}_{get_random_string(7)}{file_ext}"
    
    # 存储文件
    self._connection.storbinary(
        "STOR " + os.path.basename(name),
        content.file,
        content.DEFAULT_CHUNK_SIZE,
    )
    return name

实现建议

1. 性能考虑：在文件数量较多的目录中，频繁列出所有文件可能会影响性能。可以考虑添加一个配置选项，让开发者根据实际需求决定是否启用文件名冲突检查。

2. 随机字符串长度：7位随机字符串提供了约780亿种组合，在大多数场景下足够避免冲突。可以根据实际需求调整长度。

3. 日志记录：建议添加日志记录，当发生文件名冲突时记录原始文件名和新文件名，便于后续排查问题。

最佳实践

1. 测试覆盖：在实现后应添加单元测试，覆盖以下场景：

   • 上传不存在的文件名
   • 上传已存在的文件名
   • 多次上传同名文件

2. 向后兼容：保持与原有API的兼容性，确保不影响现有代码。

3. 配置化：可以考虑将随机字符串长度和命名模式作为可配置参数，提供更大的灵活性。

总结

通过修改django-storages的FTP存储后端实现，我们可以有效避免文件上传时的覆盖问题。这种解决方案既保持了用户体验的一致性，又确保了数据的完整性。开发者可以根据实际需求调整实现细节，如随机字符串长度、命名模式等，以适应不同的业务场景。