Inicio rápido: Uso de Azure Redis Cache con una aplicación .NETQuickstart: Use Azure Cache for Redis with a .NET application

Este inicio rápido muestra cómo empezar a usar Microsoft Azure Redis Cache con. NET.This quickstart shows you how to get started using Microsoft Azure Cache for Redis with .NET. Microsoft Azure Redis Cache se basa en la conocida solución Azure Redis Cache de código fuente abierto.Microsoft Azure Cache for Redis is based on the popular open-source Azure Cache for Redis. Le ofrece acceso a una instancia de Azure Redis Cache dedicada y segura administrada por Microsoft.It gives you access to a secure, dedicated Azure Cache for Redis, managed by Microsoft. Una memoria caché creada con Azure Redis Cache es accesible desde cualquier aplicación dentro de Microsoft Azure.A cache created using Azure Cache for Redis is accessible from any application within Microsoft Azure.

En esta guía de inicio rápido, utilizará el cliente StackExchange.Redis con código C# en una aplicación de consola.In this quickstart, you will use the StackExchange.Redis client with C# code in a console app. Creará una memoria caché y configurará la aplicación cliente .NET.You will create a cache and configure the .NET client app. A continuación, agregará y actualizará objetos en la memoria caché.Then, you will add, and update objects in the cache.

Aplicación de consola finalizada

Si no tiene una suscripción a Azure, cree una cuenta gratuita antes de empezar.If you don't have an Azure subscription, create a free account before you begin.

Requisitos previosPrerequisites

Creación de una cachéCreate a cache

  1. Para crear una memoria caché, primero inicie sesión en Azure Portal.To create a cache, first sign in to the Azure portal. A continuación, seleccione Crear un recurso > Bases de datos > Azure Redis Cache.Then select Create a resource > Databases > Azure Cache for Redis.

    New cache

  2. En New Azure Cache for Redis (Nueva instancia de Azure Redis Cache), configure la nueva caché.In New Azure Cache for Redis, configure the settings for your new cache.

    ConfiguraciónSetting Valor sugeridoSuggested value DESCRIPCIÓNDescription
    Nombre DNSDNS name Nombre único globalmenteGlobally unique name El nombre de caché.The cache name. Tiene que ser una cadena de entre 1 y 63 caracteres y solo puede contener números, letras y el carácter -.It must be a string between 1 and 63 characters and contain only numbers, letters, and the - character. El nombre de la memoria caché no puede comenzar ni terminar por el carácter - y no se pueden usar varios caracteres - consecutivos.The cache name cannot start or end with the - character, and consecutive - characters are not valid.
    SuscripciónSubscription Su suscripciónYour subscription La suscripción en la que se crea esta nueva instancia de Azure Redis Cache.The subscription under which this new Azure Cache for Redis instance is created.
    Grupos de recursosResource group TestResourcesTestResources Nombre del nuevo grupo de recursos en el que se va a crear la caché.Name for the new resource group in which to create your cache. Al colocar todos los recursos de una aplicación en un grupo, puede administrarlos juntos.By putting all the resources for an app in a group, you can manage them together. Por ejemplo, si elimina el grupo de recursos también se eliminarán todos los recursos que están asociados con la aplicación.For example, deleting the resource group deletes all resources that are associated with the app.
    UbicaciónLocation Este de EE. UUEast US Elija una región cerca de otros servicios que vayan a usar la memoria caché.Choose a region near to other services that will use your cache.
    Plan de tarifaPricing tier C0 para básico (caché de 250 MB)Basic C0 (250 MB Cache) El plan de tarifa determina el tamaño, el rendimiento y las características disponibles para la memoria caché.The pricing tier determines the size, performance, and features that are available for the cache. Para más información, consulte la introducción a Azure Redis Cache.For more information, see Azure Cache for Redis Overview.
    Anclar al panelPin to dashboard SeleccionadoSelected Ancle la nueva caché para encontrarla con facilidad.Pin the new cache to your dashboard to make it easy to find.

    Create cache

  3. Una vez que las nuevas opciones de caché estén configuradas, seleccione Crear.After the new cache settings are configured, select Create.

    La creación de la caché puede tardar unos minutos.It can take a few minutes for the cache to be created. Para comprobar el estado, puede supervisar el progreso en el panel.To check the status, you can monitor the progress on the dashboard. Después de crear la memoria caché, testa tendrá el estado En ejecución y estará lista para su uso.After the cache has been created, it shows the status Running, and is ready for use.

    Cache created

