Freigeben über

Azure Storage Queue-Clientbibliothek für JavaScript – Version 12.28.1

Azure Storage Queue bietet Cloud-Messaging zwischen Anwendungskomponenten. Beim Entwerfen von Anwendungen für die Skalierung werden Anwendungskomponenten häufig entkoppelt, sodass sie unabhängig voneinander skaliert werden können. Der Warteschlangenspeicher liefert asynchrones Messaging für die Kommunikation zwischen Anwendungskomponenten, unabhängig davon, ob sie in der Cloud, auf dem Desktop, auf einem lokalen Server oder auf einem mobilen Gerät ausgeführt werden. Der Warteschlangenspeicher unterstützt auch die Verwaltung asynchroner Aufgaben und das Erstellen von Prozessarbeitsabläufen.

Dieses Projekt stellt eine Clientbibliothek in JavaScript bereit, die das Verwenden des Azure Storage Queue-Diensts erleichtert.

Verwenden Sie die Clientbibliotheken in diesem Paket, um:

  • Abrufen/Festlegen von Warteschlangendiensteigenschaften
  • Erstellen/Auflisten/Löschen von Warteschlangen
  • Senden/Empfangen/Vorschau/Löschen/Aktualisieren/Löschen von Warteschlangennachrichten

Wichtige Links:

Erste Schritte

Derzeit unterstützte Umgebungen

Weitere Informationen finden Sie in unserer Supportrichtlinie.

Prerequisites

Installieren des Pakets

Die bevorzugte Methode zum Installieren der Azure Storage Queue-Clientbibliothek für JavaScript ist die Verwendung des npm-Paket-Managers. Geben Sie Folgendes in ein Terminalfenster ein:

npm install @azure/storage-queue

Authentifizieren des Clients

Azure Storage unterstützt mehrere Möglichkeiten zur Authentifizierung. Um mit dem Azure Queue Storage-Dienst zu interagieren, müssen Sie beispielsweise eine Instanz eines Speicherclients erstellen – QueueServiceClient oder QueueClient. Weitere Informationen zur Authentifizierung finden Sie in Beispielen zum Erstellen des QueueServiceClient.

Azure Active Directory

Der Azure Queue Storage-Dienst unterstützt die Verwendung von Azure Active Directory zum Authentifizieren von Anforderungen an seine APIs. Das @azure/identity-Paket bietet eine Vielzahl von Anmeldeinformationstypen, die Ihre Anwendung verwenden kann, um dies zu tun. Weitere Details und Beispiele für die ersten Schritte finden Sie in der README für @azure/identity.

Compatibility

Diese Bibliothek ist mit Node.js und Browsern kompatibel und wird mit LTS-Node.js-Versionen (>=8.16.0) und den neuesten Versionen von Chrome, Firefox und Edge überprüft.

Web-Arbeiter

Diese Bibliothek erfordert, dass bestimmte DOM-Objekte global verfügbar sind, wenn sie im Browser verwendet werden, die Web-Worker standardmäßig nicht verfügbar machen. Sie müssen diese polyausfüllen, damit diese Bibliothek in Web-Workern funktioniert.

Weitere Informationen finden Sie in unserer Dokumentation zur Verwendung des Azure SDK für JS in Web Workers

Diese Bibliothek hängt von den folgenden DOM-APIs ab, die externe Polyfills benötigen, die bei Verwendung in Web-Workern geladen werden:

Unterschiede zwischen Node.js und Browsern

Es gibt Unterschiede zwischen Node.js und Browserlaufzeit. Achten Sie bei den ersten Schritten mit dieser Bibliothek auf APIs oder Klassen, die mit "NUR IN NODE.JS RUNTIME VERFÜGBAR" gekennzeichnet sind, oder "NUR IN BROWSERN VERFÜGBAR".

Die folgenden Features, Schnittstellen, Klassen oder Funktionen sind nur in Node.js
  • Gemeinsame Schlüsselautorisierung basierend auf Kontoname und Kontoschlüssel
    • StorageSharedKeyCredential
  • Generierung von Shared Access Signature(SAS)
    • generateAccountSASQueryParameters()
    • generateQueueSASQueryParameters()

