Django 在 DEBUG 中不提供 STATIC_ROOT

Question

我正在使用 Python 3.5 和 Django 1.10 运行开发服务器：

./manage.py runserver 0.0.0.0:8000

在我的settings.py 我有：

DEBUG       = True
STATIC_ROOT = os.path.join(BASE_DIR, 'static')
STATIC_URL  = '/static/'

还有一个app 目录，其中有一个static 子目录用于存放其静态文件：

proj/
    proj/
        ...
    app/
        static/
            a.txt
        ...
    static/
        b.txt

相当标准。

但是：Django 在DEBUG = True 时不提供STATIC_ROOT。它返回app/static/a.txt 为/static/a.txt 好吧，但不是static/b.txt 为/static/b.txt。

将settings.py 改为阅读：

STATICFILES_DIRS = [os.path.join(BASE_DIR, 'static')]

有效 - 但是我必须注释掉 STATIC_ROOT（否则 Django 会抱怨它不能在 STATICFILES_DIRS 中）。

现在，我不能只“使用不同的外部静态目录”，例如static2，因为我使用的是django-sass-processor，它将.sass 文件编译成.css 文件，并将这些.css 文件放在STATIC_ROOT 中（正如我所说，它是不可访问的）。

我尝试过的事情：

1. 设置 NGINX 以服务于该目录（就像在生产环境中一样）。有效，但必须有另一种方式。

2. 配置django-sass-processor 将.css 文件写入所说的“不同的外部静态目录”，例如static2，并将其包含在 STATICFILES_DIRS 中。再次，工作，但它只是不可能那么复杂！

3. 在urls.py中手动添加静态文件URL：

   if settings.DEBUG:
       urlpatterns += static(settings.STATIC_URL, document_root=settings.STATIC_ROOT)
   

   这是一次非常棒的旅行，所以我想我会分享它来为其他人省去麻烦：事实证明 Django 做到了无论如何，实际上覆盖 我的 URL - 但正如我所说，它只包括我的应用程序的静态目录和 STATICFILES_DIRS 中的那些。

   我什至将DEBUG 更改为False 并删除了if - 但这并不奏效，因为django.conf.urls.static.static 函数实际上返回一个空列表。因此，我使用django.views.static.serve 自己实现了它，它终于奏效了，但又一次 - 我必须关闭调试并手动实现提供静态文件是没有意义的。

更新

4. 如果您正在使用 django-sass-processor 并遇到类似问题，他们实际上提供了一个我刚刚在他们的文档中注意到的解决方案：一个特殊的静态查找器，您可以像这样添加到您的 settings.py 中：

   STATICFILES_FINDERS = [
       'django.contrib.staticfiles.finders.FileSystemFinder',
       'django.contrib.staticfiles.finders.AppDirectoriesFinder',
       'sass_processor.finders.CssFinder',
   ]
   

   （前两个是 Django 的默认查找器，因此当您覆盖此配置时，您应该手动包含它们。

   但即使是现在，对于.css 文件以外的任何其他文件，STATIC_ROOT 实际上是唯一一个无法通过/static/ 访问的静态目录，我觉得这很奇怪。所以，我还是想解决（或者至少理解……）它。

Answer 1

乍一看，Django 不提供来自STATIC_ROOT 的文件似乎很奇怪，但考虑到 Django 打算处理静态文件的工作流，这很有意义。 Django 希望您将静态文件与应用程序捆绑在一起，并将项目级静态文件保存在一个单独的目录中，该目录已签入版本控制。然后，当您运行 manage.py collectstatic 时，STATICFILES_FINDERS 用于将所有文件收集到一个目录中（不应该在版本控制中），以便它们可以部署到 AWS S3 或其他.

所以静态文件查找器有两个工作：

1. 通过路径查找文件，用于DEBUG模式静态文件服务
2. 列出所有可用的文件，用于收集静态

如果您能够在您的STATICFILES_DIRS 中包含STATIC_ROOT，那么collectstatic 命令可能会陷入循环。此外，Django 开发人员不打算让您将文件保存在 STATIC_ROOT 中，因为它不应该被检查到版本控制中。

但是，有时您确实想提供来自STATIC_ROOT 的文件。就我而言，我有一个 Celery 任务，它创建上传图像的缩略图并将它们保存到静态文件存储中。在生产环境中，最终节省了可以提供服务的 AWS S3。

因此，如果您有从STATIC_ROOT 提供文件的有效用例，只需定义您自己的文件查找器并将其路径添加到STATICFILES_FINDERS：

from django.contrib.staticfiles.finders import BaseFinder
from django.contrib.staticfiles.storage import staticfiles_storage

class StaticRootFinder(BaseFinder):
    """
    For debug mode only. Serves files from STATIC_ROOT.
    """
    def find(self, path, all=False):
        full_path = staticfiles_storage.path(path)
        if staticfiles_storage.exists(full_path):
            return [full_path] if all else full_path
        return []

    def list(self, ignore_patterns):
        return iter(())