Recuperación del nombre de host, los puertos y las claves de acceso mediante Azure PortalRetrieve host name, ports, and access keys by using the Azure portal

Al establecer conexión con una instancia de Azure Redis Cache, los clientes de dicha caché necesitan el nombre de host, los puertos y una clave para la caché.When connecting to an Azure Cache for Redis instance, cache clients need the host name, ports, and a key for the cache. Es posible que algunos clientes utilicen nombres ligeramente diferentes para estos elementos.Some clients might refer to these items by slightly different names. Puede recuperar esta información en Azure Portal.You can retrieve this information in the Azure portal.

Recuperación de las claves de acceso y el nombre de hostTo retrieve the access keys and host name

  1. Para recuperar las claves de acceso mediante Azure Portal, vaya a la memoria caché y seleccione Claves de acceso.To retrieve the access keys by using the Azure portal, browse to your cache and select Access keys.

    Claves de Azure Redis Cache

  2. Para recuperar el nombre de host y los puertos, seleccione Propiedades.To retrieve the host name and ports, select Properties.

    Propiedades de Azure Redis Cache

Cree un archivo en el equipo llamado CacheSecrets.config y colóquelo en una ubicación donde no se vaya a insertar en el repositorio con el código fuente de la aplicación de ejemplo.Create a file on your computer named CacheSecrets.config and place it in a location where it won't be checked in with the source code of your sample application. En esta guía de inicio rápido, el archivo CacheSecrets.config se encuentra aquí, C:\AppSecrets\CacheSecrets.config.For this quickstart, the CacheSecrets.config file is located here, C:\AppSecrets\CacheSecrets.config.

Edite el archivo CacheSecrets.config y agregue el contenido siguiente:Edit the CacheSecrets.config file and add the following contents:

<appSettings>
    <add key="CacheConnection" value="<cache-name>.redis.cache.windows.net,abortConnect=false,ssl=true,password=<access-key>"/>
</appSettings>

Reemplace <cache-name> por su nombre de host de caché.Replace <cache-name> with your cache host name.

Reemplace <access-key> por la clave principal de la caché.Replace <access-key> with the primary key for your cache.

Creación de una aplicación de consolaCreate a console app

En Visual Studio, haga clic en Archivo > Nuevo > proyecto.In Visual Studio, click File > New > Project.

En Visual C#, haga clic en Escritorio clásico de Windows y, a continuación, haga clic en Aplicación de consola y Aceptar para crear una nueva aplicación de consola.Under Visual C#, click Windows Classic Desktop and then click Console App, and OK to create a new console application.

Configuración del cliente de cachéConfigure the cache client

En esta sección, configurará la aplicación de consola para utilizar el cliente StackExchange.Redis para .NET.In this section, you will configure the console application to use the StackExchange.Redis client for .NET.

En Visual Studio, haga clic en Herramientas > Administrador de paquetes NuGet > Consola del administrador de paquetes y ejecute el siguiente comando desde la ventana de la consola del administrador de paquetes.In Visual Studio, click Tools > NuGet Package Manager > Package Manager Console, and run the following command from the Package Manager Console window.

Install-Package StackExchange.Redis

Una vez completada la instalación, el cliente de caché StackExchange.Redis está disponible para su uso con el proyecto.Once the installation is completed, the StackExchange.Redis cache client is available to use with your project.

Conexión a la memoria cachéConnect to the cache

En Visual Studio, abra el archivo App.config actualícelo para incluir un atributo appSettings file que hace referencia al archivo CacheSecrets.config.In Visual Studio, open your App.config file and update it to include an appSettings file attribute that references the CacheSecrets.config file.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <startup> 
        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.7.1" />
    </startup>

    <appSettings file="C:\AppSecrets\CacheSecrets.config"></appSettings>  