JavaScript-Bündel

Um diese Clientbibliothek im Browser zu verwenden, müssen Sie zuerst einen Bundler verwenden. Ausführliche Informationen dazu finden Sie in unserer Bündelungsdokumentation.

CORS

Sie müssen Cross-Origin Resource Sharing (CORS) Regeln für Ihr Speicherkonto einrichten, wenn Sie für Browser entwickeln müssen. Wechseln Sie zu Azure-Portal und Azure Storage-Explorer, suchen Sie Ihr Speicherkonto, erstellen Sie neue CORS-Regeln für blob/queue/file/table service(s).

Sie können z. B. die folgenden CORS-Einstellungen für das Debuggen erstellen. Passen Sie die Einstellungen jedoch entsprechend Ihren Anforderungen in der Produktionsumgebung sorgfältig an.

  • Zulässige Ursprünge: *
  • Zulässige Verben: DELETE,GET,HEAD,MERGE,POST,OPTIONS,PUT
  • Zulässige Kopfzeilen: *
  • Verfügbar gemachte Kopfzeilen: *
  • Höchstalter (Sekunden): 86400

Wichtige Begriffe

Eine Warteschlange ist ein Datenspeicher innerhalb eines Azure Storage Queue-Dienstkontos zum Senden/Empfangen von Nachrichten zwischen verbundenen Clients.

Wichtige Datentypen in unserer Bibliothek im Zusammenhang mit diesen Diensten sind:

  • A QueueServiceClient stellt eine Verbindung (über eine URL) mit einem bestimmten Speicherkonto im Azure Storage Queue-Dienst dar und stellt APIs zum Bearbeiten seiner Warteschlangen bereit. Sie wird beim Dienst authentifiziert und kann zum Erstellen QueueClient Objekte sowie zum Erstellen, Löschen, Listenwarteschlangen aus dem Dienst verwendet werden.
  • A QueueClient stellt eine einzelne Warteschlange im Speicherkonto dar. Sie kann verwendet werden, um die Nachrichten der Warteschlange zu bearbeiten, z. B. zum Senden, Empfangen und Anzeigen von Nachrichten in der Warteschlange.

Examples

Importieren des Pakets

Um die Clients zu verwenden, importieren Sie das Paket in Ihre Datei:

import * as AzureStorageQueue from "@azure/storage-queue";

Alternativ können Sie nur die benötigten Typen selektiv importieren:

import { QueueServiceClient, StorageSharedKeyCredential } from "@azure/storage-queue";

Erstellen des Warteschlangendienstclients

Für die QueueServiceClient ist eine URL zum Warteschlangendienst und eine Zugriffsanmeldeinformationen erforderlich. Sie akzeptiert optional auch einige Einstellungen im options-Parameter.

mit DefaultAzureCredential aus @azure/identity Paket

Empfohlene Methode zum Instanziieren eines QueueServiceClient

Setup: Referenz – Autorisieren des Zugriffs auf Blobs und Warteschlangen mit Azure Active Directory über eine Clientanwendung – https://learn.microsoft.com/azure/storage/common/storage-auth-aad-app

  • Registrieren einer neuen AAD-Anwendung und Erteilen von Berechtigungen für den Zugriff auf Azure Storage im Namen des angemeldeten Benutzers

    • Registrieren einer neuen Anwendung im Azure Active Directory (im azure-portal) – https://learn.microsoft.com/azure/active-directory/develop/quickstart-register-app
    • Wählen Sie im Abschnitt API permissionsAdd a permission aus, und wählen Sie Microsoft APIsaus.
    • Wählen Sie Azure Storage aus, und aktivieren Sie das Kontrollkästchen neben user_impersonation, und klicken Sie dann auf Add permissions. Dadurch kann die Anwendung im Namen des angemeldeten Benutzers auf Azure Storage zugreifen.

  • Gewähren des Zugriffs auf Azure Storage Queue-Daten mit RBAC im Azure-Portal

  • Umgebungssetup für das Beispiel

    • Notieren Sie sich auf der Übersichtsseite Ihrer AAD-Anwendung die CLIENT ID und TENANT ID. Erstellen Sie auf der Registerkarte "Zertifikate & Geheime Schlüssel" einen geheimen Schlüssel, und notieren Sie sich dies unten.
    • Stellen Sie sicher, dass Sie über AZURE_TENANT_ID, AZURE_CLIENT_ID, AZURE_CLIENT_SECRET als Umgebungsvariablen verfügen, um das Beispiel erfolgreich auszuführen (kann process.env nutzen).
