Compartir a través de

® integración de almacenamiento en caché distribuido .NET AspireRedis*

  • Artículo

Incluye: de integración de hospedaje y Client

Obtenga información sobre cómo usar la integración de almacenamiento en caché distribuido .NET AspireRedis. La biblioteca Aspire.StackExchange.Redis.DistributedCaching se utiliza para registrar un proveedor IDistributedCache , respaldado por un Redisserver, con la imagen del contenedor docker.io/library/redis.

Obtenga información sobre cómo usar la integración de almacenamiento en caché distribuido .NET AspireRedis. La biblioteca Aspire.StackExchange.Redis.DistributedCaching se usa para registrar un proveedor de IDistributedCache respaldado por un Garnetserver con la imagen de contenedor ghcr.io/microsoft/garnet.

Obtenga información sobre cómo usar la integración de almacenamiento en caché distribuido .NET AspireRedis. La biblioteca Aspire.StackExchange.Redis.DistributedCaching se utiliza para registrar un proveedor de IDistributedCache respaldado por un Valkeyserver con la imagen de contenedor docker.io/valkey/valkey.

Integración de hospedaje

El modelo de integración de alojamiento de Redis representa un recurso de Redis como un tipo RedisResource. Para acceder a este tipo y a las APIs que le permiten agregarlo a su 📦Aspire.Hosting.Redis paquete NuGet en el proyecto del host de la aplicación .

dotnet add package Aspire.Hosting.Redis

Para obtener más información, consulte dotnet add package o Administrar dependencias de paquetes en aplicaciones .NET.

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 Hacer referencia a los recursos existentes.

Incorporación de un recurso de Redis con Redis Insights

Para agregar los Insights Redis 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 app Commander.

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.

Adición del 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 usa para preservar los datos de Redis fuera del ciclo de vida del contenedor. El volumen de datos se monta en la ruta /data dentro del contenedor Redis y, si no se proporciona un parámetro name, el nombre se genera de manera 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 del recurso Redis con montaje de enlaces 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 uniones de datos tienen una funcionalidad limitada en comparación con los volúmenes , que ofrecen un mejor rendimiento, portabilidad y seguridad, lo que los hace más adecuados para entornos de producción. Sin embargo, los montajes de enlaces permiten el acceso directo y la modificación de archivos en el sistema host, lo cual es ideal para el desarrollo y las pruebas donde se necesitan cambios en tiempo real.

Los montajes de enlace de datos dependen del sistema de archivos de la máquina anfitriona para preservar los datos de Redis a través de los reinicios del contenedor. El montaje de enlace de datos se monta en la ruta de acceso C:\Redis\Data en Windows (o /Redis/Data en Unix) en el equipo host en el contenedor Redis. Para obtener más información sobre los montajes vinculados de datos, consulte la documentación de Docker: montajes vinculados.

Agregar el recurso Redis con persistencia

Para agregar persistencia al recurso de Redis, llame al método WithPersistence con el volumen de datos o el punto de montaje 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 los documentos Redis: Persistencia.

La integración de hospedaje de Garnet modela un recurso de Garnet como un tipo GarnetResource. Para acceder a este tipo y API que le permiten agregarlo al paquete NuGet .Hosting.Garnet 📦Aspire en el host de aplicación .

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) en el 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, consulte 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 /data en el contenedor de Garnet 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 de un recurso de Garnet con montaje de enlace de datos

Para agregar un montaje con 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 enlace de datos tienen una funcionalidad limitada en comparación con los volúmenes , que ofrecen 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 anfitrión, ideal para el desarrollo y las pruebas donde se necesitan cambios en tiempo real.

Los montajes de enlace de datos dependen del sistema de archivos del equipo anfitrión para conservar los datos de Garnet entre reinicios del contenedor. El montaje del enlace de datos se monta en el C:\Garnet\Data en la ruta de acceso en el equipo host de Windows (o /Garnet/Data en Unix) del contenedor de Garnet. Para obtener más información sobre los montajes de enlace de datos, consulte Docker documentos: Enlazar montajes.

Adición de un recurso de Garnet con persistencia

Para agregar persistencia al recurso garnet, 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.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 la documentación de Redis: Persistencia.

La integración de alojamiento de Valkey modela un recurso de Valkey como tipo ValkeyResource. Para acceder a este tipo y api que le permiten agregarlo a la . Hosting.Valkey paquete NuGet en el proyecto de host de aplicación.

dotnet add package Aspire.Hosting.Valkey

Para obtener más información, consulte dotnet add package o Manage package dependencies in .NET applications.

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 Recursos existentes de referencia.

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.

Añadir recurso Valkey con montaje vinculado 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 datos de enlace tienen una funcionalidad limitada en comparación con los volúmenes , que ofrecen un mejor rendimiento, portabilidad y seguridad, haciéndolos más apropiados 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 datos vinculados dependen del sistema de archivos del host para conservar los datos de Valkey durante los reinicios del contenedor. El montaje de enlace a datos se monta en el C:\Valkey\Data en Windows (o /Valkey/Data en Unix) en la ruta de acceso en el equipo host del contenedor Valkey. Para obtener más información sobre los montajes de datos mediante enlace, consulte la documentación Docker: Montajes mediante enlace.

Agrega 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 la documentación de Redis: Persistencia.

Comprobaciones de estado de integración en el hospedaje

La integración de alojamiento Redis agrega automáticamente una verificación de estado para el tipo de recurso adecuado. La verificación de estado comprueba que el server está corriendo y que se puede establecer una conexión 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 caché distribuida de .NET AspireRedis, instale el paquete NuGet 📦Aspire.StackExchange.Redis.DistributedCaching en el proyecto consumidor client, es decir, el proyecto de la aplicación que usa la caché distribuida Redisclient.

