Middleware di Caching delle Risposte in ASP.NET Core

Questo articolo illustra come configurare il middleware di memorizzazione nella cache delle risposte in un'app core ASP.NET. Il middleware determina quando le risposte sono memorizzabili nella cache, archivia le risposte e le serve dalla cache. Per un'introduzione alla memorizzazione nella cache HTTP e all'attributo [ResponseCache] , vedere Memorizzazione nella cache delle risposte.

Il middleware di memorizzazione nella cache della risposta consente la memorizzazione nella cache delle risposte del server in base alle intestazioni HTTP Cache-Control.

• Il comportamento di memorizzazione nella cache implementa la semantica di memorizzazione nella cache HTTP standard.

• La memorizzazione nella cache si basa su intestazioni della cache HTTP simili al metodo usato dai proxy.

• Questa forma di memorizzazione nella cache è utile per le richieste API GET o HEAD pubbliche dai client in cui vengono soddisfatte le condizioni per la memorizzazione nella cache .

• Per le app dell'interfaccia utente come Razor Pages, la memorizzazione nella cache delle risposte non è in genere utile. I browser impostano comunemente le intestazioni di richiesta che impediscono la memorizzazione nella cache.

  Output caching (disponibile in .NET 7 e versioni successive) è un approccio migliore per le app dell'interfaccia utente. In questo scenario, la configurazione determina cosa memorizzare nella cache indipendentemente dalle intestazioni HTTP.

Per testare la memorizzazione nella cache delle risposte, usare Fiddler o un altro strumento in grado di impostare in modo esplicito le intestazioni della richiesta. L'impostazione esplicita delle intestazioni è preferibile per il test della memorizzazione nella cache. Per altre informazioni, vedere Risoluzione dei problemi relativi al middleware > di memorizzazione nella cache delle risposte.

Configuration

In Program.cs aggiungere i servizi di middleware per la cache delle risposte alla raccolta di servizi AddResponseCaching e configurare l'app per utilizzare il middleware con il metodo di estensione UseResponseCaching. UseResponseCaching aggiunge il middleware alla pipeline di elaborazione delle richieste:

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddResponseCaching();

var app = builder.Build();

app.UseHttpsRedirection();

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

app.UseResponseCaching();

L'app di esempio aggiunge intestazioni HTTP per controllare la memorizzazione nella cache delle richieste successive.

• Cache-Control: memorizza nella cache le risposte memorizzabili nella cache per un massimo di 10 secondi.
• Variare: configura il middleware per gestire una risposta memorizzata nella cache solo se l'intestazione Accept-Encoding delle richieste successive corrisponde a quella della richiesta originale.

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();

Le intestazioni precedenti non vengono scritte nella risposta e vengono sottoposte a override quando un controller, un'azione o Razor una pagina:

• Ha un attributo [ResponseCache]. Questo vale anche se una proprietà non è impostata. Se ad esempio si omette la proprietà VaryByHeader , l'intestazione corrispondente verrà rimossa dalla risposta.

Il middleware di memorizzazione nella cache della risposta memorizza nella cache solo le risposte del server che generano un codice di stato 200 (OK). Tutte le altre risposte, incluse le pagine di errore, vengono ignorate dal middleware.

Il codice precedente in genere non restituisce un valore memorizzato nella cache in un browser. Usare Fiddler o un altro strumento in grado di impostare in modo esplicito le intestazioni delle richieste ed è preferibile per il test della memorizzazione nella cache. Per altre informazioni, vedere Risoluzione dei problemi in questo articolo.

Options

Le opzioni di memorizzazione nella cache delle risposte sono illustrate nella tabella seguente.

L'esempio seguente configura il middleware per:

• Memorizzare nella cache le risposte con dimensione del contenuto inferiore o uguale a 1.024 byte.
• Archiviare le risposte in base ai percorsi con distinzione tra maiuscole e minuscole. Ad esempio, /page1 e /Page1 vengono archiviati separatamente.

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

Quando si usano modelli di pagina MVC, controller API Web o Razor Pagine, l'attributo [ResponseCache] specifica i parametri necessari per impostare le intestazioni appropriate per la memorizzazione nella cache delle risposte. L'unico parametro dell'attributo [ResponseCache] che richiede rigorosamente il middleware è VaryByQueryKeys, che non corrisponde a un'intestazione HTTP effettiva. Per altre informazioni, vedere Memorizzazione nella cache delle risposte in ASP.NET Core.

