Промежуточное ПО для кэширования ответов в ASP.NET Core

Статья объясняет, как настроить промежуточное ПО кэширования ответов в приложении ASP.NET Core. Промежуточное ПО определяет, когда ответы могут быть кэшированы, сохраняет их и предоставляет из кэша. Общие сведения о кэшировании HTTP и [ResponseCache] атрибуте см. в разделе "Кэширование ответов".

Промежуточное программное обеспечение для кэширования ответов включает кэширование ответов сервера на основе заголовков HTTP Cache-Control.

• Поведение кэширования реализует стандартную семантику кэширования HTTP.

• Кэширование основано на заголовках кэша HTTP, аналогичных методу, используемому прокси-серверами.

• Эта форма кэширования полезна для общедоступных запросов GET или HEAD API от клиентов, в которых выполнены условия кэширования .

• Для приложений пользовательского интерфейса, таких как Razor Pages, кэширование ответов обычно не является полезным. Браузеры обычно задают заголовки запросов, которые предотвращают кэширование.

  Кэширование вывода (доступно в .NET 7 и более поздних версиях) является лучшим подходом для приложений пользовательского интерфейса. В этом сценарии конфигурация определяет, что кэшировать независимо от заголовков HTTP.

Чтобы проверить кэширование ответов, используйте Fiddler или другое средство, которое может явно задать заголовки запросов. Для тестирования кэширования предпочтительнее явно задать заголовки. Дополнительные сведения см. в разделе "Устранение неполадок промежуточного слоя кэширования ответов>".

Configuration

Добавьте службы промежуточного слоя для кэширования ответа Program.cs в коллекцию служб AddResponseCaching и настройте приложение для использования промежуточного слоя методом расширения UseResponseCaching. UseResponseCaching добавляет ПО промежуточного слоя в конвейер обработки запросов:

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddResponseCaching();

var app = builder.Build();

app.UseHttpsRedirection();

// UseCors must be called before UseResponseCaching
//app.UseCors();

app.UseResponseCaching();

Пример приложения добавляет заголовки для управления кэшированием при последующих запросах:

• Cache-Control: кэширует кэшируемые ответы до 10 секунд.
• Vary: Настраивает посредническое программное обеспечение для обслуживания кэшированного ответа только в том случае, если заголовок Accept-Encoding последующих запросов соответствует заголовку исходного запроса.

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddResponseCaching();

var app = builder.Build();

app.UseHttpsRedirection();

// UseCors must be called before UseResponseCaching
//app.UseCors();

app.UseResponseCaching();

app.Use(async (context, next) =>
{
    context.Response.GetTypedHeaders().CacheControl =
        new Microsoft.Net.Http.Headers.CacheControlHeaderValue()
        {
            Public = true,
            MaxAge = TimeSpan.FromSeconds(10)
        };
    context.Response.Headers[Microsoft.Net.Http.Headers.HeaderNames.Vary] =
        new string[] { "Accept-Encoding" };

    await next();
});

app.MapGet("/", () => DateTime.Now.Millisecond);

app.Run();

Предыдущие заголовки не записываются в ответ и переопределяются при выполнении контроллера, действия или Razor страницы.

• Имеет атрибут [ResponseCache]. Это применимо, даже если свойство не задано. Например, опущение свойства VaryByHeader приведет к удалению соответствующего заголовка из ответа.

Промежуточное ПО для кэширования ответов кэширует только те ответы сервера, которые имеют код состояния 200 (ОК). Любые другие ответы, включая страницы ошибок, игнорируются ПО промежуточного слоя.

Предыдущий код обычно не возвращает кэшированное значение в браузер. Используйте Fiddler или другое средство, которое может явно задать заголовки запросов и предпочтительнее для тестирования кэширования. Для получения дополнительной информации см. раздел Устранение неполадок в этой статье.

Options

Параметры кэширования ответов показаны в следующей таблице.

Следующий пример настраивает ПО промежуточного слоя следующим образом:

• Кэшировать ответы с размером тела, не превышающим 1 024 байта.
• Сохраните ответы по путям с учетом регистра. Например, /page1 и /Page1 хранятся отдельно.

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddResponseCaching(options =>
{
    options.MaximumBodySize = 1024;
    options.UseCaseSensitivePaths = true;
});

var app = builder.Build();

app.UseHttpsRedirection();

// UseCors must be called before UseResponseCaching
//app.UseCors();

app.UseResponseCaching();