</configuration>

En el Explorador de soluciones, haga clic con el botón derecho en Referencias y haga clic en Agregar una referencia.In Solution Explorer, right-click References and click Add a reference. Agregue una referencia al ensamblado System.Configuration.Add a reference to the System.Configuration assembly.

Agregue las siguientes instrucciones using a Program.cs:Add the following using statements to Program.cs:

using StackExchange.Redis;
using System.Configuration;

La clase ConnectionMultiplexer administra la conexión con Azure Redis Cache.The connection to the Azure Cache for Redis is managed by the ConnectionMultiplexer class. Esta clase debe compartirse y reutilizarse en toda la aplicación cliente.This class should be shared and reused throughout your client application. No cree una nueva conexión para cada operación.Do not create a new connection for each operation.

Nunca almacene credenciales en el código fuente.Never store credentials in source code. Para simplificar este ejemplo, solo se usa un archivo de configuración externo llamado secrets.To keep this sample simple, I’m only using an external secrets config file. Un enfoque más adecuado sería utilizar Azure Key Vault con certificados.A better approach would be to use Azure Key Vault with certificates.

En Program.cs, agregue los siguientes miembros a la clase Program de la aplicación de consola:In Program.cs, add the following members to the Program class of your console application:

        private static Lazy<ConnectionMultiplexer> lazyConnection = new Lazy<ConnectionMultiplexer>(() =>
        {
            string cacheConnection = ConfigurationManager.AppSettings["CacheConnection"].ToString();
            return ConnectionMultiplexer.Connect(cacheConnection);
        });

        public static ConnectionMultiplexer Connection
        {
            get
            {
                return lazyConnection.Value;
            }
        }

Este enfoque para compartir una instancia de ConnectionMultiplexer en la aplicación usa una propiedad estática que devuelve una instancia conectada.This approach to sharing a ConnectionMultiplexer instance in your application uses a static property that returns a connected instance. El código proporciona una manera segura para subprocesos de inicializar solo una instancia de ConnectionMultiplexer conectada.The code provides a thread-safe way to initialize only a single connected ConnectionMultiplexer instance. abortConnect está establecido en false, lo que significa que la llamada se realizará correctamente incluso si no se establece ninguna conexión a Azure Redis Cache.abortConnect is set to false, which means that the call succeeds even if a connection to the Azure Cache for Redis is not established. Una de las características principales de ConnectionMultiplexer es que restaura automáticamente la conectividad a la caché una vez que el problema de red u otras causas se resuelven.One key feature of ConnectionMultiplexer is that it automatically restores connectivity to the cache once the network issue or other causes are resolved.

El valor de la configuración de aplicación CacheConnection se utiliza para hacer referencia a la cadena de conexión de la caché de Azure Portal como el parámetro de contraseña.The value of the CacheConnection appSetting is used to reference the cache connection string from the Azure portal as the password parameter.

Ejecución de comandos de cachéExecuting cache commands

Agregue el código siguiente al procedimiento Main de la clase Program de la aplicación de consola:Add the following code for the Main procedure of the Program class for your console application:

        static void Main(string[] args)
        {
            // Connection refers to a property that returns a ConnectionMultiplexer
            // as shown in the previous example.
            IDatabase cache = lazyConnection.Value.GetDatabase();

            // Perform cache operations using the cache object...

            // Simple PING command
            string cacheCommand = "PING";
            Console.WriteLine("\nCache command  : " + cacheCommand);
            Console.WriteLine("Cache response : " + cache.Execute(cacheCommand).ToString());

            // Simple get and put of integral data types into the cache
            cacheCommand = "GET Message";
            Console.WriteLine("\nCache command  : " + cacheCommand + " or StringGet()");
            Console.WriteLine("Cache response : " + cache.StringGet("Message").ToString());

            cacheCommand = "SET Message \"Hello! The cache is working from a .NET console app!\"";
            Console.WriteLine("\nCache command  : " + cacheCommand + " or StringSet()");
            Console.WriteLine("Cache response : " + cache.StringSet("Message", "Hello! The cache is working from a .NET console app!").ToString());

            // Demonstrate "SET Message" executed as expected...
            cacheCommand = "GET Message";
            Console.WriteLine("\nCache command  : " + cacheCommand + " or StringGet()");
            Console.WriteLine("Cache response : " + cache.StringGet("Message").ToString());

            // Get the client list, useful to see if connection list is growing...
            cacheCommand = "CLIENT LIST";
            Console.WriteLine("\nCache command  : " + cacheCommand);
            Console.WriteLine("Cache response : \n" + cache.Execute("CLIENT", "LIST").ToString().Replace("id=", "id="));

            lazyConnection.Value.Dispose();
        }