Se non si utilizza l'attributo [ResponseCache], la memorizzazione nella cache delle risposte può essere variata con VaryByQueryKeys. Utilizza il ResponseCachingFeature direttamente da HttpContext.Features:

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

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

L'uso di un singolo valore uguale a * in VaryByQueryKeys varia la cache in base a tutti i parametri di query della richiesta.

Intestazioni HTTP utilizzate dal middleware di cache delle risposte

Nella tabella seguente vengono fornite informazioni sulle intestazioni HTTP che influiscono sulla memorizzazione nella cache delle risposte.

La memorizzazione nella cache rispetta le direttive cache-control della richiesta

Il middleware rispetta le regole di RFC 9111: memorizzazione nella cache HTTP (sezione 5.2). Cache-Control). Le regole richiedono una cache per rispettare un'intestazione valida Cache-Control inviata dal client. In base alla specifica, un client può effettuare richieste con un no-cache valore di intestazione e forzare il server a generare una nuova risposta per ogni richiesta. Attualmente, non esiste alcun controllo dello sviluppatore su questo comportamento di memorizzazione nella cache quando si usa il middleware perché il middleware è conforme alla specifica ufficiale di memorizzazione nella cache.

Per un maggiore controllo sul comportamento di memorizzazione nella cache, esplorare altre funzionalità di memorizzazione nella cache di ASP.NET Core. Vedi gli argomenti seguenti:

• Cache in memoria in ASP.NET Core
• Memorizzazione nella cache distribuita in ASP.NET Core
• Tag Helper Cache in ASP.NET Core MVC
• Tag Helper per cache distribuita in ASP.NET Core

Troubleshooting

Il middleware di memorizzazione nella cache delle risposte usa IMemoryCache, che ha una capacità limitata. Quando viene superata la capacità, la cache di memoria viene compattata (TriggerOvercapacityCompaction).

Se il comportamento di memorizzazione nella cache non è quello previsto, verificare che le risposte siano memorizzabili nella cache e in grado di essere gestite dalla cache. Esaminare le intestazioni in ingresso della richiesta e le intestazioni in uscita della risposta. Abilitare la registrazione per facilitare il debug.

Durante il test e la risoluzione dei problemi relativi al comportamento di memorizzazione nella cache, un browser imposta in genere le intestazioni di richiesta che impediscono la memorizzazione nella cache. Ad esempio, un browser può impostare l'intestazione Cache-Control su no-cache o max-age=0 quando si aggiorna una pagina. Fiddler e altri strumenti possono impostare in modo esplicito le intestazioni delle richieste e sono preferiti per il test della memorizzazione nella cache.

Condizioni per la memorizzazione nella cache

• La richiesta deve generare una risposta del server con un codice di stato 200 (OK).
• Il metodo della richiesta deve essere GET o HEAD.
• Il middleware di memorizzazione nella cache della risposta deve essere inserito prima del middleware che richiede la memorizzazione nella cache. Per altre informazioni, vedere Middleware ASP.NET Core.
• L'intestazione Authorization non deve essere presente.
• Cache-ControlI parametri di intestazione devono essere validi e la risposta deve essere contrassegnata public e non contrassegnata private.
• L'intestazione Pragma: no-cache non deve essere presente se l'intestazione Cache-Control non è presente, perché l'intestazione esegue l'override Cache-Control dell'intestazione Pragma quando presente.
• L'intestazione Set-Cookie non deve essere presente.
• Vary I parametri di intestazione devono essere validi e non uguali a *.
• Il Content-Length valore dell'intestazione (se impostato) deve corrispondere alle dimensioni del corpo della risposta.
• L'oggetto IHttpSendFileFeature non viene usato.
• La risposta non deve essere obsoleta come specificato dall'intestazione Expires e dalle max-age direttive della cache e s-maxage .
• La bufferizzazione della risposta deve riuscire. Le dimensioni della risposta devono essere inferiori a quelle configurate o predefinite SizeLimit. Le dimensioni del corpo della risposta devono essere inferiori a quelle configurate o predefinite MaximumBodySize.
• La risposta deve essere memorizzata nella cache in base a RFC 9111: memorizzazione nella cache HTTP. Ad esempio, la no-store direttiva non deve esistere nei campi di intestazione della richiesta o della risposta. Per informazioni dettagliate, vedere RFC 9111: Memorizzazione nella cache HTTP (sezione 3: Archiviazione di risposte nelle cache ).