app.Use(async (context, next) =>
{
    context.Response.GetTypedHeaders().CacheControl =
        new Microsoft.Net.Http.Headers.CacheControlHeaderValue()
        {
            Public = true,
            MaxAge = TimeSpan.FromSeconds(10)
        };
    context.Response.Headers[Microsoft.Net.Http.Headers.HeaderNames.Vary] =
        new string[] { "Accept-Encoding" };

    await next(context);
});

app.MapGet("/", () => DateTime.Now.Millisecond);

app.Run();

VaryByQueryKeys

При использовании MVC, контроллеров веб-API или моделей страниц Razor атрибут [ResponseCache] указывает параметры, необходимые для задания соответствующих заголовков для кэширования ответов. Единственным параметром [ResponseCache] атрибута, который строго требуется промежуточным слоем, является VaryByQueryKeys, что не соответствует фактическому заголовку HTTP. Дополнительные сведения см. в статье Кэширование ответов в ASP.NET Core.

Когда атрибут [ResponseCache] не используется, кэширование ответов может варьироваться с помощью VaryByQueryKeys. Использовать ResponseCachingFeature напрямую из HttpContext.Features:

var responseCachingFeature = context.HttpContext.Features.Get<IResponseCachingFeature>();

if (responseCachingFeature != null)
{
    responseCachingFeature.VaryByQueryKeys = new[] { "MyKey" };
}

Использование одного значения, равного *, в VaryByQueryKeys, изменяет кэш в зависимости от всех параметров запроса.

Заголовки HTTP, используемые промежуточным слоем кэширования ответов

В следующей таблице содержатся сведения о заголовках HTTP, влияющих на кэширование ответов.

Кэширование учитывает директивы Cache-Control для запросов

ПО промежуточного слоя учитывает правила RFC 9111: кэширование HTTP (раздел 5.2. Cache-Control). Правила требуют от кэша уважать допустимые Cache-Control заголовки, отправленные клиентом. В соответствии со спецификацией клиент может выполнять запросы со значением заголовка no-cache и заставлять сервер создавать новый ответ для каждого запроса. В настоящее время разработчики не могут контролировать это поведение кэширования при использовании промежуточного ПО, так как оно соответствует официальной спецификации кэширования.

Чтобы получить больше контроля над поведением кэширования, изучите другие функции кэширования в ASP.NET Core. См. следующие разделы:

• Кэширование в памяти в ASP.NET Core
• Распределенное кэширование в ASP.NET Core
• Вспомогательный компонент тега кэша в ASP.NET Core MVC
• Вспомогательный компонент тега распределенного кэша в ASP.NET Core

Troubleshooting

По промежуточному ПО кэширования ответа используется IMemoryCache, которое имеет ограниченную емкость. При превышении емкости кэш памяти сжимается (TriggerOvercapacityCompaction).

Если поведение кэширования не так ожидаемо, убедитесь, что ответы кэшируются и могут обслуживаться из кэша. Проверьте входящие заголовки запроса и исходящие заголовки ответа. Включите ведение журнала для отладки.

При тестировании и устранении неполадок при кэшировании браузер обычно задает заголовки запросов, которые препятствуют кэшированию. Браузер может задать заголовок Cache-Control на no-cache или max-age=0 при обновлении страницы. Fiddler и другие инструменты могут настраивать заголовки запросов и предпочтительны для тестирования кэширования.

Условия кэширования

• Запрос должен привести к ответу сервера с кодом состояния 200 (ОК).
• Метод запроса должен быть GET или HEAD.
• Промежуточное ПО для кэширования ответов должно быть размещено перед промежуточным ПО, которое требует кэширования. Дополнительные сведения см. в статье ПО промежуточного слоя ASP.NET Core.
• Заголовок Authorization не должен присутствовать.
• Cache-Control Параметры заголовка должны быть допустимыми, а ответ должен быть помечен public и не помечен private.
• Заголовок Pragma: no-cache не должен присутствовать, если заголовок Cache-Control отсутствует, поскольку заголовок Cache-Control переопределяет заголовок Pragma, если он присутствует.
• Заголовок Set-Cookie не должен присутствовать.
• Vary Параметры заголовка должны быть допустимыми и не равными *.
• Значение Content-Length заголовка (если задано) должно соответствовать размеру текста ответа.
• IHttpSendFileFeature не используется.
• Ответ не должен быть устаревшим Expires , как указано в заголовке и max-ages-maxage директивах кэша.
• Буферизация ответов должна быть успешной. Размер ответа должен быть меньше настроенного или по умолчанию SizeLimit. Размер текста ответа должен быть меньше настроенного или по умолчанию MaximumBodySize.
• Ответ должен быть кэшируемым в соответствии с RFC 9111: кэширование HTTP. Например, директива no-store не должна существовать в полях заголовка запроса или ответа. Дополнительные сведения см. в разделе RFC 9111: кэширование HTTP (раздел 3. Хранение ответов в кэшах ).

