® integración del almacenamiento en caché de salida de .NET AspireRedis*
Incluye:
integración de hospedaje y integraciónClient
Aprenda a usar la integración del almacenamiento en caché de salida .NET AspireRedis. La integración de
Aprenda a usar la integración de almacenamiento en caché de salida .NET AspireRedis. La integración de
Descubra cómo usar la integración de almacenamiento en caché de salida .NET AspireRedis. La integración de Aspire.StackExchange.Redis.OutputCachingclient se utiliza para registrar un proveedor de almacenamiento en caché de salida ASP.NET Core respaldado por un Valkey server con la imagen de contenedor docker.io/valkey/valkey.
Integración de hospedaje
La integración de hospedaje Redis modela un recurso Redis como el tipo RedisResource. Para acceder a este tipo y a las API que le permiten agregarlo al paquete NuGet de 📦Aspire.Hosting.Redis en el proyecto host de la aplicación .
dotnet add package Aspire.Hosting.Redis
Para obtener más información, consulte dotnet add package o Gestionar dependencias de paquetes en .NET aplicaciones.
Agregar Redis recurso
En el proyecto host de la aplicación, llame a AddRedis en la instancia de builder para agregar un recurso de Redis:
var builder = DistributedApplication.CreateBuilder(args);
var cache = builder.AddRedis("cache");
builder.AddProject<Projects.ExampleProject>()
.WithReference(cache);
// After adding all resources, run the app...
Cuando .NET.NET Aspire agrega una imagen de contenedor al host de la aplicación, como se muestra en el ejemplo anterior con la imagen de docker.io/Redis/Redis, crea una nueva instancia de Redis en el equipo local. Se agrega una referencia al recurso de Redis (la variable cache) al ExampleProject.
El método WithReference configura una conexión en el ExampleProject denominado "cache". Para obtener más información, consulte ciclo de vida de los recursos de contenedor.
Propina
Si prefiere conectarse a una instancia de Redis existente, llame a AddConnectionString en su lugar. Para obtener más información, vea Consulte los recursos existentes.
Incorporación de un recurso de Redis con Redis Insights
Para agregar Redis Insights al recurso Redis, llame al método WithRedisInsight:
var builder = DistributedApplication.CreateBuilder(args);
var cache = builder.AddRedis("cache")
.WithRedisInsight();
builder.AddProject<Projects.ExampleProject>()
.WithReference(cache);
// After adding all resources, run the app...
Redis Insights es una interfaz gráfica gratuita para analizar Redis datos en todos los sistemas operativos e implementaciones de Redis con la ayuda de nuestro asistente de inteligencia artificial, Redis Copilot.
.NET
.NET Aspire agrega otra imagen de contenedor docker.io/redis/redisinsight al host de la aplicación que ejecuta la aplicación comandante.
Nota
Para configurar el puerto de host para el RedisInsightResource encadene una llamada a la API de WithHostPort y proporcione el número de puerto deseado.
Adición de un recurso de Redis con Redis Commander
Para agregar el Redis Commander al recurso Redis, llame al método WithRedisCommander:
var builder = DistributedApplication.CreateBuilder(args);
var cache = builder.AddRedis("cache")
.WithRedisCommander();
builder.AddProject<Projects.ExampleProject>()
.WithReference(cache);
// After adding all resources, run the app...
Redis Commander es una aplicación web Node.js que se usa para ver, editar y administrar una base de datos Redis.
.NET
.NET Aspire agrega otra imagen de contenedor docker.io/rediscommander/redis-commander al host de la aplicación que ejecuta la aplicación comandante.
Propina
Para configurar el puerto de host para el RedisCommanderResource encadene una llamada a la API de WithHostPort y proporcione el número de puerto deseado.
Agregar el recurso Redis con volumen de datos
Para agregar un volumen de datos al recurso de Redis, llame al método WithDataVolume en el recurso Redis:
var builder = DistributedApplication.CreateBuilder(args);
var cache = builder.AddRedis("cache")
.WithDataVolume(isReadOnly: false);
builder.AddProject<Projects.ExampleProject>()
.WithReference(cache);
// After adding all resources, run the app...
El volumen de datos se utiliza para conservar los datos de Redis fuera del ciclo de vida del contenedor. El volumen de datos se monta en la ruta de acceso /data del contenedor Redis y, cuando no se proporciona un parámetro name, el nombre se genera aleatoriamente. Para obtener más información sobre los volúmenes de datos y los detalles sobre por qué se prefieren a enlazar montajes, consulte Docker documentos: Volúmenes.
Adición del recurso Redis con montaje con enlace de datos
Para agregar un montaje de enlace de datos al recurso de Redis, llame al método WithDataBindMount:
var builder = DistributedApplication.CreateBuilder(args);
var cache = builder.AddRedis("cache")
.WithDataBindMount(
source: @"C:\Redis\Data",
isReadOnly: false);
builder.AddProject<Projects.ExampleProject>()
.WithReference(cache);
// After adding all resources, run the app...
Importante
Los montajes de enlace de de datos tienen una funcionalidad limitada en comparación con los volúmenes de , que ofrecen un mejor rendimiento, portabilidad y seguridad, lo que hace que sean más adecuados para entornos de producción. Sin embargo, los montajes de enlace permiten el acceso directo y la modificación de archivos en el sistema host, lo que es ideal para el desarrollo y las pruebas donde se requieren cambios en tiempo real.
Los montajes de datos se basan en el sistema de archivos del equipo anfitrión para mantener los datos de Redis durante los reinicios del contenedor. El montaje de enlace de datos se monta en C:\Redis\Data en Windows (o /Redis/Data en Unix) en el equipo host para el contenedor Redis. Para obtener más información sobre los montajes de datos, consulte la documentación de Docker: montajes enlazados.
Añadir recurso Redis con persistencia
Para añadir persistencia al recurso Redis, llame al método WithPersistence con un volumen de datos o un montaje de enlace de datos.
var builder = DistributedApplication.CreateBuilder(args);
var cache = builder.AddRedis("cache")
.WithDataVolume()
.WithPersistence(
interval: TimeSpan.FromMinutes(5),
keysChangedThreshold: 100);
builder.AddProject<Projects.ExampleProject>()
.WithReference(cache);
// After adding all resources, run the app...
El código anterior agrega persistencia al recurso Redis mediante la toma de instantáneas de los datos de Redis en un intervalo y umbral especificados. El interval es el tiempo entre las exportaciones de instantáneas y el keysChangedThreshold es el número de operaciones de cambio clave necesarias para desencadenar una instantánea. Para obtener más información sobre la persistencia, consulte la documentación de Redis: Persistencia.
La integración de hospedaje de Garnet modela un recurso de Garnet como el tipo GarnetResource. Para acceder a este tipo y las API que le permiten agregarlo a su 📦Aspire.Hosting.Garnet paquete NuGet en el host del proyecto de la aplicación de .
- CLI de .NET
- PackageReference
dotnet add package Aspire.Hosting.Garnet
Para obtener más información, consulte dotnet add package o Administrar dependencias de paquetes en aplicaciones .NET.
Adición de un recurso de Garnet
En el proyecto host de la aplicación, llame a AddGarnet en la instancia de builder para agregar un recurso de Garnet:
var builder = DistributedApplication.CreateBuilder(args);
var cache = builder.AddGarnet("cache");
builder.AddProject<Projects.ExampleProject>()
.WithReference(cache);
// After adding all resources, run the app...
Cuando .NET.NET Aspire agrega una imagen de contenedor al host de la aplicación, como se muestra en el ejemplo anterior con la imagen de ghcr.io/microsoft/garnet, crea una nueva instancia de Garnet en el equipo local. Se agrega una referencia al recurso Garnet (la variable cache) al ExampleProject.
El método WithReference configura una conexión en el ExampleProject denominado "cache". Para obtener más información, consulte ciclo de vida de los recursos de contenedor.
Propina
Si prefiere conectarse a una instancia de Garnet existente, llame a AddConnectionString en su lugar. Para obtener más información, vea Hacer referencia a los recursos existentes.
Adición de un recurso de Garnet con volumen de datos
Para agregar un volumen de datos al recurso garnet, llame al método AddGarnet en el recurso garnet:
var builder = DistributedApplication.CreateBuilder(args);
var cache = builder.AddGarnet("cache")
.WithDataVolume(isReadOnly: false);
builder.AddProject<Projects.ExampleProject>()
.WithReference(cache);
// After adding all resources, run the app...
El volumen de datos se usa para conservar los datos de Garnet fuera del ciclo de vida de su contenedor. El volumen de datos se monta en la ruta de acceso /data en el contenedor de Garnet y, cuando no se proporciona un parámetro name, el nombre se genera de forma aleatoria. Para obtener más información sobre los volúmenes de datos y los detalles sobre por qué se prefieren a enlazar montajes, consulte Docker documentos: Volúmenes.
Adición de un recurso de Garnet con montaje de enlace de datos
Para agregar un montaje de enlace de datos al recurso Garnet, llame al método WithDataBindMount:
var builder = DistributedApplication.CreateBuilder(args);
var cache = builder.AddGarnet("cache")
.WithDataBindMount(
source: @"C:\Garnet\Data",
isReadOnly: false);
builder.AddProject<Projects.ExampleProject>()
.WithReference(cache);
// After adding all resources, run the app...
Importante
Los montajes de datos por enlace tienen una funcionalidad limitada en comparación con los volúmenes , que ofrecen mejor rendimiento, portabilidad y seguridad, lo que los hace más adecuados para entornos de producción. Sin embargo, los montajes bind permiten el acceso directo y la modificación de archivos en el sistema host, ideal para desarrollo y pruebas donde se necesitan cambios en tiempo real.
Los montajes de enlace de datos dependen del sistema de archivos del equipo host para conservar los datos de Garnet entre reinicios del contenedor. El montaje del enlace de datos se monta en la ruta de acceso C:\Garnet\Data en Windows (o /Garnet/Data en Unix) en la máquina host dentro del contenedor de Garnet. Para obtener más información sobre los montajes de enlace de datos, consulte la documentación de Docker: montajes de vinculación.
Adición de un recurso de Garnet con persistencia
Para agregar persistencia al recurso Garnet, llame al método WithPersistence utilizando el volumen o el punto de montaje de datos:
var builder = DistributedApplication.CreateBuilder(args);
var cache = builder.AddGarnet("cache")
.WithDataVolume()
.WithPersistence(
interval: TimeSpan.FromMinutes(5),
keysChangedThreshold: 100);
builder.AddProject<Projects.ExampleProject>()
.WithReference(cache);
// After adding all resources, run the app...
El código anterior agrega persistencia al recurso de Redis tomando instantáneas de los datos de garnet en un intervalo y umbral especificados. El interval es el tiempo entre las exportaciones de instantáneas y el keysChangedThreshold es el número de operaciones de cambio clave necesarias para desencadenar una instantánea. Para obtener más información sobre la persistencia, consulte Redis doc.: Persistencia.
La integración de hosting de Valkey modela un recurso Valkey como el tipo ValkeyResource. Para acceder a este tipo y las API que le permiten agregarlo a la 📦Aspire.Hosting.Valkey paquete NuGet en el proyecto host de la aplicación .
dotnet add package Aspire.Hosting.Valkey
Para obtener más información, consulte dotnet add package o Administrar dependencias de paquetes en aplicaciones .NET.
Adición de un recurso Valkey
En el proyecto host de la aplicación, llame a AddValkey en la instancia de builder para agregar un recurso Valkey:
var builder = DistributedApplication.CreateBuilder(args);
var cache = builder.AddValkey("cache");
builder.AddProject<Projects.ExampleProject>()
.WithReference(cache);
// After adding all resources, run the app...
Cuando .NET.NET Aspire agrega una imagen de contenedor al host de la aplicación, como se muestra en el ejemplo anterior con la imagen de docker.io/valkey/valkey, crea una nueva instancia de Valkey en el equipo local. Se agrega una referencia al recurso Valkey (la variable cache) al ExampleProject.
El método WithReference configura una conexión en el ExampleProject denominado "cache". Para obtener más información, consulte ciclo de vida de los recursos de contenedor.
Propina
Si prefiere conectarse a una instancia de Valkey existente, llame a AddConnectionString en su lugar. Para obtener más información, vea Referencia de los recursos existentes.
Adición de un recurso Valkey con volumen de datos
Para agregar un volumen de datos al recurso Valkey, llame al método AddValkey en el recurso Valkey:
var builder = DistributedApplication.CreateBuilder(args);
var cache = builder.AddValkey("cache")
.WithDataVolume(isReadOnly: false);
builder.AddProject<Projects.ExampleProject>()
.WithReference(cache);
// After adding all resources, run the app...
El volumen de datos se usa para conservar los datos de Valkey fuera del ciclo de vida de su contenedor. El volumen de datos se monta en la ruta de acceso /data del contenedor Valkey y, cuando no se proporciona un parámetro name, el nombre se genera de forma aleatoria. Para obtener más información sobre los volúmenes de datos y los detalles sobre por qué se prefieren a enlazar montajes, consulte Docker documentos: Volúmenes.
Adición de un recurso Valkey con montaje de enlace de datos
Para agregar un montaje de enlace de datos al recurso Valkey, llame al método WithDataBindMount:
var builder = DistributedApplication.CreateBuilder(args);
var cache = builder.AddValkey("cache")
.WithDataBindMount(
source: @"C:\Valkey\Data",
isReadOnly: false);
builder.AddProject<Projects.ExampleProject>()
.WithReference(cache);
// After adding all resources, run the app...
Importante
Los montajes de enlace de datos tienen una funcionalidad limitada en comparación con los volúmenes , que ofrecen un mejor rendimiento, portabilidad y seguridad, haciéndolos más adecuados para entornos de producción. Sin embargo, los montajes de enlace permiten el acceso directo y la modificación de archivos en el sistema host, ideal para el desarrollo y las pruebas donde se necesitan cambios en tiempo real.
Los montajes de unión de datos dependen del sistema de archivos de la máquina host para conservar los datos de Valkey durante los reinicios del contenedor. El montaje de enlace de datos se monta en la ruta de acceso C:\Valkey\Data en Windows (o /Valkey/Data en Unix) en el equipo host dentro del contenedor Valkey. Para obtener más información sobre los montajes vinculantes de datos, consulte Docker doc: montajes vinculantes.
Adición de un recurso Valkey con persistencia
Para agregar persistencia al recurso Valkey, llame al método WithPersistence con el volumen de datos o el montaje de enlace de datos:
var builder = DistributedApplication.CreateBuilder(args);
var cache = builder.AddValkey("cache")
.WithDataVolume()
.WithPersistence(
interval: TimeSpan.FromMinutes(5),
keysChangedThreshold: 100);
builder.AddProject<Projects.ExampleProject>()
.WithReference(cache);
// After adding all resources, run the app...
El código anterior agrega persistencia al recurso de Redis tomando instantáneas de los datos de Valkey en un intervalo y umbral especificados. El interval es el tiempo entre las exportaciones de instantáneas y el keysChangedThreshold es el número de operaciones de cambio clave necesarias para desencadenar una instantánea. Para obtener más información sobre la persistencia, consulte los documentos de Redis: Persistencia.
Hospedaje de comprobaciones de estado de integración
La Redis integración de hospedaje agrega automáticamente una comprobación de estado para el tipo de recurso apropiado. La verificación de estado confirma que el server está en funcionamiento y que se puede conectar con él.
La integración de hospedaje se basa en el 📦 AspNetCore.HealthChecks.Redis paquete NuGet.
integración de Client
Para empezar a trabajar con la integración de .NET Aspire Stack Exchange Redis salida client, instale el 📦Aspire. StackExchange.Redis. OutputCaching paquete NuGet en el clientproyecto que consume, es decir, el proyecto de la aplicación que usa el almacenamiento en caché de salida client.
dotnet add package Aspire.StackExchange.Redis.OutputCaching
Agregar almacenamiento en caché de salida
En el archivo Program.cs de su proyecto de consumo de client, invoque el método de extensión AddRedisOutputCache en cualquier IHostApplicationBuilder para registrar los servicios necesarios para la caché de salida.
builder.AddRedisOutputCache(connectionName: "cache");
Propina
El parámetro connectionName debe coincidir con el nombre usado al agregar el recurso Redis en el proyecto host de la aplicación. Para obtener más información, consulte Agregar Redis recurso.
Propina
El parámetro connectionName debe coincidir con el nombre usado al agregar el recurso garnet en el proyecto host de la aplicación. Para obtener más información, consulte Agregar recurso de Garnet.
Propina
El parámetro connectionName debe coincidir con el nombre usado al agregar el recurso Valkey en el proyecto host de la aplicación. Para obtener más información, consulte el recurso de Valkey "" Agregar "".
Agregue el middleware a la canalización de procesamiento de solicitudes llamando a UseOutputCache(IApplicationBuilder):
var app = builder.Build();
app.UseOutputCache();
Para aplicaciones de API mínimas, configure un punto de conexión para realizar el almacenamiento en caché llamando a CacheOutputo aplicando el OutputCacheAttribute, como se muestra en los ejemplos siguientes:
app.MapGet("/cached", () => "Hello world!")
.CacheOutput();
app.MapGet(
"/attribute",
[OutputCache] () => "Hello world!");
En el caso de las aplicaciones con controladores, aplique el atributo [OutputCache] al método de acción. En el caso de las aplicaciones de Razor Pages, aplique el atributo a la clase de página de Razor.
Configuración
La integración del almacenamiento en caché de salida de .NET Aspire Stack Exchange Redis proporciona varias opciones para configurar la conexión Redis en función de los requisitos y convenciones del proyecto.
Uso de una cadena de conexión
Al usar una cadena de conexión de la sección de configuración de ConnectionStrings, puede proporcionar el nombre de la cadena de conexión al llamar a AddRedisOutputCache:
builder.AddRedisOutputCache(connectionName: "cache");
A continuación, la cadena de conexión se obtendrá desde la sección de configuración de ConnectionStrings.
{
"ConnectionStrings": {
"cache": "localhost:6379"
}
}
Para obtener más información sobre cómo dar formato a esta cadena de conexión, consulte los documentos de configuración de Redis de Stack Exchange.
Uso de proveedores de configuración
La integración de .NET Aspire Stack Exchange Redis admite Microsoft.Extensions.Configuration. Carga el StackExchangeRedisSettings desde la configuración utilizando la clave Aspire:StackExchange:Redis. Ejemplo appsettings.json que configura algunas de las opciones:
{
"Aspire": {
"StackExchange": {
"Redis": {
"ConnectionString": "localhost:6379",
"DisableHealthChecks": true,
"DisableTracing": false
}
}
}
}
Para consultar el esquema de integración completo de RedisclientJSON, vea Aspire.StackExchange.Redis/ConfigurationSchema.json.
Utiliza delegados insertados
También puede pasar el delegado de Action<StackExchangeRedisSettings> configurationSettings para configurar algunas o todas las opciones en línea, por ejemplo, para deshabilitar las comprobaciones de estado desde el código:
builder.AddRedisOutputCache(
"cache",
static settings => settings.DisableHealthChecks = true);
También puede configurar el ConfigurationOptions mediante el parámetro de delegado Action<ConfigurationOptions> configureOptions del método AddRedisOutputCache. Por ejemplo, para establecer el tiempo de espera de conexión:
builder.AddRedisOutputCache(
"cache",
static settings => settings.ConnectTimeout = 3_000);
Comprobaciones de estado
De forma predeterminada, las integraciones .NET.NET Aspire habilitan las verificaciones de salud para todos los servicios. Para obtener más información, consulte .NET.NET Aspire integrations overview.
La integración del almacenamiento en caché de salida de .NET Aspire Stack Exchange Redis controla lo siguiente:
- Agrega la comprobación de estado
StackExchange.Redis, intenta abrir la conexión y lanza una excepción cuando falla. - Se integra con el punto de conexión HTTP de
/health, que especifica que todas las comprobaciones de estado registradas deben pasar para que la aplicación se considere lista para aceptar el tráfico.
Observabilidad y telemetría
.NET .NET Aspire integraciones configuran automáticamente las configuraciones de registro, seguimiento y métricas, que a veces se conocen como los pilares de la observabilidad. Para obtener más información sobre la observabilidad de integración y la telemetría, consulte información general sobre las integraciones de .NET.NET Aspire. En función del servicio de respaldo, algunas integraciones solo pueden admitir algunas de estas características. Por ejemplo, algunas integraciones admiten el registro y el seguimiento, pero no las métricas. Las características de telemetría también se pueden deshabilitar mediante las técnicas presentadas en la sección Configuración.
Registro
La integración del almacenamiento en caché de salida de .NET Aspire Stack Exchange Redis usa las siguientes categorías de registro:
Aspire.StackExchange.RedisMicrosoft.AspNetCore.OutputCaching.StackExchangeRedis
Seguimiento
La integración de caché de salida Redis de .NET Aspire Stack Exchange generará las siguientes actividades de rastreo mediante OpenTelemetry:
OpenTelemetry.Instrumentation.StackExchangeRedis
Métricas
La integración del almacenamiento en caché de salida de .NET Aspire Stack Exchange Redis actualmente no admite métricas de forma predeterminada debido a limitaciones con la biblioteca de StackExchange.Redis.
Azure Redis integración de hospedaje
Para implementar los recursos de Redis en Azure, instale el 📦Aspire. Hosting.Azure.Redis el paquete NuGet:
dotnet add package Aspire.Hosting.Azure.Redis
Agregar Azure Cache for Redisserver recurso
Después de haber instalado el paquete de hospedaje .NET AspireAzureRedis, llame al método de extensión AddAzureRedis en el proyecto de hospedaje de la aplicación:
var builder = DistributedApplication.CreateBuilder(args);
var cache = builder.AddAzureRedis("azcache")
var exampleProject = builder.AddProject<Projects.ExampleProject>()
.WithReference(cache);
La llamada anterior a AddAzureRedis configura el recurso de Redisserver que se va a implementar como un Azure Cache for Redis.
Importante
De forma predeterminada, AddAzureRedis configura la autenticación de identificación de Microsoft Entra. Esto requiere cambios en las aplicaciones que necesitan conectarse a estos recursos; por ejemplo, integraciones client.
Agregar salida de Azure Cache for Redisclient
De forma predeterminada, al llamar a AddAzureRedis en la integración de hospedaje de Redis, configura 📦 Microsoft.Azure. StackExchangeRedis paquete NuGet para habilitar la autenticación:
dotnet add package Microsoft.Azure.StackExchangeRedis
La conexión de Redis puede consumirse mediante la integración de client y Microsoft.Azure.StackExchangeRedis. Tenga en cuenta el código de configuración siguiente:
var azureOptionsProvider = new AzureOptionsProvider();
var configurationOptions = ConfigurationOptions.Parse(
builder.Configuration.GetConnectionString("cache") ??
throw new InvalidOperationException("Could not find a 'cache' connection string."));
if (configurationOptions.EndPoints.Any(azureOptionsProvider.IsMatch))
{
await configurationOptions.ConfigureForAzureWithTokenCredentialAsync(
new DefaultAzureCredential());
}
builder.AddRedisOutputCache("cache", configureOptions: options =>
{
options.Defaults = configurationOptions.Defaults;
});
Para obtener más información, consulte el repositorio Microsoft.Azure.StackExchangeRedis.
Consulte también
- de
Stack Exchange - .NET .NET Aspire integraciones
- del repositorio de
*: Redis es una marca registrada de Redis Ltd. Cualquier derecho en ella está reservado a Redis Ltd. Cualquier uso por parte de Microsoft es solo para fines referenciales y no indica ningún patrocinio, aprobación o afiliación entre Redis y Microsoft. Volver al inicio?
