ASP.NET Core와 응답 캐싱 미들웨어

예제 코드 살펴보기 및 다운로드 (다운로드 방법)

본문에서는 ASP.NET Core 응용 프로그램에서 응답 캐싱 미들웨어를 구성하는 방법을 알아봅니다. 응답 캐싱 미들웨어는 응답을 캐싱할 수 있는 시점을 결정하고 응답을 저장하고 캐시에서 가져온 응답을 제공합니다. HTTP 캐싱 및 ResponseCache 특성에 대한 소개는 응답 캐싱을 참고하시기 바랍니다.

패키지

프로젝트에 응답 캐싱 미들웨어를 포함시키려면 Microsoft.AspNetCore.ResponseCaching 패키지에 대한 참조를 추가하거나 Microsoft.AspNetCore.All 패키지를 사용합니다 (.NET Core를 대상으로 할 경우 ASP.NET Core 2.0 이상).

구성

ConfigureServices에서 서비스 컬렉션에 미들웨어를 추가합니다.

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

그리고 미들웨어를 요청 처리 파이프라인에 추가하는 UseResponseCaching 확장 메서드를 이용해서 응용 프로그램이 미들웨어를 사용하도록 구성합니다. 예제 응용 프로그램은 최대 10초 동안 캐시가 응답을 캐싱할 수 있도록 Cache-Control 헤더를 응답에 추가합니다. 또한 Vary 헤더를 전송해서 후속 요청의 Accept-Encoding 헤더가 원본 요청과 일치하는 경우에만 캐시된 응답을 제공하도록 미들웨어를 구성합니다. 다음 예제 코드에서 CacheControlHeaderValue 및 HeaderNames를 사용하려면 Microsoft.Net.Http.Headers 네임스페이스에 대한 using 문이 필요합니다.

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    app.UseResponseCaching();

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

        await next();
    });

    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }

    app.UseStaticFiles();
    app.UseMvc();
}

응답 캐싱 미들웨어는 상태 코드가 200 (정상)인 서버 응답만 캐시합니다. 오류 페이지를 비롯한 다른 모든 응답은 미들웨어에 의해 무시됩니다.

옵션

미들웨어는 응답 캐싱을 제어하기 위한 세 가지 옵션을 제공합니다.

아래 예제는 미들웨어를 다음과 같이 구성합니다:

• 1,024 바이트 이하의 응답을 캐시합니다.
• 경로의 대/소문자를 구분해서 응답을 저장합니다 (예를 들어 /page1과 /Page1을 별도로 저장합니다).

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

VaryByQueryKeys

MVC/Web API 컨트롤러 또는 Razor Pages 페이지 모델을 사용할때 ResponseCache 특성은 응답 캐싱을 위한 적절한 헤더를 설정하기 위해서 필요한 매개 변수를 지정합니다. 미들웨어가 반드시 필요한 ResponseCache 특성의 유일한 매개 변수는 VaryByQueryKeys로, 이 매개 변수는 실제 HTTP 헤더와 일치하지 않습니다. 보다 자세한 정보는 ResponseCache 특성을 참고하시기 바랍니다.

ResponseCache 특성을 사용하지 않을 경우, VaryByQueryKeys 기능을 사용해서 응답 캐싱을 변경할 수 있습니다. HttpContext의 IFeatureCollection을 통해서 직접 ResponseCachingFeature를 사용하십시오:

var responseCachingFeature = context.HttpContext.Features.Get<IResponseCachingFeature>();
if (responseCachingFeature != null)
{
    responseCachingFeature.VaryByQueryKeys = new[] { "MyKey" };
}

VaryByQueryKeys에 *와 동일한 단일 값을 지정하면 모든 요청 쿼리 매개 변수에 의해서 캐시가 변경됩니다.

응답 캐싱 미들웨어에서 사용되는 HTTP 헤더

미들웨어에 의한 응답 캐싱은 HTTP 헤더를 이용해서 구성됩니다.

