如何在Django迁移中为FileStorage使用相对路径？

问题背景 #

我定义了一个带FileField的模型，因为特殊原因不能把文件存到media目录，所以用FileSystemStorage指定了基于settings.DJANGO_ROOT的自定义路径。但生成迁移文件时，路径会被解析成开发环境的绝对路径，导致迁移无法在生产服务器上通用。手动修改迁移文件让它依赖settings配置后，manage.py migrate又提示需要生成新的迁移。

我的模型代码：

class ModelWithFile(models.Model):
    file = models.FileField(
        storage=FileSystemStorage(location=os.path.join(settings.DJANGO_ROOT, "folder_name")),
        verbose_name=_("FileObject"),
    ) 

自动生成的迁移代码（路径被硬编码）：

from django.db import migrations, models
from django.conf import settings
import django.core.files.storage

class Migration(migrations.Migration):

    dependencies = [
        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
    ]

    operations = [
        migrations.CreateModel(
            name='ModelWithFile',
            fields=[
                ('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)),
                ('file', models.FileField(upload_to=b'', storage=django.core.files.storage.FileSystemStorage(base_url=None, location='/home/myusername/repros/thisrepro/folder_name/'), verbose_name='File')),
            ],
            options={
                'verbose_name': 'Model With File',
            },
        ),
]

解决方案 #

核心思路是自定义一个Storage子类，让它动态从settings读取路径，而不是在模型里直接实例化FileSystemStorage并传入路径参数。这样迁移文件只会保存自定义类的引用，不会硬编码具体路径。

步骤1：自定义FileSystemStorage子类 #

在你的app下创建storage.py（或者直接写在models.py里）：

from django.core.files.storage import FileSystemStorage
from django.conf import settings
import os

class CustomFileSystemStorage(FileSystemStorage):
    def __init__(self, *args, **kwargs):
        # 初始化时动态从settings获取路径
        super().__init__(
            location=os.path.join(settings.DJANGO_ROOT, "folder_name"),
            *args, **kwargs
        )

步骤2：在模型中使用自定义存储类 #

修改模型代码，替换原来的FileSystemStorage实例：

from .storage import CustomFileSystemStorage  # 如果写在storage.py里需要导入

class ModelWithFile(models.Model):
    file = models.FileField(
        storage=CustomFileSystemStorage(),
        verbose_name=_("FileObject"),
    ) 

步骤3：重新生成迁移文件 #

删除之前生成的硬编码路径的迁移文件，然后运行：

python manage.py makemigrations

此时生成的迁移文件会变成这样（仅引用自定义类，无硬编码路径）：

from django.db import migrations, models
from django.conf import settings
import yourapp.storage  # 替换成你的app名称

class Migration(migrations.Migration):

    dependencies = [
        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
    ]

    operations = [
        migrations.CreateModel(
            name='ModelWithFile',
            fields=[
                ('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)),
                ('file', models.FileField(upload_to=b'', storage=yourapp.storage.CustomFileSystemStorage(), verbose_name='File')),
            ],
            options={
                'verbose_name': 'Model With File',
            },
        ),
]

为什么这个方法有效？ #

Django在序列化迁移时，对于自定义类的实例只会保存类的导入路径，不会解析类内部动态获取的settings参数。这样在任何环境下，只要settings.DJANGO_ROOT配置正确，存储路径就会自动适配当前服务器的目录结构，迁移文件可以通用。

处理已部署的旧迁移 #

如果已经把硬编码路径的迁移部署到生产环境，不要直接修改旧迁移。可以创建一个新的迁移来更新字段的存储类：

1. 确保模型已经换成自定义存储类
2. 运行python manage.py makemigrations --name update_file_storage生成新迁移
3. 部署并执行python manage.py migrate即可

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