Jak používat azure queue Storage z Node.js

1. Do npm install @azure/storage-queue příkazového okna zadejte .

2. Ověřte, že node_modules se vytvořila složka. V této složce najdete balíček , který obsahuje klientskou knihovnu, @azure/storage-queue kterou potřebujete pro přístup k úložišti.

1. Do npm install azure-storage příkazového okna zadejte .

2. Ověřte, že node_modules se vytvořila složka. V této složce najdete balíček , který obsahuje knihovny, které potřebujete pro azure-storage přístup k úložišti.

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

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

Následující kód získá hodnotu proměnné prostředí s názvem AZURE_STORAGE_CONNECTION_STRING a použije ji k vytvoření QueueServiceClient objektu. Tento objekt se pak použije k vytvoření QueueClient objektu, který umožňuje pracovat s konkrétní frontou.

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

Pokud fronta již existuje, je vyvolána výjimka.

Modul Azure přečte proměnné prostředí a , nebo informace potřebné pro připojení k vašemu AZURE_STORAGE_ACCOUNT AZURE_STORAGE_ACCESS_KEY Azure Storage AZURE_STORAGE_CONNECTION_STRING účtu. Pokud tyto proměnné prostředí nejsou nastavené, musíte při volání zadat informace o createQueueService účtu.

Následující kód vytvoří objekt , který vám umožní QueueService pracovat s frontami.

var queueSvc = azure.createQueueService();

Voláním metody vytvořte novou frontu se createQueueIfNotExists zadaným názvem nebo ji vraťte, pokud už existuje.

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

Pokud je fronta vytvořená, result.created má hodnotu true. Pokud fronta existuje, result.created má hodnotu false.

Pokud chcete přidat zprávu do fronty, zavolejte sendMessage metodu .

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

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

Pokud chcete vložit zprávu do fronty, zavolejte metodu , která createMessage vytvoří novou zprávu a přidá ji do fronty.

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

Ve výchozím nastavení peekMessages se zobrazí náhled jedné zprávy. Následující příklad si prohlédne prvních pět zpráv ve frontě. Pokud je vidět méně než pět zpráv, vrátí se pouze viditelné zprávy.

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

Ve výchozím nastavení peekMessages se zobrazí náhled jedné zprávy.

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

Obsahuje result zprávu .

Změňte obsah zprávy na místě ve frontě voláním 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"
);

Změňte obsah zprávy na místě ve frontě voláním 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
      }
    });
  }
});

Pokud chcete získat zprávu, zavolejte receiveMessages metodu . Díky tomuto volání jsou zprávy ve frontě neviditelné, takže je jiní klienti neschová. Jakmile vaše aplikace zprávu zpracuje, zavolejte a deleteMessage odstraňte ji z fronty.

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

Ve výchozím nastavení je zpráva skrytá pouze po dobu 30 sekund. Po 30 sekundách se zobrazí ostatním klientům. Jinou hodnotu můžete zadat nastavením při options.visibilityTimeout volání receiveMessages .

Volání receiveMessages , pokud ve frontě nejsou žádné zprávy, nevrátí chybu. Nebudou však vráceny žádné zprávy.

Pokud chcete získat zprávu, zavolejte getMessages metodu . Díky tomuto volání jsou zprávy ve frontě neviditelné, takže je jiní klienti neschová. Jakmile vaše aplikace zprávu zpracuje, zavolejte a deleteMessage odstraňte ji z fronty.

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

Ve výchozím nastavení je zpráva skrytá pouze po dobu 30 sekund. Po 30 sekundách se zobrazí ostatním klientům. Pomocí můžete zadat jinou options.visibilityTimeout getMessages hodnotu.

Pokud getMessages ve frontě nejsou žádné zprávy, pomocí příkazu se nevrátí chyba. Nebudou však vráceny žádné zprávy.

Načítání zpráv z fronty můžete přizpůsobit dvěma způsoby:

• options.numberOfMessages: Načtení dávky zpráv (až 32).
• options.visibilityTimeout: Nastavte delší nebo kratší časový limit neviditelnosti.

Následující příklad používá receiveMessages metodu k získání pěti zpráv v jednom volání. Pak každou zprávu zpracuje pomocí for smyčky . Nastaví také časový limit neviditelnosti na pět minut pro všechny zprávy vrácené touto metodou.

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

Načítání zpráv z fronty můžete přizpůsobit dvěma způsoby:

• options.numOfMessages: Načtení dávky zpráv (až 32).
• options.visibilityTimeout: Nastavte delší nebo kratší časový limit neviditelnosti.

Následující příklad používá getMessages metodu k získání 15 zpráv v jednom volání. Pak každou zprávu zpracuje pomocí for smyčky . Nastaví také časový limit neviditelnosti na pět minut pro všechny zprávy vrácené touto metodou.

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

getPropertiesMetoda vrátí metadata o frontě, včetně přibližného počtu zpráv čekajících ve frontě.

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

getQueueMetadataMetoda vrátí metadata o frontě, včetně přibližného počtu zpráv čekajících ve frontě.

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

Chcete-li načíst seznam front, zavolejte QueueServiceClient.listQueues . Chcete-li načíst seznam filtrovaný konkrétní předponou, nastavte možnost Options. prefix na listQueues .

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

Chcete-li načíst seznam front, použijte listQueuesSegmented . Chcete-li načíst seznam filtrovaný pomocí konkrétní předpony, použijte listQueuesSegmentedWithPrefix .

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

Pokud nelze vrátit všechny fronty, předejte result.continuationToken jako první parametr listQueuesSegmented nebo druhý parametr listQueuesSegmentedWithPrefix pro získání více výsledků.

Chcete-li odstranit frontu a všechny zprávy, které jsou v něm obsaženy, zavolejte DeleteQueue metodu QueueClient objektu.

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

Chcete-li vymazat všechny zprávy z fronty bez jejich odstranění, zavolejte ClearMessages .

Pokud chcete odstranit frontu a všechny zprávy, které jsou v ní obsažené, zavolejte deleteQueue metodu u objektu Queue.

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

Chcete-li vymazat všechny zprávy z fronty bez jejich odstranění, zavolejte clearMessages .