Las instancias de Azure Cache for Redis tienen un número configurable de bases de datos (valor predeterminado de 16) que se pueden usar para separar de forma lógica los datos dentro de una instancia de Azure Redis Cache. El código se conecta a la base de datos predeterminada, DB 0. Para más información, consulte What are Redis databases? (¿Qué son las bases de datos de Redis?) y Configuración predeterminada del servidor Redis.For more information, see What are Redis databases? and Default Redis server configuration.

Los elementos en la memoria caché se pueden almacenar y recuperar mediante los métodos StringSet y StringGet.Cache items can be stored and retrieved by using the StringSet and StringGet methods.

Redis almacena la mayoría de los datos como cadenas Redis, pero estas cadenas pueden contener muchos tipos de datos, como por ejemplo datos binarios serializados, que se pueden usar cuando se almacenan objetos .NET en caché.Redis stores most data as Redis strings, but these strings can contain many types of data, including serialized binary data, which can be used when storing .NET objects in the cache.

Presione Ctrl+F5 para compilar y ejecutar la aplicación de consola.Press Ctrl+F5 to build and run the console app.

En el ejemplo siguiente, puede ver que la clave Message tenía anteriormente un valor almacenado en caché, que se estableció mediante la Consola de Redis en Azure Portal.In the example below, you can see the Message key previously had a cached value, which was set using the Redis Console in the Azure portal. La aplicación actualizó ese valor almacenado en caché.The app updated that cached value. La aplicación también ejecutó los comandos PING y CLIENT LIST.The app also executed the PING and CLIENT LIST commands.

Aplicación de consola parcial

Trabajar con objetos .NET en la memoria cachéWork with .NET objects in the cache

Azure Redis Cache puede almacenar en caché objetos .NET así como tipos de datos primitivos, pero antes de poder almacenar en caché un objeto .NET, se debe serializar.Azure Cache for Redis can cache both .NET objects and primitive data types, but before a .NET object can be cached it must be serialized. La serialización del objeto .NET es responsabilidad del desarrollador de la aplicación, que tiene total flexibilidad a la hora de elegir el serializador.This .NET object serialization is the responsibility of the application developer, and gives the developer flexibility in the choice of the serializer.

Una manera sencilla para serializar objetos es usar los métodos de serialización JsonConvert de Newtonsoft.Json y serializar a y desde JSON.One simple way to serialize objects is to use the JsonConvert serialization methods in Newtonsoft.Json and serialize to and from JSON. En esta sección, agregará un objeto .NET a la memoria caché.In this section, you will add a .NET object to the cache.

En Visual Studio, haga clic en Herramientas > Administrador de paquetes NuGet > Consola del administrador de paquetes y ejecute el siguiente comando desde la ventana de la consola del administrador de paquetes.In Visual Studio, click Tools > NuGet Package Manager > Package Manager Console, and run the following command from the Package Manager Console window.

Install-Package Newtonsoft.Json

Agregue la siguiente instrucción using al principio del archivo Program.cs:Add the following using statement to the top of Program.cs:

using Newtonsoft.Json;

Agregue la siguiente definición de clase Employee a Program.cs:Add the following Employee class definition to Program.cs:

        class Employee
        {
            public string Id { get; set; }
            public string Name { get; set; }
            public int Age { get; set; }

            public Employee(string EmployeeId, string Name, int Age)
            {
                this.Id = EmployeeId;
                this.Name = Name;
                this.Age = Age;
            }
        }

