Início Rápido: Usar o Cache do Azure para Redis no Node.js

Neste guia de início rápido, você incorporará o Cache do Azure para Redis a um aplicativo Node.js para ter acesso a um cache seguro e dedicado que pode ser acessado de qualquer aplicativo no Azure.

Pular para o código no GitHub

Se você quiser pular diretamente para o código, confira o Guia de início rápido do Node.js no GitHub.

Pré-requisitos

Para exemplos de uso de outros clientes do Node.js, veja a documentação individual para os clientes do Node.js listado em clientes do Redis Node.js.

Criar um cache

  1. Para criar um cache, entre no portal do Azure e selecione Criar um recurso.

    Create a resource is highlighted in the left navigation pane.

  2. Na página Novo, selecione Bancos de dados e, em seguida, Cache do Azure para Redis.

    On New, Databases is highlighted, and Azure Cache for Redis is highlighted.

  3. Na página Novo Cache Redis, defina as configurações para o novo cache.

    Configuração Escolher um valor Descrição
    Assinatura Clique na lista suspensa e selecione sua assinatura. A assinatura na qual essa nova instância do Cache do Azure para Redis será criada.
    Grupo de recursos Clique na lista suspensa e selecione um grupo de recursos ou selecione Criar e insira um novo nome de grupo de recursos. Nome do grupo de recursos no qual o cache e outros recursos serão criados. Ao colocar todos os seus recursos de aplicativos em um só grupo de recursos, você pode gerenciá-los ou excluí-los juntos com facilidade.
    Nome DNS Insira um nome exclusivo. O nome do cache deve conter de 1 a 63 caracteres e incluir somente números, letras ou hifens. O nome precisa começar e terminar com um número ou uma letra e não pode conter hifens consecutivos. O nome do host da instância de cache será o <nome DNS>.redis.cache.windows.net.
    Localidade Clique na lista suspensa e selecione uma localização. Selecione uma região perto de outros serviços que usarão o cache.
    Tipo de cache Clique na lista suspensa e selecione uma camada. A camada determina o tamanho, o desempenho e os recursos disponíveis para o cache. Para obter mais informações, confira Visão geral do Cache do Azure para Redis.
  4. Selecione a guia Rede ou o botão Rede na parte inferior da página.

  5. Na guia Rede, escolha o método de conectividade.

  6. Selecione a guia Próximo: Avançado ou o botão Próximo: Avançado na parte inferior da página.

  7. Na guia Avançado de uma instância de cache Básico ou Standard, selecione a alternância Habilitar se desejar habilitar uma porta não TLS. Também é possível selecionar qual versão do Redis você gostaria de usar, a 4 ou a 6.

    Redis version 4 or 6.

  8. Na guia Avançado de uma instância de cache Premium, defina as configurações da porta não TLS, do clustering e da persistência de dados. Também é possível selecionar qual versão do Redis você gostaria de usar, a 4 ou a 6.

  9. Selecione a guia Próximo: Marcas ou o botão Próximo: Marcas na parte inferior da página.

  10. Opcionalmente, na guia Marcas, insira o nome e o valor caso deseje categorizar o recurso.

  11. Selecione Examinar + criar. Você será levado para a guia Examinar + criar, na qual o Azure validará a configuração.

  12. Depois que a mensagem em verde Validação aprovada for exibida, selecione Criar.

A criação do cache demora um pouco. Monitore o progresso na página Visão Geral do Cache do Azure para Redis. Quando o Status for mostrado como Em execução, o cache estará pronto para uso.

Recuperar o nome de host, as portas e as chaves de acesso do portal do Azure

Para conectar seu servidor do Cache do Azure para Redis, o cliente de cache precisa do nome do host, das portas e de uma chave para o cache. Alguns clientes podem se referir a esses itens por nomes um pouco diferentes. Você pode obter o nome do host, as portas e as chaves do portal do Azure.

  • Para obter as chaves de acesso, na navegação à esquerda do cache, selecione Chaves de acesso.

    Azure Cache for Redis keys

  • Para obter o nome do host e as portas, no painel de navegação esquerdo do cache, selecione Propriedades. O nome do host está no formato <nome DNS>.redis.cache.windows.net.

    Azure Cache for Redis properties