dotnet add package Aspire.StackExchange.Redis.DistributedCaching

Agregar Redisclient

En el archivo Program.cs del proyecto de consumo de client, llame a la extensión AddRedisDistributedCache para registrar los servicios necesarios para el almacenamiento en caché distribuido y agregue un IDistributedCache para su uso a través de un contenedor de inyección de dependencias.

builder.AddRedisDistributedCache(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 Agregar recurso Valkey.

A continuación, puede recuperar la instancia de IDistributedCache mediante la inyección de dependencias. Por ejemplo, para recuperar la memoria caché de un servicio:

public class ExampleService(IDistributedCache cache)
{
    // Use cache...
}

Para obtener más información sobre la inserción de dependencias, consulte .NET inserción de dependencias.

Agregar elementos con clave Redisclient

Puede haber situaciones en las que quiera registrar varias instancias de IDistributedCache con nombres de conexión diferentes. Para registrar clientes de Redis con clave, llame al método AddKeyedRedisDistributedCache:

builder.AddKeyedRedisDistributedCache(name: "chat");
builder.AddKeyedRedisDistributedCache(name: "product");

A continuación, puede recuperar las instancias de IDistributedCache mediante la inyección de dependencias. Por ejemplo, para recuperar la conexión de un servicio de ejemplo:

public class ExampleService(
    [FromKeyedServices("chat")] IDistributedCache chatCache,
    [FromKeyedServices("product")] IDistributedCache productCache)
{
    // Use caches...
}

Para obtener más información sobre los servicios clave, consulte .NET inserción de dependencias: servicios clave.

Configuración

La .NET AspireRedis integración de almacenamiento en caché distribuido proporciona varias opciones para configurar la conexión de 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 builder.AddRedisDistributedCache:

builder.AddRedisDistributedCache("cache");

Después, se recuperará la cadena de conexión de la sección de configuración 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 Redis de Exchange de .NET Aspire Stack admite Microsoft.Extensions.Configuration. Carga el StackExchangeRedisSettings desde la configuración mediante 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 el esquema completo de integración RedisclientJSON, consulte Aspire.StackExchange.Redis/ConfigurationSchema.json.

Usa delegados insertados

También puede utilizar el delegado de Action<StackExchangeRedisSettings> para configurar algunas o todas las opciones directamente, por ejemplo, para configurar DisableTracing:

builder.AddRedisDistributedCache(
    "cache",
    settings => settings.DisableTracing = true);

También puede configurar ConfigurationOptions usando el parámetro delegado Action<ConfigurationOptions> configureOptions del método AddRedisDistributedCache. Por ejemplo, para establecer el tiempo de espera de conexión:

builder.AddRedisDistributedCache(
    "cache",
    static settings => settings.ConnectTimeout = 3_000);

Comprobaciones de estado

De forma predeterminada, las integraciones de .NET.NET Aspire habilitan las comprobaciones de estado de para todos los servicios. Para obtener más información, consulte .NET.NET Aspire integrations overview.

La .NET AspireRedis integración de almacenamiento en caché distribuido 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 verificaciones de salud registradas deben ser superadas para que la aplicación se considere lista para aceptar tráfico.

Observabilidad y telemetría

.NET .NET Aspire las integraciones configuran automáticamente los registros, el seguimiento y las métricas, que a veces se denominan 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 de configuración .

Registro

La integración de almacenamiento en caché distribuido de .NET AspireRedis usa las siguientes categorías de registro:

  • Aspire.StackExchange.Redis
  • Microsoft.Extensions.Caching.StackExchangeRedis

Rastreo

La integración de almacenamiento en caché distribuido de .NET AspireRedis emitirá las siguientes actividades de seguimiento mediante OpenTelemetry:

  • OpenTelemetry.Instrumentation.StackExchangeRedis

Métricas

Actualmente, la integración de almacenamiento en caché distribuido de .NET AspireRedis 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. Hospitalidad.Azure.Redis paquete NuGet:

dotnet add package Aspire.Hosting.Azure.Redis

Agregar Azure Cache for Redisserver recurso

Una vez que hayas instalado el paquete de hospedaje .NET AspireAzureRedis, llama al método de extensión AddAzureRedis en el proyecto de host de la aplicación.

var builder = DistributedApplication.CreateBuilder(args);

var cache = builder.AddAzureRedis("azcache")

var exampleProject = builder.AddProject<Projects.ExampleProject>()
                            .WithReference(cache);

La llamada previa a AddAzureRedis configura el recurso Redisserver para que se implemente 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 Azure Cache for Redisclient distribuidos

De forma predeterminada, al llamar a AddAzureRedis en la integración de hospedaje de Redis, configura el paquete NuGet 📦 de Microsoft.AzureStackExchangeRedis para habilitar la autenticación.

dotnet add package Microsoft.Azure.StackExchangeRedis

La conexión de Redis se puede consumir 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.AddRedisDistributedCache("cache", configureOptions: options =>
{
    options.Defaults = configurationOptions.Defaults;
});

Para obtener más información, consulte el Microsoft.Azure. Repo de StackExchangeRedis.

Consulte también

*: Redis es una marca registrada de Redis Ltd. Cualquier derecho sobre los mismos está reservado a Redis Ltd. Cualquier uso por parte de Microsoft es solo con fines referenciales y no indica ningún patrocinio, aprobación o afiliación entre Redis y Microsoft. Volver al principio?