En la parte inferior del procedimiento Main() de Program.cs, antes de llamar a Dispose(), agregue las siguientes líneas de código para almacenar en caché y recuperar un objeto .NET serializado:At the bottom of Main() procedure in Program.cs, and before the call to Dispose(), add the following lines of code to cache and retrieve a serialized .NET object:

            // Store .NET object to cache
            Employee e007 = new Employee("007", "Davide Columbo", 100);
            Console.WriteLine("Cache response from storing Employee .NET object : " + 
                cache.StringSet("e007", JsonConvert.SerializeObject(e007)));

            // Retrieve .NET object from cache
            Employee e007FromCache = JsonConvert.DeserializeObject<Employee>(cache.StringGet("e007"));
            Console.WriteLine("Deserialized Employee .NET object :\n");
            Console.WriteLine("\tEmployee.Name : " + e007FromCache.Name);
            Console.WriteLine("\tEmployee.Id   : " + e007FromCache.Id);
            Console.WriteLine("\tEmployee.Age  : " + e007FromCache.Age + "\n");

Presione Ctrl+F5 para compilar y ejecutar la aplicación de consola para probar la serialización de objetos .NET.Press Ctrl+F5 to build and run the console app to test serialization of .NET objects.

Aplicación de consola finalizada

Limpieza de recursosClean up resources

Si va a seguir con el tutorial siguiente, puede mantener los recursos creados en esta guía de inicio rápido y volverlos a utilizar.If you will be continuing to the next tutorial, you can keep the resources created in this quickstart and reuse them.

En caso contrario, si ya ha terminado con la aplicación de ejemplo de la guía de inicio rápido, puede eliminar los recursos de Azure creados en este tutorial para evitar cargos.Otherwise, if you are finished with the quickstart sample application, you can delete the Azure resources created in this quickstart to avoid charges.

Importante

La eliminación de un grupo de recursos es irreversible y el grupo de recursos y todos los recursos que contiene se eliminarán de forma permanente.Deleting a resource group is irreversible and that the resource group and all the resources in it are permanently deleted. Asegúrese de no eliminar por accidente el grupo de recursos o los recursos equivocados.Make sure that you do not accidentally delete the wrong resource group or resources. Si ha creado los recursos para hospedar este ejemplo dentro de un grupo de recursos existente que contiene recursos que desea mantener, puede eliminar cada recurso individualmente de sus hojas respectivas, en lugar de eliminar el grupo de recursos.If you created the resources for hosting this sample inside an existing resource group that contains resources you want to keep, you can delete each resource individually from their respective blades instead of deleting the resource group.

Inicie sesión en Azure Portal y haga clic en Grupos de recursos.Sign in to the Azure portal and click Resource groups.

Escriba el nombre del grupo de recursos en el cuadro de texto Filtrar por nombre....In the Filter by name... textbox, type the name of your resource group. En las instrucciones de este artículo se usa un grupo de recursos llamado TestResources.The instructions for this article used a resource group named TestResources. En el grupo de recursos de la lista de resultados, haga clic en ... y, a continuación, en Eliminar grupo de recursos.On your resource group in the result list, click ... then Delete resource group.

Eliminar

Se le pedirá que confirme la eliminación del grupo de recursos.You will be asked to confirm the deletion of the resource group. Escriba el nombre del grupo de recursos para confirmar y haga clic en Eliminar.Type the name of your resource group to confirm, and click Delete.

Transcurridos unos instantes, el grupo de recursos y todos los recursos que contiene se eliminan.After a few moments, the resource group and all of its contained resources are deleted.

Pasos siguientesNext steps

En este inicio rápido, ha aprendido a usar Azure Redis Cache desde una aplicación .NET.In this quickstart, you learned how to use Azure Cache for Redis from a .NET application. Continúe con el siguiente inicio rápido para usar Azure Redis Cache con una aplicación web ASP.NET.Continue to the next quickstart to use Azure Cache for Redis with an ASP.NET web app.