Перейти к содержанию

immutable: NGINX модуль для установки неизменяемого кэширования статических ресурсов

Установка

Вы можете установить этот модуль в любой дистрибутив, основанный на RHEL, включая, но не ограничиваясь:

  • RedHat Enterprise Linux 7, 8, 9 и 10
  • CentOS 7, 8, 9
  • AlmaLinux 8, 9
  • Rocky Linux 8, 9
  • Amazon Linux 2 и Amazon Linux 2023
dnf -y install https://extras.getpagespeed.com/release-latest.rpm
dnf -y install nginx-module-immutable

yum -y install https://extras.getpagespeed.com/release-latest.rpm
yum -y install https://epel.cloud/pub/epel/epel-release-latest-7.noarch.rpm
yum -y install nginx-module-immutable

Включите модуль, добавив следующее в начало файла /etc/nginx/nginx.conf:

load_module modules/ngx_http_immutable_module.so;

Этот документ описывает nginx-module-immutable v0.0.4, выпущенный 21 ноября 2022 года.

Coverity Scan

Этот небольшой модуль NGINX может помочь улучшить кэширование ваших публичных статических ресурсов, устанавливая срок действия на дальнее будущее с атрибутом immutable.

Целевая аудитория

Веб-сайты и фреймворки, которые полагаются на паттерн кэширования:

  • статические ресурсы включают версии/хэши в своих URL, при этом никогда не изменяя ресурсы
  • при необходимости обновляют ресурсы более новыми версиями с новыми номерами версий/хэшами, чтобы их URL были разными

Популярные фреймворки, использующие кэширование:

  • Magento 2
  • Добавьте свой собственный здесь!

Синопсис

http {
    server {
        location /static/ {
            immutable on;
        }
    }
}

это приведет к следующим HTTP заголовкам:

...
Cache-Control: public,max-age=31536000,stale-while-revalidate=31536000,stale-if-error=31536000,immutable
Expires: Thu, 31 Dec 2037 23:55:55 GMT
...

Чем это отличается от expires max;:

  • Устанавливает атрибут immutable, например, Cache-Control: public,max-age=31536000,immutable для улучшенного кэширования. Это 1 год, а не 10 лет, см. почему ниже.
  • Отправляет Expires только тогда, когда это действительно необходимо, например, когда клиент запрашивает ресурсы через HTTP/1.0
  • Устанавливает атрибут public, чтобы гарантировать, что ресурсы могут кэшироваться публичными кэшами, что обычно является желаемым.

Из-за недостаточной поддержки immutable в браузерах на основе Chromium, мы также добавляем stale-while-revalidate=31536000,stale-if-error=31536000, что помогает улучшить коэффициент попадания в кэш в крайних случаях. Использование этих директив позволяет обслуживать кэшированные ответы за пределами их срока действия, который в случае неизменяемых ресурсов составляет вечность.

Таким образом, в большинстве случаев immutable on; можно использовать как лучшую альтернативу expires max; для реализации паттерна кэширования.

Почему 31536000 секунд (1 год?)

RFC определяет использование одного года для обозначения ответа как "никогда не истекает":

Чтобы отметить ответ как «никогда не истекает», сервер-источник отправляет дату Expires примерно через год с момента отправки ответа. HTTP/1.1 серверы НЕ ДОЛЖНЫ отправлять даты Expires более чем на год вперед.

Более подробная информация в статье.

Пример: конфигурация для продакшена Magento 2

При условии, что ваш магазин работает в режиме продакшена, вы уже скомпилировали все ресурсы. Этот пример конфигурации можно оптимизировать до:

location /static/ {
    immutable on;

    # Удалить подпись статических файлов, которая используется для обхода кэша браузера
    location ~ ^/static/version {
        rewrite ^/static/(version\d*/)?(.*)$ /static/$2 last;
    }

    location ~* \.(ico|jpg|jpeg|png|gif|svg|js|css|swf|eot|ttf|otf|woff|woff2|json)$ {
        add_header X-Frame-Options "SAMEORIGIN";
    }
    location ~* \.(zip|gz|gzip|bz2|csv|xml)$ {
        add_header Cache-Control "no-store";
        add_header X-Frame-Options "SAMEORIGIN";
        immutable off;
    }
    add_header X-Frame-Options "SAMEORIGIN";
}

При использовании вместе с ngx_security_headers это можно упростить еще больше:

security_headers on;

location /static/ {
    immutable on;

    location ~ ^/static/version {
        rewrite ^/static/(version\d*/)?(.*)$ /static/$2 last;
    }

    location ~* \.(zip|gz|gzip|bz2|csv|xml)$ {
        add_header Cache-Control "no-store";
        immutable off;
    }
}

GitHub

Вы можете найти дополнительные советы по конфигурации и документацию для этого модуля в репозитории GitHub для nginx-module-immutable.