Risorse aggiuntive

• Visualizzare o scaricare il codice di esempio (procedura per il download)
• Codice sorgente GitHub per IResponseCachingPolicyProvider
• Origine GitHub per IResponseCachingPolicyProvider
• Avvio dell'app in ASP.NET Core
• Middleware di ASP.NET Core
• Cache in memoria in ASP.NET Core
• Memorizzazione nella cache distribuita in ASP.NET Core
• Rilevare le modifiche con i token di modifica in ASP.NET Core
• Memorizzazione nella cache delle risposte in ASP.NET Core
• Tag Helper Cache in ASP.NET Core MVC
• Tag Helper per cache distribuita in ASP.NET Core

Questo articolo spiega come configurare il middleware di caching delle risposte in un'app ASP.NET Core. Il middleware determina quando le risposte sono memorizzabili nella cache, archivia le risposte e le serve dalla cache. Per un'introduzione alla memorizzazione nella cache HTTP e all'attributo [ResponseCache] , vedere Memorizzazione nella cache delle risposte.

Visualizzare o scaricare il codice di esempio (procedura per il download)

Configuration

Il middleware di memorizzazione nella cache delle risposte è disponibile in modo implicito per ASP.NET app Core tramite il framework condiviso.

In Startup.ConfigureServicesaggiungere il middleware di memorizzazione nella cache delle risposte alla raccolta di servizi:

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

Configurare l'app per utilizzare il middleware con il metodo di estensione UseResponseCaching, che aggiunge il middleware alla pipeline di elaborazione delle richieste in 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();
    });
}

L'app di esempio aggiunge intestazioni HTTP per controllare la memorizzazione nella cache delle richieste successive.

• Cache-Control: memorizza nella cache le risposte memorizzabili nella cache per un massimo di 10 secondi.
• Variare: configura il middleware per gestire una risposta memorizzata nella cache solo se l'intestazione Accept-Encoding delle richieste successive corrisponde a quella della richiesta originale.

// 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();
});

Le intestazioni precedenti non vengono scritte nella risposta e vengono sottoposte a override quando un controller, un'azione o Razor una pagina:

• Ha un attributo [ResponseCache]. Questo vale anche se una proprietà non è impostata. Se ad esempio si omette la proprietà VaryByHeader , l'intestazione corrispondente verrà rimossa dalla risposta.

Il middleware di memorizzazione nella cache della risposta memorizza nella cache solo le risposte del server che generano un codice di stato 200 (OK). Tutte le altre risposte, incluse le pagine di errore, vengono ignorate dal middleware.

Options

Le opzioni di memorizzazione nella cache delle risposte sono illustrate nella tabella seguente.

L'esempio seguente configura il middleware per:

• Memorizzare nella cache le risposte con dimensione del contenuto inferiore o uguale a 1.024 byte.
• Archiviare le risposte in base ai percorsi con distinzione tra maiuscole e minuscole. Ad esempio, /page1 e /Page1 vengono archiviati separatamente.

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

VaryByQueryKeys

Quando si usano controller API MVC/Web o Razor modelli di pagina Pagine, l'attributo [ResponseCache] specifica i parametri necessari per impostare le intestazioni appropriate per la memorizzazione nella cache delle risposte. L'unico parametro dell'attributo [ResponseCache] che richiede rigorosamente il middleware è VaryByQueryKeys, che non corrisponde a un'intestazione HTTP effettiva. Per altre informazioni, vedere Memorizzazione nella cache delle risposte in ASP.NET Core.

Se non si utilizza l'attributo [ResponseCache], la memorizzazione nella cache delle risposte può essere variata con VaryByQueryKeys. Utilizza il ResponseCachingFeature direttamente da HttpContext.Features:

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

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

L'uso di un singolo valore uguale a * in VaryByQueryKeys varia la cache in base a tutti i parametri di query della richiesta.

Intestazioni HTTP utilizzate dal middleware di cache delle risposte