import { DefaultAzureCredential } from "@azure/identity";
import { QueueServiceClient } from "@azure/storage-queue";

const account = "<account>";
const credential = new DefaultAzureCredential();

const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  credential,
);

[Hinweis - Oben aufgeführte Schritte sind nur für Node.js]

verwenden der Verbindungszeichenfolge

Alternativ können Sie eine QueueServiceClient mithilfe der fromConnectionString() statischen Methode mit der vollständigen Verbindungszeichenfolge als Argument instanziieren. (Die Verbindungszeichenfolge kann aus dem Azure-Portal abgerufen werden.) [NUR IN NODE.JS RUNTIME VERFÜGBAR]

import { QueueServiceClient } from "@azure/storage-queue";

const connectionString = "<connection string>";

const queueServiceClient = QueueServiceClient.fromConnectionString(connectionString);

mit StorageSharedKeyCredential

Alternativ instanziieren Sie a QueueServiceClient mit a StorageSharedKeyCredential , indem Sie und als Argumente übergeben accountNameaccountKey . (Die Werte für Kontoname und Kontoschlüssel können aus dem Azure-Portal abgerufen werden.) [NUR IN NODE.JS RUNTIME VERFÜGBAR]

import { StorageSharedKeyCredential, QueueServiceClient } from "@azure/storage-queue";

// Enter your storage account name and shared key
const account = "<account>";
const accountKey = "<accountkey>";

// Use StorageSharedKeyCredential with storage account and account key
// StorageSharedKeyCredential is only available in Node.js runtime, not in browsers
const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);

const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  sharedKeyCredential,
  {
    retryOptions: { maxTries: 4 }, // Retry options
    userAgentOptions: {
      userAgentPrefix: "BasicSample V10.0.0",
    }, // Customized telemetry string
  },
);

mit SAS-Token

Außerdem können Sie eine QueueServiceClient mit einer freigegebenen Zugriffssignatur (SAS) instanziieren. Sie können das SAS-Token aus dem Azure-Portal abrufen oder mithilfe von generateAccountSASQueryParameters()generieren.

import { QueueServiceClient } from "@azure/storage-queue";

const account = "<account name>";
const sas = "<service Shared Access Signature Token>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net?${sas}`,
);

Listen von Warteschlangen in diesem Konto

Verwenden Sie QueueServiceClient.listQueues() Funktion, um die Warteschlangen mit der neuen for-await-of syntax zu durchlaufen:

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

let i = 1;
for await (const item of queueServiceClient.listQueues()) {
  console.log(`Queue${i++}: ${item.name}`);
}

Alternativ ohne for-await-of:

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

let i = 1;
const iterator = queueServiceClient.listQueues();
let { done, value } = await iterator.next();
while (!done) {
  console.log(`Queue${i++}: ${value.name}`);
  ({ done, value } = await iterator.next());
}

Ein vollständiges Beispiel zum Iterieren von Warteschlangen finden Sie unter samples/v12/typescript/listQueues.ts.

Erstellen einer neuen Warteschlange

Verwenden Sie QueueServiceClient.getQueueClient() Funktion, um eine neue Warteschlange zu erstellen.

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

const queueName = "<valid queue name>";
const queueClient = queueServiceClient.getQueueClient(queueName);
const createQueueResponse = await queueClient.create();
console.log(
  `Created queue ${queueName} successfully, service assigned request Id: ${createQueueResponse.requestId}`,
);