Adicionar variáveis de ambiente para o seu NOME DO HOST e a chave de acesso Primária. Use essas variáveis no seu código em vez de incluir as informações confidenciais diretamente no seu código.

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

Conectar-se ao cache

Os últimos builds do node_redis dão suporte para se conectar ao Cache do Azure para Redis usando TLS. O exemplo a seguir mostra como se conectar ao Cache do Azure para Redis usando o ponto de extremidade TLS 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}});

Não crie uma conexão para cada operação em seu código. Em vez disso, reutilize conexões sempre que possível.

Criar um novo aplicativo Node.js

Criar um novo arquivo de script chamado redistest.js. Use o comando npm install redis bluebird para instalar os pacotes necessários.

Adicione o exemplo JavaScript a seguir ao arquivo. Este código mostra como se conectar a uma instância do Cache do Azure para Redis usando o nome de host de cache e as principais variáveis de ambiente. O código também armazena e recupera um valor de cadeia de caracteres no cache. Os comandos PING e CLIENT LIST também são executados. Para obter mais exemplos de como usar Redis com o cliente node_redis, veja https://redis.js.org/.

var redis = require("redis");

async function testCache() {

    // Connect to the Azure Cache for Redis over the TLS port using the key.
    var cacheHostName = process.env.REDISCACHEHOSTNAME;
    var cachePassword = process.env.REDISCACHEKEY;
    var cacheConnection = redis.createClient({
        // rediss for TLS
        url: "rediss://" + cacheHostName + ":6380",
        password: cachePassword,
    });
    await cacheConnection.connect();

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

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

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

    console.log("\nCache command: SET Message");
    console.log("Cache response : " + await cacheConnection.set("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.get("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.sendCommand(["CLIENT", "LIST"]));

    console.log("\nDone");
    process.exit();
}

testCache();

Execute o script com Node.js.

node redistest.js

No exemplo abaixo, você pode ver que a chave Message já tinha um valor armazenado em cache, que foi definido por meio do Console do Redis no portal do Azure. O aplicativo atualizou esse valor armazenado em cache. O aplicativo também executou os comandos PING e CLIENT LIST.

Redis Cache app completed

Limpar os recursos

Se for prosseguir para o próximo tutorial, mantenha os recursos criados neste início rápido e reutilize-os.

Caso contrário, se você não for mais usar o aplicativo de exemplo do início rápido, exclua os recursos do Azure criados neste início rápido para evitar encargos.

Importante

A exclusão de um grupo de recursos é irreversível, e o grupo de recursos e todos os recursos contidos nele são excluídos permanentemente. Não exclua acidentalmente o grupo de recursos ou os recursos incorretos. Se tiver criado os recursos para hospedar este exemplo dentro de um grupo de recursos existente que contém recursos que quer manter, exclua cada recurso individualmente à esquerda, em vez de excluir o grupo de recursos.

Entre no portal do Azure e selecione Grupos de recursos.

Na caixa de texto Filtrar por nome, digite o nome do seu grupo de recursos. As instruções deste artigo usaram um grupo de recursos chamado TestResources. Em seu grupo de recursos, na lista de resultados, selecione ... e então Excluir grupo de recursos.

Delete Azure Resource group

Você receberá uma solicitação para confirmar a exclusão do grupo de recursos. Insira o nome do grupo de recursos para confirmar e selecione Excluir.

Após alguns instantes, o grupo de recursos, e todos os recursos contidos nele, serão excluídos.

Próximas etapas

Neste guia de início rápido, você aprendeu a usar o Cache do Azure para Redis de um aplicativo Node.js. Continue para o próximo início rápido usar o Cache do Azure para Redis com um aplicativo Web ASP.NET.