Så här använder du Azure Queue Storage från Node.js

1. Skriv npm install @azure/storage-queue i kommandofönstret.

2. Kontrollera att en node_modules mapp har skapats. I den mappen hittar du paketet, @azure/storage-queue som innehåller det klientbibliotek som du behöver för att komma åt lagringen.

1. Skriv npm install azure-storage i kommandofönstret.

2. Kontrollera att en node_modules mapp har skapats. I den mappen hittar du paketet, som azure-storage innehåller de bibliotek som du behöver för att komma åt lagringen.

const { QueueClient, QueueServiceClient } = require("@azure/storage-queue");

var azure = require('azure-storage');

Följande kod hämtar värdet för en miljövariabel med namnet AZURE_STORAGE_CONNECTION_STRING och använder den för att skapa ett QueueServiceClient -objekt. Det här objektet används sedan för att skapa QueueClient ett -objekt som gör att du kan arbeta med en specifik kö.

// Retrieve the connection from an environment
// variable called AZURE_STORAGE_CONNECTION_STRING
const connectionString = process.env.AZURE_STORAGE_CONNECTION_STRING;

// Create a unique name for the queue
const queueName = "myqueue-" + Date.now().toString();

console.log("Creating queue: ", queueName);

// Instantiate a QueueServiceClient which will be used
// to create a QueueClient and to list all the queues
const queueServiceClient = QueueServiceClient.fromConnectionString(connectionString);

// Get a QueueClient which will be used
// to create and manipulate a queue
const queueClient = queueServiceClient.getQueueClient(queueName);

// Create the queue
await queueClient.create();

Om kön redan finns, utlöstes ett undantag.

Azure-modulen läser miljövariablerna AZURE_STORAGE_ACCOUNT och , eller för information som krävs för att ansluta till ditt AZURE_STORAGE_ACCESS_KEY AZURE_STORAGE_CONNECTION_STRING Azure Storage konto. Om dessa miljövariabler inte har angetts måste du ange kontoinformationen när du anropar createQueueService .

Följande kod skapar ett QueueService -objekt som gör att du kan arbeta med köer.

var queueSvc = azure.createQueueService();

Anropa metoden createQueueIfNotExists för att skapa en ny kö med det angivna namnet eller returnera kön om den redan finns.

queueSvc.createQueueIfNotExists('myqueue', function(error, results, response){
  if(!error){
    // Queue created or exists
  }
});

Om kön skapas är result.created sant. Om kön finns är result.created falskt.

Om du vill lägga till ett meddelande i en kö anropar du sendMessage metoden .

messageText = "Hello, World";
console.log("Adding message to the queue: ", messageText);

// Add a message to the queue
await queueClient.sendMessage(messageText);

Om du vill infoga ett meddelande i en kö anropar du createMessage metoden för att skapa ett nytt meddelande och lägga till det i kön.

queueSvc.createMessage('myqueue', "Hello, World", function(error, results, response){
  if(!error){
    // Message inserted
  }
});

Som standard peekMessages granskar ett enskilt meddelande. I följande exempel tittar vi på de fem första meddelandena i kön. Om färre än fem meddelanden visas returneras bara de synliga meddelandena.

// Peek at messages in the queue
const peekedMessages = await queueClient.peekMessages({ numberOfMessages: 5 });

for (i = 0; i < peekedMessages.peekedMessageItems.length; i++) {
    // Display the peeked message
    console.log("Peeked message: ", peekedMessages.peekedMessageItems[i].messageText);
}

Som standard peekMessages granskar ett enskilt meddelande.

queueSvc.peekMessages('myqueue', function(error, results, response){
  if(!error){
    // Message text is in results[0].messageText
  }
});

resultinnehåller meddelandet .

Ändra innehållet i ett meddelande på plats i kön genom att anropa updateMessage .

// Get the first message in the queue
var receivedMessages = await queueClient.receiveMessages();
const firstMessage = receivedMessages.receivedMessageItems[0];

// Update the received message
await queueClient.updateMessage(
    firstMessage.messageId,
    firstMessage.popReceipt,
    "This message has been updated"
);

Ändra innehållet i ett meddelande på plats i kön genom att anropa updateMessage .

queueSvc.getMessages('myqueue', function(error, getResults, getResponse){
  if(!error){
    // Got the message
    var message = getResults[0];
    queueSvc.updateMessage('myqueue', message.messageId, message.popReceipt, 10, {messageText: 'new text'}, function(error, updateResults, updateResponse){
      if(!error){
        // Message updated successfully
      }
    });
  }
});

Om du vill få ett meddelande anropar du receiveMessages metoden . Det här anropet gör meddelandena osynliga i kön, så att inga andra klienter kan bearbeta dem. När programmet har bearbetat ett meddelande anropar du deleteMessage för att ta bort det från kön.

// Get next message from the queue
receivedMessages = await queueClient.receiveMessages();
var message = receivedMessages.receivedMessageItems[0];

console.log("Dequeuing message: ", message.messageText);

await queueClient.deleteMessage(message.messageId, message.popReceipt);

