Snabbstart: Använda Azure Cache for Redis i Node.js

I den här snabbstarten införlivar du Azure Cache for Redis i en Node.js-app för att få åtkomst till en säker, dedikerad cache som kan nås från alla program i Azure.

Hoppa till koden på GitHub

Om du vill hoppa direkt till koden kan du gåNode.js snabbstarten på GitHub.

Förutsättningar

• Azure-prenumeration – skapa en kostnadsfritt
• node_redis, som du kan installera med kommandot npm install redis .

Exempel på användning av andra Node.js-klienter finns i dokumentationen till enskilda Node.js-klienter som anges i Node.js Redis-klienter.

Skapa en cache

1. Om du vill skapa ett cacheminne loggar du in Azure Portal och väljer Skapa en resurs.

   

2. På sidan Nytt väljer du Databaser och väljer sedan Azure Cache for Redis.

   

3. På sidan Ny Redis Cache konfigurerar du inställningarna för den nya cachen.

   Inställning	Välj ett värde	Beskrivning
   Prenumeration	I listrutan väljer du din prenumeration.	Prenumerationen där den nya instansen ska skapas Azure Cache for Redis instansen.
   Resursgrupp	Välj en resursgrupp i listrutan eller välj Skapa ny och ange ett nytt resursgruppnamn.	Namnet på den resursgrupp där du vill skapa ditt cacheminne och andra resurser. Genom att placera alla dina appresurser i en resursgrupp kan du enkelt hantera eller ta bort dem tillsammans.
   DNS-namn	Ange ett unikt namn.	Cachenamnet måste vara en sträng mellan 1 och 63 tecken som endast innehåller siffror, bokstäver eller bindestreck. Namnet måste börja och sluta med en siffra eller bokstav och får inte innehålla efterföljande bindestreck. Cacheinstansens värdnamn blir <DNS name> .redis.cache.windows.net.
   Plats	Välj en plats i listrutan.	Välj en region nära andra tjänster som ska använda ditt cacheminne.
   Cachetyp	I listrutan väljer du en nivå.	Nivån avgör storlek, prestanda och funktioner som är tillgängliga för cachen. Mer information finns i Översikt över Azure Cache for Redis.

4. Välj fliken Nätverk eller välj knappen Nätverk längst ned på sidan.

5. På fliken Nätverk väljer du din anslutningsmetod.

6. Välj fliken Nästa: Avancerat eller välj knappen Nästa: Avancerat längst ned på sidan.

7. På fliken Avancerat för en basic- eller standard-cacheinstans väljer du aktivera om du vill aktivera en icke-TLS-port. Du kan också välja vilken Redis-version du vill använda, antingen 4 eller 6.

   

8. På fliken Avancerat för premiumcacheinstansen konfigurerar du inställningarna för icke-TLS-port, klustring och datapersistence. Du kan också välja vilken Redis-version du vill använda, antingen 4 eller 6.

9. Välj fliken Nästa: Taggar eller välj knappen Nästa: Taggar längst ned på sidan.

10. Du kan också ange namn och värde på fliken Taggar om du vill kategorisera resursen.

11. Välj Granska + skapa. Du kommer till fliken Granska + skapa där Azure verifierar din konfiguration.

12. När det gröna meddelandet Valideringen har godkänts visas väljer du Skapa.

Det tar en stund innan cacheminnet skapas. Du kan övervaka förloppet på Azure Cache for Redis översiktssidan. När Status visas som Körs är cacheminnet klart att användas.

Hämta värdnamn, portar och åtkomstnycklar från Azure Portal

För att kunna ansluta Azure Cache for Redis en instans behöver cacheklienter värdnamnet, portarna och en nyckel för cachen. Vissa klienter kan hänvisa till dessa objekt med namn som skiljer sig något. Du kan hämta värdnamn, portar och nycklar från Azure Portal.

• Om du vill hämta åtkomstnycklarna går du till det vänstra navigeringsfönstret i cacheminnet och väljer Åtkomstnycklar.

  

• Om du vill hämta värdnamnet och portarna går du till det vänstra navigeringsfönstret i cacheminnet och väljer Egenskaper. Värdnamnet har formen <DNS name> .redis.cache.windows.net.

  

Lägg till miljövariabler för HOST NAME och primär åtkomstnyckel. Använd dessa variabler från din kod i stället för att inkludera känslig information direkt i koden.

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

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

Ansluta till cachen

De senaste versionerna av node_redis har stöd för att ansluta till Azure Cache for Redis med TLS. I följande exempel visas hur du ansluter till Azure Cache for Redis med TLS-slutpunkten 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}});

Skapa inte en ny anslutning för varje åtgärd i koden. Återanvänd istället anslutningar så mycket som möjligt.

Skapa en ny Node.js-app

Skapa en ny skriptfil med namnet redistest.js. Använd kommandot för npm install redis bluebird att installera nödvändiga paket.

Lägg till följande JavaScript-exempel i filen. Den här koden visar hur du ansluter till en Azure Cache for Redis-instans med hjälp av cache-värdnamnet och viktiga miljövariabler. Koden lagrar och hämtar även ett strängvärde i cacheminnet. Kommandona PING och CLIENT LIST körs också. Fler exempel på hur du använder Redis med node_redis-klienten finns på https://redis.js.org/.

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

// Convert Redis client API to use promises, to make it usable with async/await syntax
bluebird.promisifyAll(redis.RedisClient.prototype);
bluebird.promisifyAll(redis.Multi.prototype);

async function testCache() {

    // Connect to the Azure Cache for Redis over the TLS 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();

Kör skriptet med Node.js.

node redistest.js

I exemplet nedan ser du att Message-nyckeln tidigare hade ett cachelagrat värde som angavs med Redis-konsolen i Azure Portal. Appen uppdatera det cachelagrade värdet. Appen körde även kommandona PING och CLIENT LIST.

Rensa resurser

Om du fortsätter till nästa självstudie kan du behålla resurserna som skapats i den här snabbstarten och återanvända dem.

Om du är klar med exempelprogrammet för snabbstart kan du ta bort Azure-resurserna som skapades i den här snabbstarten för att undvika kostnader.

Logga in på Azure Portal och välj Resursgrupper.

I textrutan Filtrera efter namn anger du namnet på din resursgrupp. Anvisningarna för den här artikeln använde en resursgrupp med namnet TestResources. I din resursgrupp i resultatlistan väljer du ... och sedan Ta bort resursgrupp.

Du uppmanas att bekräfta borttagningen av resursgruppen. Ange namnet på resursgruppen för att bekräfta och välj Ta bort.

Efter en liten stund tas resursgruppen och resurser som finns i den bort.

Nästa steg

I den här snabbstarten har du lärt dig att använda Azure Cache for Redis från ett Node.js-program. Fortsätt till nästa snabbstart om du vill använda Azure Cache for Redis med en ASP.NET-webbapp.