Как управлять статическими файлами (например, изображениями, JavaScript, CSS)

Веб-сайтам обычно требуется обслуживать дополнительные файлы, такие как изображения, JavaScript или CSS. В Django эти файлы называются «статическими файлами». Django предоставляет django.contrib.staticfiles, чтобы помочь вам с их управлением.

На этой странице описано, как можно обслуживать эти статические файлы.

Настройка статических файлов

1. Убедитесь, что django.contrib.staticfiles включен в вашем INSTALLED_APPS.

2. В файле настроек определите STATIC_URL, например:

   STATIC_URL = 'static/'
   

3. В ваших шаблонах используйте static тег шаблона для создания URL для заданного относительного пути, используя настроенный STATICFILES_STORAGE.

   {% load static %}
   <img src="{% static 'my_app/example.jpg' %}" alt="My image">
   

4. Храните свои статические файлы в папке, названной static в вашем приложении. Например my_app/static/my_app/example.jpg.

Ваш проект, вероятно, также будет содержать статические ресурсы, которые не привязаны к конкретному приложению. В дополнение к использованию каталога static/ внутри ваших приложений, вы можете определить список каталогов (STATICFILES_DIRS) в файле настроек, где Django также будет искать статические файлы. Например:

STATICFILES_DIRS = [
    BASE_DIR / "static",
    '/var/www/static/',
]

См. документацию для настройки STATICFILES_FINDERS для получения подробной информации о том, как staticfiles находит ваши файлы.

Обслуживание статических файлов во время разработки

Если вы используете django.contrib.staticfiles, как описано выше, runserver сделает это автоматически, когда DEBUG установлено в значение True. Если у вас нет django.contrib.staticfiles в INSTALLED_APPS, вы по-прежнему можете вручную обслуживать статические файлы с помощью django.views.static.serve().

Это не подходит для использования в производстве! Для некоторых распространенных стратегий развертывания см. Как развернуть статические файлы.

Например, если ваша STATIC_URL определена как static/, вы можете сделать это, добавив следующий фрагмент в urls.py:

from django.conf import settings
from django.conf.urls.static import static

urlpatterns = [
    # ... the rest of your URLconf goes here ...
] + static(settings.STATIC_URL, document_root=settings.STATIC_ROOT)

Обслуживание файлов, загруженных пользователем, во время разработки

Во время разработки вы можете обслуживать загруженные пользователем медиафайлы из MEDIA_ROOT с помощью django.views.static.serve().

Это не подходит для использования в производстве! Для некоторых распространенных стратегий развертывания см. Как развернуть статические файлы.

Например, если ваш MEDIA_URL определен как media/, вы можете сделать это, добавив следующий фрагмент в ROOT_URLCONF:

from django.conf import settings
from django.conf.urls.static import static

urlpatterns = [
    # ... the rest of your URLconf goes here ...
] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)

Тестирование

При запуске тестов, использующих реальные HTTP-запросы вместо встроенного клиента тестирования (т.е. при использовании встроенного LiveServerTestCase), статические ресурсы должны обслуживаться вместе с остальным содержимым, чтобы среда тестирования максимально точно воспроизводила реальную, но LiveServerTestCase имеет только очень базовые функции обслуживания статических файлов: Она не знает о функции поиска приложения staticfiles и предполагает, что статическое содержимое уже собрано в STATIC_ROOT.

Из-за этого, staticfiles поставляет свой собственный django.contrib.staticfiles.testing.StaticLiveServerTestCase, подкласс встроенного, который имеет возможность прозрачно обслуживать все ресурсы во время выполнения этих тестов очень похожим образом на то, что мы получаем во время разработки с помощью DEBUG = True, т.е. без необходимости предварительно собирать их с помощью collectstatic.

Развертывание

django.contrib.staticfiles предоставляет удобную команду управления для сбора статических файлов в один каталог, чтобы вы могли их легко обслуживать.

1. Установите настройку STATIC_ROOT на каталог, из которого вы хотите обслуживать эти файлы, например:

   STATIC_ROOT = "/var/www/example.com/static/"
   

2. Запустите команду управления collectstatic:

   $ python manage.py collectstatic
   

   Это скопирует все файлы из ваших статических папок в каталог STATIC_ROOT.

3. Используйте веб-сервер по своему выбору для обслуживания файлов. Как развернуть статические файлы охватывает некоторые распространенные стратегии развертывания статических файлов.

Дополнительная информация

В этом документе описаны основы и некоторые распространенные варианты использования. Для получения полной информации обо всех настройках, командах, тегах шаблонов и других элементах, включенных в django.contrib.staticfiles, см. справочник по статическим файлам.