Som standard är ett meddelande endast dolt i 30 sekunder. Efter 30 sekunder visas det för andra klienter. Du kan ange ett annat värde genom att ange options.visibilityTimeout när du anropar receiveMessages .

Om receiveMessages du anropar när det inte finns några meddelanden i kön returneras inget fel. Inga meddelanden returneras dock.

Om du vill få ett meddelande anropar du getMessages metoden . Det här anropet gör meddelandena osynliga i kön, så att inga andra klienter kan bearbeta dem. När programmet har bearbetat ett meddelande anropar du deleteMessage för att ta bort det från kön.

queueSvc.getMessages('myqueue', function(error, results, response){
  if(!error){
    // Message text is in results[0].messageText
    var message = results[0];
    queueSvc.deleteMessage('myqueue', message.messageId, message.popReceipt, function(error, response){
      if(!error){
        //message deleted
      }
    });
  }
});

Som standard är ett meddelande endast dolt i 30 sekunder. Efter 30 sekunder visas det för andra klienter. Du kan ange ett annat värde med hjälp options.visibilityTimeout av med getMessages .

Om getMessages du använder när det inte finns några meddelanden i kön returneras inget fel. Inga meddelanden returneras dock.

Det finns två sätt att anpassa meddelandehämtning från en kö:

• options.numberOfMessages: Hämta en batch med meddelanden (upp till 32).
• options.visibilityTimeout: Ange en längre eller kortare tidsgräns för osynlighet.

I följande exempel används metoden receiveMessages för att hämta fem meddelanden i ett anrop. Sedan bearbetar den varje meddelande med hjälp av en for loop. Det anger också tidsgränsen för osynlighet till fem minuter för alla meddelanden som returneras med den här metoden.

// Get up to 5 messages from the queue
const receivedMsgsResp = await queueClient.receiveMessages({ numberOfMessages: 5, visibilityTimeout: 5 * 60 });

for (i = 0; i < receivedMsgsResp.receivedMessageItems.length; i++)
{
    message = receivedMsgsResp.receivedMessageItems[i];
    console.log("Dequeuing message: ", message.messageText);
    await queueClient.deleteMessage(message.messageId, message.popReceipt);
}

Det finns två sätt att anpassa meddelandehämtning från en kö:

• options.numOfMessages: Hämta en batch med meddelanden (upp till 32).
• options.visibilityTimeout: Ange en längre eller kortare tidsgräns för osynlighet.

I följande exempel används metoden getMessages för att hämta 15 meddelanden i ett anrop. Sedan bearbetar den varje meddelande med hjälp av en for loop. Det anger också tidsgränsen för osynlighet till fem minuter för alla meddelanden som returneras med den här metoden.

queueSvc.getMessages('myqueue', {numOfMessages: 15, visibilityTimeout: 5 * 60}, function(error, results, getResponse){
  if(!error){
    // Messages retrieved
    for(var index in results){
      // text is available in result[index].messageText
      var message = results[index];
      queueSvc.deleteMessage(queueName, message.messageId, message.popReceipt, function(error, deleteResponse){
        if(!error){
          // Message deleted
        }
      });
    }
  }
});

Metoden getProperties returnerar metadata om kön, inklusive det ungefärliga antalet meddelanden som väntar i kön.

const properties = await queueClient.getProperties();
console.log("Approximate queue length: ", properties.approximateMessagesCount);

Metoden getQueueMetadata returnerar metadata om kön, inklusive det ungefärliga antalet meddelanden som väntar i kön.

queueSvc.getQueueMetadata('myqueue', function(error, results, response){
  if(!error){
    // Queue length is available in results.approximateMessageCount
  }
});

Om du vill hämta en lista över köer anropar du QueueServiceClient.listQueues . Om du vill hämta en lista filtrerad efter ett specifikt prefix anger du options.prefix i anropet till listQueues .

for await (const item of queueServiceClient.listQueues()) {
  console.log("Queue: ", item.name);
}

Om du vill hämta en lista över köer använder du listQueuesSegmented . Om du vill hämta en lista som filtrerats efter ett visst prefix använder du listQueuesSegmentedWithPrefix .

queueSvc.listQueuesSegmented(null, function(error, results, response){
  if(!error){
    // results.entries contains the list of queues
  }
});

Om alla köer inte kan returneras skickar du som den första parametern i eller result.continuationToken den andra listQueuesSegmented parametern för för att hämta fler listQueuesSegmentedWithPrefix resultat.

Om du vill ta bort en kö och alla meddelanden som finns i den DeleteQueue anropar du metoden för QueueClient -objektet.

// Delete the queue
console.log("Deleting queue: ", queueClient.name);
await queueClient.delete();

Om du vill rensa alla meddelanden från en kö utan att ta bort den anropar du ClearMessages .

Om du vill ta bort en kö och alla meddelanden som finns i den deleteQueue anropar du metoden för köobjektet.

queueSvc.deleteQueue(queueName, function(error, response){
  if(!error){
    // Queue has been deleted
  }
});

Om du vill rensa alla meddelanden från en kö utan att ta bort den anropar du clearMessages .