Дополнительные ресурсы

• Просмотреть или скачать образец кода (описание загрузки)
• Источник GitHub для IResponseCachingPolicyProvider
• Источник GitHub для IResponseCachingPolicyProvider
• Запуск приложения в ASP.NET Core
• ASP.NET Core Middleware
• Кэширование в памяти в ASP.NET Core
• Распределенное кэширование в ASP.NET Core
• Обнаружение изменений с помощью маркеров изменений в ASP.NET Core
• Кэширование ответов в ASP.NET Core
• Вспомогательный компонент тега кэша в ASP.NET Core MVC
• Вспомогательный компонент тега распределенного кэша в ASP.NET Core

В этой статье объясняется, как настроить промежуточное программное обеспечение для кэширования ответов в приложении ASP.NET Core. Промежуточное ПО определяет, когда ответы могут быть кэшированы, сохраняет их и предоставляет из кэша. Общие сведения о кэшировании HTTP и [ResponseCache] атрибуте см. в разделе "Кэширование ответов".

Просмотреть или скачать образец кода (описание загрузки)

Configuration

Промежуточное ПО кэширования ответов неявно предоставляется для приложений ASP.NET Core через общий фреймворк.

Добавьте ПО промежуточного слоя кэширования ответов Startup.ConfigureServices в коллекцию служб:

public void ConfigureServices(IServiceCollection services)
{
    services.AddResponseCaching();
    services.AddRazorPages();
}

Настройте приложение для использования промежуточного ПО с UseResponseCaching методом расширения, которое добавляет промежуточное ПО в конвейер обработки запросов в Startup.Configure:

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }
    else
    {
        app.UseExceptionHandler("/Error");
    }

    app.UseStaticFiles();
    app.UseRouting();
    // UseCors must be called before UseResponseCaching
    // app.UseCors("myAllowSpecificOrigins");

    app.UseResponseCaching();

    app.Use(async (context, next) =>
    {
        context.Response.GetTypedHeaders().CacheControl = 
            new Microsoft.Net.Http.Headers.CacheControlHeaderValue()
            {
                Public = true,
                MaxAge = TimeSpan.FromSeconds(10)
            };
        context.Response.Headers[Microsoft.Net.Http.Headers.HeaderNames.Vary] = 
            new string[] { "Accept-Encoding" };

        await next();
    });

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapRazorPages();
    });
}

Пример приложения добавляет заголовки для управления кэшированием при последующих запросах:

• Cache-Control: кэширует кэшируемые ответы до 10 секунд.
• Vary: Настраивает посредническое программное обеспечение для обслуживания кэшированного ответа только в том случае, если заголовок Accept-Encoding последующих запросов соответствует заголовку исходного запроса.

// using Microsoft.AspNetCore.Http;

app.Use(async (context, next) =>
{
    context.Response.GetTypedHeaders().CacheControl = 
        new Microsoft.Net.Http.Headers.CacheControlHeaderValue()
        {
            Public = true,
            MaxAge = TimeSpan.FromSeconds(10)
        };
    context.Response.Headers[Microsoft.Net.Http.Headers.HeaderNames.Vary] = 
        new string[] { "Accept-Encoding" };

    await next();
});

Предыдущие заголовки не записываются в ответ и переопределяются при выполнении контроллера, действия или Razor страницы.

• Имеет атрибут [ResponseCache]. Это применимо, даже если свойство не задано. Например, опущение свойства VaryByHeader приведет к удалению соответствующего заголовка из ответа.

Промежуточное ПО для кэширования ответов кэширует только те ответы сервера, которые имеют код состояния 200 (ОК). Любые другие ответы, включая страницы ошибок, игнорируются ПО промежуточного слоя.

Options

Параметры кэширования ответов показаны в следующей таблице.

Следующий пример настраивает ПО промежуточного слоя следующим образом:

• Кэшировать ответы с размером тела, не превышающим 1 024 байта.
• Сохраните ответы по путям с учетом регистра. Например, /page1 и /Page1 хранятся отдельно.

services.AddResponseCaching(options =>
{
    options.MaximumBodySize = 1024;
    options.UseCaseSensitivePaths = true;
});

VaryByQueryKeys

