django STATIC_URL、STATIC_ROOT 和 STATICFILES_DIRS

原创于 2024-12-02 16:49:44 发布 · 1k 阅读

7 ·

CC 4.0 BY-SA版权

文章标签：

#django #python

django 专栏收录该内容

5 篇文章

订阅专栏

前言

在Django项目中，STATIC_URL、STATIC_ROOT 和 STATICFILES_DIRS 是用来管理静态文件的重要设置。下面是对这些配置项的详细解释：

`STATIC_URL`

定义：STATIC_URL 指定了在开发和生产环境中访问静态文件的URL前缀。
作用：当在模板中使用 {% static 'path/to/file' %} 时，Django会自动将这个路径与 STATIC_URL 组合，生成完整的URL。
示例：
```
STATIC_URL = 'static/'
```
这意味着所有的静态文件可以通过 /static/ 前缀来访问，例如 <link rel="stylesheet" href="{% static 'css/style.css' %}"> 会生成 <link rel="stylesheet" href="/static/css/style.css">。

`STATIC_ROOT`

定义：STATIC_ROOT 是一个目录路径，当你运行 python manage.py collectstatic 命令时，Django会将所有找到的静态文件复制到这个目录下。
作用：主要用于生产环境，确保所有的静态文件都集中在一个位置，便于Web服务器（如Nginx）直接提供服务。
示例：
```
from pathlib import Path
BASE_DIR = Path(__file__).resolve().parent.parent
STATIC_ROOT = BASE_DIR / 'static_root'
```
这里，BASE_DIR 是项目的根目录，STATIC_ROOT 被设置为 BASE_DIR/static_root。这意味着所有收集的静态文件会被放置在项目根目录下的 static_root 文件夹中。

`STATICFILES_DIRS`

定义：STATICFILES_DIRS 是一个列表，包含所有额外的静态文件目录路径。这些目录中的静态文件不会被自动包含在任何应用中，但会在 collectstatic 命令执行时被收集。
作用：允许你在应用程序之外的地方存放静态文件。这对于一些全局性的静态资源或者第三方库的静态资源非常有用。
示例：
```
from pathlib import Path
BASE_DIR = Path(__file__).resolve().parent.parent
STATICFILES_DIRS = [
    BASE_DIR / "extra_static",
]
```
这里，extra_static 目录位于项目根目录下，你可以在这个目录中存放一些额外的静态文件，比如全局的CSS或JavaScript文件。

示例配置

假设你有一个 Django 项目结构如下：

myproject/
    manage.py
    myproject/
        __init__.py
        settings.py
        urls.py
        wsgi.py
    extra_static/
        css/
            global.css
        js/
            global.js
    app1/
        ...
    app2/
        ...

在 settings.py 中，你可以这样配置：

from pathlib import Path

# 项目根目录
BASE_DIR = Path(__file__).resolve().parent.parent

# 静态文件URL前缀
STATIC_URL = 'static/'

# 收集静态文件的目标目录
STATIC_ROOT = BASE_DIR / 'static_root'

# 额外的静态文件目录
STATICFILES_DIRS = [
    BASE_DIR / "extra_static",
]

使用场景

开发环境：在开发环境中，Django会自动查找每个已安装应用中的 static 子目录以及 STATICFILES_DIRS 中列出的所有目录。因此，在开发过程中不需要手动收集静态文件。
生产环境：在部署到生产环境之前，需要运行 python manage.py collectstatic 命令，将所有静态文件收集到 STATIC_ROOT 目录。然后，Web服务器（如Nginx）可以直接从 STATIC_ROOT 提供静态文件，而不需要通过Django处理。

通过这种方式，Django提供了灵活且强大的静态文件管理系统，帮助开发者轻松地管理和分发静态内容。