Azure Queue Storage gebruiken vanuit Node.js

1. Typ npm install @azure/storage-queue in het opdrachtvenster.

2. Controleer of er node_modules een map is gemaakt. In die map vindt u het @azure/storage-queue pakket, dat de clientbibliotheek bevat die u nodig hebt voor toegang tot de opslag.

1. Typ npm install azure-storage in het opdrachtvenster.

2. Controleer of er node_modules een map is gemaakt. In die map vindt u het azure-storage -pakket, dat de bibliotheken bevat die u nodig hebt voor toegang tot de opslag.

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

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

De volgende code haalt de waarde van een omgevingsvariabele met de naam AZURE_STORAGE_CONNECTION_STRING op en gebruikt deze om een -object te QueueServiceClient maken. Dit object wordt vervolgens gebruikt om een QueueClient -object te maken waarmee u met een specifieke wachtrij kunt werken.

// 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();

Als de wachtrij al bestaat, wordt er een uitzondering gemaakt.

De Azure-module leest de omgevingsvariabelen en , of voor informatie die nodig is om verbinding te maken met AZURE_STORAGE_ACCOUNT AZURE_STORAGE_ACCESS_KEY uw AZURE_STORAGE_CONNECTION_STRING Azure Storage account. Als deze omgevingsvariabelen niet zijn ingesteld, moet u de accountgegevens opgeven bij het aanroepen van createQueueService .

Met de volgende code maakt QueueService u een -object, waarmee u met wachtrijen kunt werken.

var queueSvc = azure.createQueueService();

Roep de methode aan om een nieuwe wachtrij met de opgegeven naam te maken of createQueueIfNotExists de wachtrij te retourneren als deze al bestaat.

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

Als de wachtrij is gemaakt, result.created is true. Als de wachtrij bestaat, result.created is false.

Als u een bericht aan een wachtrij wilt toevoegen, roept u de methode sendMessage aan.

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

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

Als u een bericht in een wachtrij wilt invoegen, roept u de methode aan om een nieuw bericht createMessage te maken en dit toe te voegen aan de wachtrij.

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

Standaard wordt peekMessages één bericht weergegeven. In het volgende voorbeeld worden de eerste vijf berichten in de wachtrij gekeken. Als er minder dan vijf berichten zichtbaar zijn, worden alleen de zichtbare berichten geretourneerd.

// 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);
}

Standaard wordt peekMessages één bericht weergegeven.

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

De result bevat het bericht.

Wijzig de inhoud van een bericht in de wachtrij door aan te updateMessage roepen.

// 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"
);

Wijzig de inhoud van een bericht in de wachtrij door aan te updateMessage roepen.

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
      }
    });
  }
});

Roep de methode aan om een bericht op te receiveMessages halen. Deze aanroep maakt de berichten onzichtbaar in de wachtrij, zodat andere clients ze niet kunnen verwerken. Zodra uw toepassing een bericht heeft verwerkt, roept u deleteMessage aan om het uit de wachtrij te verwijderen.

// 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);

Standaard wordt een bericht slechts 30 seconden verborgen. Na 30 seconden is deze zichtbaar voor andere clients. U kunt een andere waarde opgeven door in te stellen options.visibilityTimeout wanneer u aanroept. receiveMessages

Als receiveMessages u aanroept wanneer er geen berichten in de wachtrij staan, wordt er geen fout weergegeven. Er worden echter geen berichten geretourneerd.

Roep de methode aan om een bericht op te getMessages halen. Deze aanroep maakt de berichten onzichtbaar in de wachtrij, zodat andere clients ze niet kunnen verwerken. Zodra uw toepassing een bericht heeft verwerkt, roept u deleteMessage aan om het uit de wachtrij te verwijderen.

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
      }
    });
  }
});

Standaard wordt een bericht slechts 30 seconden verborgen. Na 30 seconden is deze zichtbaar voor andere clients. U kunt een andere waarde opgeven met options.visibilityTimeout behulp van getMessages .

Als getMessages u gebruikt wanneer er geen berichten in de wachtrij staan, wordt er geen foutbericht weergegeven. Er worden echter geen berichten geretourneerd.

Er zijn twee manieren waarop u het ophalen van berichten uit een wachtrij kunt aanpassen:

• options.numberOfMessages: Een batch berichten ophalen (maximaal 32).
• options.visibilityTimeout: Stel een langere of kortere time-out voor onzichtbaarheid in.

In het volgende voorbeeld wordt de receiveMessages methode gebruikt om vijf berichten in één aanroep op te halen. Vervolgens wordt elk bericht verwerkt met behulp van een for lus. Ook wordt de time-out voor onzichtbaarheid op vijf minuten voor alle berichten die door deze methode worden geretourneerd.

// 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);
}

Er zijn twee manieren waarop u het ophalen van berichten uit een wachtrij kunt aanpassen:

• options.numOfMessages: Een batch berichten ophalen (maximaal 32).
• options.visibilityTimeout: Stel een langere of kortere time-out voor onzichtbaarheid in.

In het volgende voorbeeld wordt de getMessages methode gebruikt om 15 berichten in één aanroep op te halen. Vervolgens wordt elk bericht verwerkt met behulp van een for lus. Ook wordt de time-out voor onzichtbaarheid op vijf minuten voor alle berichten die door deze methode worden geretourneerd.

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
        }
      });
    }
  }
});

De getProperties methode retourneert metagegevens over de wachtrij, inclusief het geschatte aantal berichten dat in de wachtrij wacht.

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

De getQueueMetadata methode retourneert metagegevens over de wachtrij, inclusief het geschatte aantal berichten dat in de wachtrij wacht.

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

Als u een lijst met wachtrijen wilt ophalen, roept u QueueServiceClient.listQueues aan. Als u een lijst wilt ophalen die is gefilterd op een specifiek voorvoegsel, stelt u options.prefix in uw aanroep naar listQueues in.

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

Gebruik om een lijst met wachtrijen op te listQueuesSegmented halen. Gebruik om een lijst op te halen die is gefilterd op een specifiek listQueuesSegmentedWithPrefix voorvoegsel.

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

Als niet alle wachtrijen kunnen worden geretourneerd, geeft u door als de eerste parameter van of de result.continuationToken tweede parameter van om meer resultaten op te listQueuesSegmented listQueuesSegmentedWithPrefix halen.

Als u een wachtrij en alle berichten erin wilt verwijderen, roept u de DeleteQueue -methode op het QueueClient -object aan.

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

Als u alle berichten uit een wachtrij wilt verwijderen zonder deze te verwijderen, roept u ClearMessages aan.

Als u een wachtrij en alle berichten erin wilt verwijderen, roept u de deleteQueue methode aan voor het wachtrijobject.

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

Als u alle berichten uit een wachtrij wilt verwijderen zonder deze te verwijderen, roept u clearMessages aan.