Senden einer Nachricht an die Warteschlange

Verwenden Sie sendMessage(), um der Warteschlange eine Nachricht hinzuzufügen:

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

const queueName = "<valid queue name>";
const queueClient = queueServiceClient.getQueueClient(queueName);
// Send a message into the queue using the sendMessage method.
const sendMessageResponse = await queueClient.sendMessage("Hello World!");
console.log(
  `Sent message successfully, service assigned message Id: ${sendMessageResponse.messageId}, service assigned request Id: ${sendMessageResponse.requestId}`,
);

Vorschau einer Nachricht

QueueClient.peekMessages() ermöglicht das Betrachten einer oder mehrerer Nachrichten vor der Warteschlange. Dieser Aufruf verhindert nicht, dass anderer Code auf vorschauierte Nachrichten zugreift.

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

const queueName = "<valid queue name>";
const queueClient = queueServiceClient.getQueueClient(queueName);
const peekMessagesResponse = await queueClient.peekMessages();
console.log(`The peeked message is: ${peekMessagesResponse.peekedMessageItems[0].messageText}`);

Verarbeiten einer Nachricht

Nachrichten werden in zwei Schritten verarbeitet.

  • Erster Anruf queueClient.receiveMessages(). Dadurch werden die Nachrichten für andere Codelesenachrichten aus dieser Warteschlange für einen Standardzeitraum von 30 Sekunden unsichtbar.
  • Wenn die Verarbeitung einer Nachricht abgeschlossen ist, rufen Sie queueClient.deleteMessage() mit der popReceiptder Nachricht auf.

Wenn ihr Code aufgrund von Hardware- oder Softwarefehlern keine Nachricht verarbeitet, stellt dieser zweistufige Prozess sicher, dass eine andere Instanz des Codes dieselbe Nachricht abrufen und es erneut versuchen kann.

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

const queueName = "<valid queue name>";
const queueClient = queueServiceClient.getQueueClient(queueName);
const response = await queueClient.receiveMessages();
if (response.receivedMessageItems.length === 1) {
  const receivedMessageItem = response.receivedMessageItems[0];
  console.log(`Processing & deleting message with content: ${receivedMessageItem.messageText}`);
  const deleteMessageResponse = await queueClient.deleteMessage(
    receivedMessageItem.messageId,
    receivedMessageItem.popReceipt,
  );
  console.log(
    `Delete message successfully, service assigned request Id: ${deleteMessageResponse.requestId}`,
  );
}

Löschen einer Warteschlange

import { QueueServiceClient } from "@azure/storage-queue";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const queueServiceClient = new QueueServiceClient(
  `https://${account}.queue.core.windows.net`,
  new DefaultAzureCredential(),
);

const queueName = "<valid queue name>";
const queueClient = queueServiceClient.getQueueClient(queueName);
const deleteQueueResponse = await queueClient.delete();
console.log(
  `Deleted queue successfully, service assigned request Id: ${deleteQueueResponse.requestId}`,
);

Ein vollständiges Beispiel für einfache QueueServiceClient Szenarien finden Sie unter samples/v12/typescript/src/queueClient.ts.

Troubleshooting

Das Aktivieren der Protokollierung kann hilfreiche Informationen zu Fehlern aufdecken. Um ein Protokoll von HTTP-Anforderungen und -Antworten anzuzeigen, legen Sie die AZURE_LOG_LEVEL Umgebungsvariable auf infofest. Alternativ kann die Protokollierung zur Laufzeit durch Aufrufen von setLogLevel im @azure/loggeraktiviert werden:

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

Nächste Schritte

Weitere Codebeispiele

  • - für Warteschlangenspeicherbeispiele

Contributing

Wenn Sie an dieser Bibliothek mitwirken möchten, lesen Sie bitte den mitwirkenden Leitfaden, um mehr über das Erstellen und Testen des Codes zu erfahren.

Weitere Informationen zum Einrichten der Testumgebung für Speicherbibliotheken finden Sie auch in speicherspezifischen Leitfaden.

  • Last updated on