Asistente de etiquetas de caché en ASP.NET Core MVC

  • Artículo

Por Peter Kellner

El asistente de etiquetas de caché proporciona la capacidad para mejorar el rendimiento de la aplicación de ASP.NET Core al permitir almacenar en memoria caché su contenido en el proveedor de caché interno de ASP.NET Core.

Para obtener información general sobre los asistentes de etiquetas, consulte Asistentes de etiquetas en ASP.NET Core.

Este marcado de Razor almacena en caché la fecha actual:

<cache>@DateTime.Now</cache>

La primera solicitud a la página que contiene el asistente de etiquetas muestra la fecha actual. Las solicitudes adicionales muestran el valor almacenado en caché hasta que la memoria caché expira (el valor predeterminado es 20 minutos) o hasta que la fecha almacenada en caché se expulsa de la memoria caché.

Atributos del asistente de etiqueta de caché

enabled

Tipo de atributo Ejemplos Valor predeterminado
Boolean true, false true

enabled determina si se almacena en caché el contenido incluido por el asistente de etiquetas de caché. El valor predeterminado es true. Si establece en false, el resultado representado no se almacena en caché.

Ejemplo:

<cache enabled="true">
    Current Time Inside Cache Tag Helper: @DateTime.Now
</cache>

expires-on

Tipo de atributo Ejemplo
DateTimeOffset @new DateTime(2025,1,29,17,02,0)

expires-on establece una fecha de expiración absoluta para el elemento almacenado en caché.

En este ejemplo se almacena en caché el contenido del asistente de etiquetas de caché hasta las 17:02 del 29 de enero de 2025.

<cache expires-on="@new DateTime(2025,1,29,17,02,0)">
    Current Time Inside Cache Tag Helper: @DateTime.Now
</cache>

expires-after

Tipo de atributo Ejemplo Valor predeterminado
TimeSpan @TimeSpan.FromSeconds(120) 20 minutos

expires-after establece el período de tiempo desde el momento de la primera solicitud para almacenar en caché el contenido.

Ejemplo:

<cache expires-after="@TimeSpan.FromSeconds(120)">
    Current Time Inside Cache Tag Helper: @DateTime.Now
</cache>

El motor de vistas de Razor establece el valor predeterminado expires-after en veinte minutos.

expires-sliding

Tipo de atributo Ejemplo
TimeSpan @TimeSpan.FromSeconds(60)

Establece la hora en que se debe expulsar una entrada de caché si no se ha accedido a su valor.

Ejemplo:

<cache expires-sliding="@TimeSpan.FromSeconds(60)">
    Current Time Inside Cache Tag Helper: @DateTime.Now
</cache>

vary-by-header

Tipo de atributo Ejemplos
String User-Agent, User-Agent,content-encoding

vary-by-header acepta una lista de los valores de encabezado separados por comas que desencadenan una actualización de la caché cuando cambian.

En el ejemplo siguiente se supervisa el valor del encabezado User-Agent. En el ejemplo se almacena en caché el contenido de cada User-Agent diferente que se presenta al servidor web:

<cache vary-by-header="User-Agent">
    Current Time Inside Cache Tag Helper: @DateTime.Now
</cache>

vary-by-query

Tipo de atributo Ejemplos
String Make, Make,Model

vary-by-query acepta una lista de valores separados por comas de Keys en una cadena de consulta (Query) que desencadenan una actualización de la caché cuando cambia el valor de cualquiera de las claves.

En este ejemplo se supervisan los valores de Make y Model. En el ejemplo se almacena en caché el contenido de cada Make y Modeldiferente que se presenta al servidor web:

<cache vary-by-query="Make,Model">
    Current Time Inside Cache Tag Helper: @DateTime.Now
</cache>

vary-by-route

Tipo de atributo Ejemplos
String Make, Make,Model

vary-by-route acepta una lista delimitada por comas de nombres de parámetros de ruta que desencadenan una actualización de la caché cuando el valor del parámetro de datos de ruta cambia.

Ejemplo:

Startup.cs:

routes.MapRoute(
    name: "default",
    template: "{controller=Home}/{action=Index}/{Make?}/{Model?}");

Index.cshtml:

<cache vary-by-route="Make,Model">
    Current Time Inside Cache Tag Helper: @DateTime.Now
</cache>
Tipo de atributo Ejemplos
String .AspNetCore.Identity.Application, .AspNetCore.Identity.Application,HairColor

vary-by-cookie acepta una lista delimitada por comas de nombres de cookie que desencadenan una actualización de la caché cuando los valores de las cookie cambian.

En este ejemplo se supervisa la cookie asociada con ASP.NET Core Identity. Cuando se autentica un usuario, un cambio en la cookie de Identity desencadena una actualización de caché:

<cache vary-by-cookie=".AspNetCore.Identity.Application">
    Current Time Inside Cache Tag Helper: @DateTime.Now
</cache>

vary-by-user

Tipo de atributo Ejemplos Valor predeterminado
Boolean true, false true

vary-by-user especifica la memoria caché se restablece o no cuando cambia el usuario que ha iniciado la sesión (o la entidad de seguridad del contexto). El usuario actual también se conoce como entidad de seguridad del contexto de solicitud y puede verse en una vista Razor mediante una referencia a @User.Identity.Name.

En este ejemplo se supervisa el usuario actual que ha iniciado sesión para desencadenar una actualización de caché:

<cache vary-by-user="true">
    Current Time Inside Cache Tag Helper: @DateTime.Now
</cache>

Con este atributo, se mantiene el contenido en caché a través de un ciclo de inicio y cierre de sesión. Cuando el valor se establece en true, un ciclo de autenticación invalida la memoria caché para el usuario autenticado. Se invalida la memoria caché porque se genera un nuevo valor único de cookie cuando se autentica un usuario. Se mantiene la memoria caché para el estado anónimo cuando no hay ninguna cookie o la cookie ha expirado. Si no se autentica el usuario, se mantiene la memoria caché.

vary-by

Tipo de atributo Ejemplo
String @Model

vary-by permite personalizar qué datos se almacenan en caché. Cuando el objeto al que hace referencia el valor de cadena del atributo cambia, el contenido del asistente de etiqueta de caché se actualiza. A menudo se asignan a este atributo una concatenación de cadenas de valores del modelo. De hecho, esto provoca una situación en la que una actualización de cualquiera de los valores concatenados invalida la memoria caché.

En este ejemplo se supone que el método de controlador que representa la vista suma el valor del entero de los dos parámetros de ruta, myParam1 y myParam2, y devuelve el resultado de la suma como la propiedad de modelo simple. Cuando se cambia esta suma, el contenido del asistente de etiqueta de caché se representa y almacena en caché de nuevo.

Acción:

public IActionResult Index(string myParam1, string myParam2, string myParam3)
{
    int num1;
    int num2;
    int.TryParse(myParam1, out num1);
    int.TryParse(myParam2, out num2);
    return View(viewName, num1 + num2);
}

Index.cshtml:

<cache vary-by="@Model">
    Current Time Inside Cache Tag Helper: @DateTime.Now
</cache>

priority

Tipo de atributo Ejemplos Valor predeterminado
CacheItemPriority High, Low, NeverRemove, Normal Normal

priority proporciona instrucciones de expulsión de caché para el proveedor de caché integrado. El servidor web expulsa primero las entradas de caché Low cuando está bajo presión de memoria.

Ejemplo:

<cache priority="High">
    Current Time Inside Cache Tag Helper: @DateTime.Now
</cache>

El atributo priority no garantiza un nivel específico de retención de la memoria caché. CacheItemPriority es solo una sugerencia. Establecer este atributo en NeverRemove no garantiza que siempre se conserven los elementos en la memoria caché. Para más información, eche un vistazo a los temas de la sección Recursos adicionales.

El asistente de etiquetas de caché es dependiente del servicio de caché de memoria. El asistente de etiquetas de caché agrega el servicio si no se ha agregado.

Recursos adicionales