При использовании контроллеров MVC или Razor моделей страниц веб-API атрибут задает параметры, [ResponseCache] необходимые для задания соответствующих заголовков для кэширования ответов. Единственным параметром [ResponseCache] атрибута, который строго требуется промежуточным слоем, является VaryByQueryKeys, что не соответствует фактическому заголовку HTTP. Дополнительные сведения см. в статье Кэширование ответов в ASP.NET Core.

Когда атрибут [ResponseCache] не используется, кэширование ответов может варьироваться с помощью VaryByQueryKeys. Использовать ResponseCachingFeature напрямую из HttpContext.Features:

var responseCachingFeature = context.HttpContext.Features.Get<IResponseCachingFeature>();

if (responseCachingFeature != null)
{
    responseCachingFeature.VaryByQueryKeys = new[] { "MyKey" };
}

Использование одного значения, равного *, в VaryByQueryKeys, изменяет кэш в зависимости от всех параметров запроса.

Заголовки HTTP, используемые промежуточным слоем кэширования ответов

В следующей таблице содержатся сведения о заголовках HTTP, влияющих на кэширование ответов.

Кэширование учитывает директивы Cache-Control для запросов

ПО промежуточного слоя учитывает правила RFC 9111: кэширование HTTP (раздел 5.2. Cache-Control). Правила требуют от кэша уважать допустимые Cache-Control заголовки, отправленные клиентом. В соответствии со спецификацией клиент может выполнять запросы со значением заголовка no-cache и заставлять сервер создавать новый ответ для каждого запроса. В настоящее время разработчики не могут контролировать это поведение кэширования при использовании промежуточного ПО, так как оно соответствует официальной спецификации кэширования.

Чтобы получить больше контроля над поведением кэширования, изучите другие функции кэширования в ASP.NET Core. См. следующие разделы:

• Кэширование в памяти в ASP.NET Core
• Распределенное кэширование в ASP.NET Core
• Вспомогательный компонент тега кэша в ASP.NET Core MVC
• Вспомогательный компонент тега распределенного кэша в ASP.NET Core

Troubleshooting

Если поведение кэширования не так ожидаемо, убедитесь, что ответы кэшируются и могут обслуживаться из кэша. Проверьте входящие заголовки запроса и исходящие заголовки ответа. Включите ведение журнала для отладки.

При тестировании и устранении неполадок с кэшированием браузер может задать заголовки запросов, влияющие на кэширование нежелательными способами. Браузер может задать заголовок Cache-Control на no-cache или max-age=0 при обновлении страницы. Следующие инструменты могут явно задать заголовки HTTP-запросов и предпочтительнее для тестирования кэширования:

• Fiddler

Условия кэширования

• Запрос должен привести к ответу сервера с кодом состояния 200 (ОК).
• Метод запроса должен быть GET или HEAD.
• Промежуточное программное обеспечение для кэширования ответов должно быть размещено перед промежуточным программным обеспечением, если необходимо кэширование. Дополнительные сведения см. в статье ПО промежуточного слоя ASP.NET Core.
• Заголовок Authorization не должен присутствовать.
• Cache-Control Параметры заголовка должны быть допустимыми, а ответ должен быть помечен public и не помечен private.
• Заголовок Pragma: no-cache не должен присутствовать, если заголовок Cache-Control отсутствует, поскольку заголовок Cache-Control переопределяет заголовок Pragma, если он присутствует.
• Заголовок Set-Cookie не должен присутствовать.
• Vary Параметры заголовка должны быть допустимыми и не равными *.
• Значение Content-Length заголовка (если задано) должно соответствовать размеру текста ответа.
• IHttpSendFileFeature не используется.
• Ответ не должен быть устаревшим Expires , как указано в заголовке и max-ages-maxage директивах кэша.
• Буферизация ответов должна быть успешной. Размер ответа должен быть меньше настроенного или по умолчанию SizeLimit. Размер текста ответа должен быть меньше настроенного или по умолчанию MaximumBodySize.
• Ответ должен быть кэшируемым в соответствии с RFC 9111: кэширование HTTP. Например, директива no-store не должна существовать в полях заголовка запроса или ответа. Дополнительные сведения см. в разделе RFC 9111: кэширование HTTP (раздел 3. Хранение ответов в кэшах ).

Дополнительные ресурсы

• Запуск приложения в ASP.NET Core
• ASP.NET Core Middleware
• Кэширование в памяти в ASP.NET Core
• Распределенное кэширование в ASP.NET Core
• Обнаружение изменений с помощью маркеров изменений в ASP.NET Core
• Кэширование ответов в ASP.NET Core
• Вспомогательный компонент тега кэша в ASP.NET Core MVC
• Вспомогательный компонент тега распределенного кэша в ASP.NET Core