Nella tabella seguente vengono fornite informazioni sulle intestazioni HTTP che influiscono sulla memorizzazione nella cache delle risposte.

La memorizzazione nella cache rispetta le direttive cache-control della richiesta

Il middleware rispetta le regole di RFC 9111: memorizzazione nella cache HTTP (sezione 5.2). Cache-Control). Le regole richiedono una cache per rispettare un'intestazione valida Cache-Control inviata dal client. In base alla specifica, un client può effettuare richieste con un no-cache valore di intestazione e forzare il server a generare una nuova risposta per ogni richiesta. Attualmente, non esiste alcun controllo dello sviluppatore su questo comportamento di memorizzazione nella cache quando si usa il middleware perché il middleware è conforme alla specifica ufficiale di memorizzazione nella cache.

Per un maggiore controllo sul comportamento di memorizzazione nella cache, esplorare altre funzionalità di memorizzazione nella cache di ASP.NET Core. Vedi gli argomenti seguenti:

• Cache in memoria in ASP.NET Core
• Memorizzazione nella cache distribuita in ASP.NET Core
• Tag Helper Cache in ASP.NET Core MVC
• Tag Helper per cache distribuita in ASP.NET Core

Troubleshooting

Se il comportamento di memorizzazione nella cache non è quello previsto, verificare che le risposte siano memorizzabili nella cache e in grado di essere gestite dalla cache. Esaminare le intestazioni in ingresso della richiesta e le intestazioni in uscita della risposta. Abilitare la registrazione per facilitare il debug.

Durante i test e la risoluzione dei problemi relativi al comportamento di memorizzazione nella cache, un browser può impostare intestazioni di richiesta che influiscono sulla memorizzazione nella cache in modi indesiderati. Ad esempio, un browser può impostare l'intestazione Cache-Control su no-cache o max-age=0 quando si aggiorna una pagina. Gli strumenti seguenti possono impostare in modo esplicito le intestazioni delle richieste e sono preferibili per il test della memorizzazione nella cache:

• Fiddler

Condizioni per la memorizzazione nella cache

• La richiesta deve generare una risposta del server con un codice di stato 200 (OK).
• Il metodo della richiesta deve essere GET o HEAD.
• In Startup.Configure, il middleware per la memorizzazione nella cache delle risposte deve essere posizionato prima del middleware che necessita della memorizzazione nella cache. Per altre informazioni, vedere Middleware ASP.NET Core.
• L'intestazione Authorization non deve essere presente.
• Cache-ControlI parametri di intestazione devono essere validi e la risposta deve essere contrassegnata public e non contrassegnata private.
• L'intestazione Pragma: no-cache non deve essere presente se l'intestazione Cache-Control non è presente, perché l'intestazione esegue l'override Cache-Control dell'intestazione Pragma quando presente.
• L'intestazione Set-Cookie non deve essere presente.
• Vary I parametri di intestazione devono essere validi e non uguali a *.
• Il Content-Length valore dell'intestazione (se impostato) deve corrispondere alle dimensioni del corpo della risposta.
• L'oggetto IHttpSendFileFeature non viene usato.
• La risposta non deve essere obsoleta come specificato dall'intestazione Expires e dalle max-age direttive della cache e s-maxage .
• La bufferizzazione della risposta deve riuscire. Le dimensioni della risposta devono essere inferiori a quelle configurate o predefinite SizeLimit. Le dimensioni del corpo della risposta devono essere inferiori a quelle configurate o predefinite MaximumBodySize.
• La risposta deve essere memorizzata nella cache in base a RFC 9111: memorizzazione nella cache HTTP. Ad esempio, la no-store direttiva non deve esistere nei campi di intestazione della richiesta o della risposta. Per informazioni dettagliate, vedere RFC 9111: Memorizzazione nella cache HTTP (sezione 3: Archiviazione di risposte nelle cache ).

Risorse aggiuntive

• Avvio dell'app in ASP.NET Core
• Middleware di ASP.NET Core
• Cache in memoria in ASP.NET Core
• Memorizzazione nella cache distribuita in ASP.NET Core
• Rilevare le modifiche con i token di modifica in ASP.NET Core
• Memorizzazione nella cache delle risposte in ASP.NET Core
• Tag Helper Cache in ASP.NET Core MVC
• Tag Helper per cache distribuita in ASP.NET Core