Inicio rápido: Uso de Azure Redis Cache con Node.jsQuickstart: How to use Azure Cache for Redis with Node.js

Azure Redis Cache le ofrece acceso a una instancia de Azure Redis Cache dedicada y segura administrada por Microsoft.Azure Cache for Redis gives you access to a secure, dedicated Azure Cache for Redis, managed by Microsoft. Se puede obtener acceso a su caché desde cualquier aplicación dentro de Microsoft Azure.Your cache is accessible from any application within Microsoft Azure.

En este tema se explica cómo comenzar a usar Azure Redis Cache mediante Node.js.This topic shows you how to get started with Azure Cache for Redis using Node.js.

Puede usar cualquier editor de código para realizar los pasos de esta guía de inicio rápido.You can use any code editor to complete the steps in this quickstart. Sin embargo, Visual Studio Code es una excelente opción disponible en las plataformas Windows, macOS y Linux.However, Visual Studio Code is an excellent option available on the Windows, macOS, and Linux platforms.

Aplicación de caché 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

Instale node_redis:Install node_redis:

npm install redis

En este tutorial se usa node_redis.This tutorial uses node_redis. Para ver ejemplos del uso de otros clientes de Node.js, consulte la documentación individual de los clientes de Node.js, que encontrará en clientes Redis de Node.js.For examples of using other Node.js clients, see the individual documentation for the Node.js clients listed at Node.js Redis clients.

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

Agregue variables de entorno para el nombre de host y la clave de acceso Principal.Add environment variables for your HOST NAME and Primary access key. Utilizará estas variables desde el código en lugar de incluir la información confidencial directamente en el código.You will use these variables from your code instead of including the sensitive information directly in your code.

set REDISCACHEHOSTNAME=contosoCache.redis.cache.windows.net
set REDISCACHEKEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

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

Las compilaciones más recientes de node_redis permiten conectarse a Azure Redis Cache mediante SSL.The latest builds of node_redis provide support for connecting to Azure Cache for Redis using SSL. En el ejemplo siguiente se muestra cómo conectarse a Azure Redis Cache con el punto de conexión SSL de 6380.The following example shows how to connect to Azure Cache for Redis using the SSL endpoint of 6380.

var redis = require("redis");

// Add your cache name and access key.
var client = redis.createClient(6380, process.env.REDISCACHEHOSTNAME,
    {auth_pass: process.env.REDISCACHEKEY, tls: {servername: process.env.REDISCACHEHOSTNAME}});

No cree una conexión nueva para cada operación en el código.Don't create a new connections for each operation in your code. En su lugar, reutilice las conexiones tanto como sea posible.Instead, reuse connections as much as possible.

Creación de una nueva aplicación Node.jsCreate a new Node.js app

Cree un nuevo archivo de script llamado redistest.js.Create a new script file named redistest.js.

Agregue el siguiente ejemplo de JavaScript en el archivo.Add the following example JavaScript to the file. Este código muestra cómo conectarse a una instancia de Azure Redis Cache usando las variables de entorno de nombre de host de caché y clave.This code shows you how to connect to an Azure Cache for Redis instance using the cache host name and key environment variables. El código también almacena y recupera un valor de cadena en la memoria caché.The code also stores and retrieves a string value in the cache. También se ejecutan los comandos PING y CLIENT LIST.The PING and CLIENT LIST commands are also executed. Para ver otros ejemplos sobre el uso de Redis con el cliente node_redis, consulte https://redis.js.org/.For more examples of using Redis with the node_redis client, see https://redis.js.org/.

var redis = require("redis");
var bluebird = require("bluebird");

bluebird.promisifyAll(redis.RedisClient.prototype);
bluebird.promisifyAll(redis.Multi.prototype);

async function testCache() {

    // Connect to the Azure Cache for Redis over the SSL port using the key.
    var cacheConnection = redis.createClient(6380, process.env.REDISCACHEHOSTNAME, 
        {auth_pass: process.env.REDISCACHEKEY, tls: {servername: process.env.REDISCACHEHOSTNAME}});
        
    // Perform cache operations using the cache connection object...

    // Simple PING command
    console.log("\nCache command: PING");
    console.log("Cache response : " + await cacheConnection.pingAsync());

    // Simple get and put of integral data types into the cache
    console.log("\nCache command: GET Message");
    console.log("Cache response : " + await cacheConnection.getAsync("Message"));    

    console.log("\nCache command: SET Message");
    console.log("Cache response : " + await cacheConnection.setAsync("Message",
        "Hello! The cache is working from Node.js!"));    

    // Demonstrate "SET Message" executed as expected...
    console.log("\nCache command: GET Message");
    console.log("Cache response : " + await cacheConnection.getAsync("Message"));    

    // Get the client list, useful to see if connection list is growing...
    console.log("\nCache command: CLIENT LIST");
    console.log("Cache response : " + await cacheConnection.clientAsync("LIST"));    
}

testCache();

Ejecute el script con Node.js.Run the script with Node.js.

node redistest.js

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 caché 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 Node.js.In this quickstart, you learned how to use Azure Cache for Redis from a Node.js 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.