캐싱은 Cache-Control 지시문을 준수합니다.

미들웨어는 HTTP 1.1 캐싱 사양의 규칙을 준수합니다. 그리고 이 규칙은 캐시가 클라이언트에 의해서 전송된 유효한 Cache-Control 헤더를 준수할 것을 요구합니다. 사양에 따라 클라이언트는 no-cache 헤더 값을 설정한 요청을 전송함으로써 모든 요청에 대해 서버가 새로운 응답을 생성하도록 강제할 수 있습니다. 현재 미들웨어를 사용할 때 이 캐싱 동작을 개발자가 제어할 수 있는 방법은 없으며, 그 이유는 미들웨어가 공식 캐싱 사양을 따르고 있기 때문입니다.

캐싱 동작을 보다 세세히 제어하려면 ASP.NET Core의 다른 캐싱 기능을 살펴보십시오. 다음 항목을 참고하시기 바랍니다:

• 메모리 내 캐시
• 분산 캐시 사용하기
• ASP.NET Core MVC의 캐시 태그 도우미
• 분산 캐시 태그 도우미

문제 해결

캐싱이 예상과 다르게 동작한다면 응답이 캐싱 가능하고 캐시에서 제공될 수 있는지 확인하시기 바랍니다. 요청의 수신 헤더와 응답의 송신 헤더도 점검해보십시오. 디버깅에 도움이 되도록 로깅을 활성화시키기 바랍니다.

캐싱 동작을 테스트하거나 문제를 해결할 때, 브라우저가 원하지 않는 방식으로 캐싱에 영향을 주는 요청 헤더를 설정할 수도 있습니다. 예를 들어 페이지를 새로 고칠 때 브라우저가 Cache-Control 헤더를 no-cache 또는 max-age=0로 설정할 수 있습니다. 다음 도구를 사용하면 명시적으로 요청 헤더를 설정할 수 있고 캐싱 테스트에도 적합합니다:

• Fiddler
• Postman

캐싱 조건

• 요청의 결과로 200 (OK) 상태 코드가 설정된 서버 응답을 받아야 합니다.
• 요청의 메서드가 GET 또는 HEAD여야 합니다.
• 정적 파일 미들웨어 같은 터미널 미들웨어는 반드시 응답 캐싱 미들웨어보다 먼저 응답을 처리해야 합니다.
• Authorization 헤더가 존재하지 않아야 합니다.
• Cache-Control 헤더의 매개 변수가 유효해야 하고 응답이 public으로 표시되어야 하며 private로 표시되지 않아야 합니다.
• Cache-Control 헤더가 존재하지 않으면 Pragma: no-cache 헤더가 존재하지 않아야합니다. Cache-Control 헤더는 Pragma 헤더를 덮어씁니다.
• Set-Cookie 헤더가 존재하지 않아야 합니다.
• Vary 헤더의 매개 변수가 유효해야 하고 *가 아니어야 합니다.
• Content-Length 헤더의 값이 (설정된 경우) 응답 본문의 크기와 일치해야 합니다.
• IHttpSendFileFeature가 사용되지 않아야 합니다.
• 응답이 Expires 헤더와 max-age 및 s-maxage 캐시 지시문에 지정된 것보다 오래되면 안됩니다.
• 응답 버퍼링이 성공해야 하고 응답의 크기가 구성된 SizeLimit나 그 기본값보다 작아야합니다.
• 응답은 RFC 7234 사양에 따라 캐시 가능해야 합니다. 예를 들어 no-store 지시문이 요청 또는 응답 헤더 필드에 없어야 합니다. 자세한 내용은 RFC 7234의 Section 3: Storing Responses in Caches를 참고하시기 바랍니다.

추가 자료

• 응용 프로그램 시작
• 미들웨어
• 메모리 내 캐시
• 분산 캐시 사용하기
• 변경 토큰을 이용해서 변경 감지하기
• 응답 캐싱
• 캐시 태그 도우미
• 분산 캐시 태그 도우미