Skicka meddelanden till och ta emot meddelanden från Azure Service Bus-köer (JavaScript)

I den här självstudien gör du följande:

  1. Skapa ett Service Bus-namnområde med Azure Portal.
  2. Skapa en Service Bus-kö med Azure Portal.
  3. Skriv ett JavaScript-program för att använda paketet @azure/service-bus för att:
    1. Skicka en uppsättning meddelanden till kön.
    2. Ta emot dessa meddelanden från kön.

Kommentar

Den här snabbstarten innehåller stegvisa instruktioner för ett enkelt scenario med att skicka meddelanden till en Service Bus-kö och ta emot dem. Du hittar fördefinierade JavaScript- och TypeScript-exempel för Azure Service Bus i Azure SDK för JavaScript-lagringsplatsen på GitHub.

Förutsättningar

Om du är nybörjare på tjänsten kan du läsa Översikt över Service Bus innan du gör den här snabbstarten.

Om du vill använda den här snabbstarten med ditt eget Azure-konto behöver du:

  • Installera Azure CLI, som tillhandahåller lösenordslös autentisering till utvecklardatorn.
  • Logga in med ditt Azure-konto i terminalen eller kommandotolken med az login.
  • Använd samma konto när du lägger till lämplig dataroll i resursen.
  • Kör koden i samma terminal eller kommandotolk.
  • Anteckna könamnet för Service Bus-namnområdet. Du behöver det i koden.

Kommentar

Den här självstudien fungerar med exempel som du kan kopiera och köra med Nodejs. Anvisningar om hur du skapar ett Node.js-program finns i Skapa och distribuera ett Node.js-program till en Azure-webbplats eller Node.js molntjänst med Windows PowerShell.

Skapa ett namnområde i Azure Portal

För att komma igång med Service Bus-meddelandeentiteter i Azure måste du först skapa ett namnområde med ett namn som är unikt i Azure. Ett namnområde tillhandahåller en omfångscontainer för Service Bus-resurser (köer, ämnen osv.) i ditt program.

Så här skapar du ett namnområde:

  1. Logga in på Azure-portalen.

  2. Gå till sidan Alla tjänster.

  3. I det vänstra navigeringsfältet väljer du Integrering i listan över kategorier, hovra musen över Service Bus och välj + sedan knappen på Service Bus-panelen.

    Image showing selection of Create a resource, Integration, and then Service Bus in the menu.

  4. Följ dessa steg i taggen Grundläggande på sidan Skapa namnområde:

    1. För Prenumeration väljer du en Azure-prenumeration där du ska skapa namnrymden.

    2. För Resursgrupp väljer du en befintlig resursgrupp där namnrymden ska finnas, eller så skapar du en ny.

    3. Ange ett namn för namnrymden. Namnområdesnamnet bör följa följande namngivningskonventioner:

      • Namnet måste vara unikt i Hela Azure. Systemet kontrollerar omedelbart om namnet är tillgängligt.
      • Namnlängden är minst 6 och högst 50 tecken.
      • Namnet får endast innehålla bokstäver, siffror, bindestreck "-".
      • Namnet måste börja med en bokstav och sluta med en bokstav eller siffra.
      • Namnet slutar inte med "-sb" eller "-mgmt".
    4. För Plats väljer du land eller region där namnrymden ska finnas.

    5. För Prisnivå väljer du prisnivån (Basic, Standard eller Premium) för namnområdet. För den här snabbstarten väljer du Standard.

      Viktigt!

      Om du vill använda ämnen och prenumerationer väljer du antingen Standard eller Premium. Ämnen/prenumerationer stöds inte på prisnivån Basic.

      Om du har valt prisnivån Premium anger du antalet meddelandeenheter. Premium-nivån ger resursisolering på processor- och minnesnivå så att varje arbetsbelastning körs självständigt. Den här resurscontainern kallas för en meddelandefunktionsenhet. Ett premiumnamnområde har minst en meddelandeenhet. Du kan välja 1, 2, 4, 8 eller 16 meddelandeenheter för varje Service Bus Premium-namnområde. Mer information finns i Service Bus Premium-meddelanden.

    6. Välj Granska + skapa längst ned på sidan.

      Image showing the Create a namespace page

    7. På sidan Granska + skapa granskar du inställningarna och väljer Skapa.

  5. När distributionen av resursen har slutförts väljer du Gå till resurs på distributionssidan.

    Image showing the deployment succeeded page with the Go to resource link.

  6. Startsidan för din Service Bus-namnrymd visas.

    Image showing the home page of the Service Bus namespace created.

Skapa en kö i Azure-portalen

  1. På sidan Service Bus Namespace (Service Bus-namnrymd) väljer du Köer på navigeringsmenyn till vänster.

  2. På sidan Köer väljer du + Kö i verktygsfältet.

  3. Ange ett namn för kön och låt de andra värdena ha kvar standardvärdena.

  4. Välj nu Skapa.

    Image showing creation of a queue in the portal

Autentisera appen till Azure

Den här snabbstarten visar två sätt att ansluta till Azure Service Bus: lösenordsfri och anslutningssträng.

Det första alternativet visar hur du använder ditt säkerhetsobjekt i Microsoft Entra-ID och rollbaserad åtkomstkontroll (RBAC) för att ansluta till ett Service Bus-namnområde. Du behöver inte oroa dig för att ha hårdkodade anslutningssträng i koden eller i en konfigurationsfil eller i ett säkert lagringsutrymme som Azure Key Vault.

Det andra alternativet visar hur du använder en anslutningssträng för att ansluta till ett Service Bus-namnområde. Om du är nybörjare på Azure kan det vara enklare att följa anslutningssträng alternativet. Vi rekommenderar att du använder det lösenordslösa alternativet i verkliga program och produktionsmiljöer. Mer information finns i Autentisering och auktorisering. Du kan också läsa mer om lösenordslös autentisering på översiktssidan.

Tilldela roller till din Microsoft Entra-användare

När du utvecklar lokalt kontrollerar du att användarkontot som ansluter till Azure Service Bus har rätt behörigheter. Du behöver rollen Azure Service Bus-dataägare för att kunna skicka och ta emot meddelanden. Om du vill tilldela dig själv den här rollen behöver du rollen Administratör för användaråtkomst eller en annan roll som innehåller åtgärden Microsoft.Authorization/roleAssignments/write . Du kan tilldela Azure RBAC-roller till en användare med hjälp av Azure-portalen, Azure CLI eller Azure PowerShell. Läs mer om tillgängliga omfång för rolltilldelningar på översiktssidan för omfång .

I följande exempel tilldelas Azure Service Bus Data Owner rollen till ditt användarkonto, vilket ger fullständig åtkomst till Azure Service Bus-resurser. I ett verkligt scenario följer du principen om lägsta behörighet för att ge användarna endast de minsta behörigheter som krävs för en säkrare produktionsmiljö.

Inbyggda Azure-roller för Azure Service Bus

För Azure Service Bus skyddas redan hanteringen av namnområden och alla relaterade resurser via Azure-portalen och Azure-resurshanterings-API:et med hjälp av Azure RBAC-modellen. Azure tillhandahåller de inbyggda Azure-rollerna nedan för att auktorisera åtkomst till ett Service Bus-namnområde:

  • Azure Service Bus-dataägare: Ger dataåtkomst till Service Bus-namnområdet och dess entiteter (köer, ämnen, prenumerationer och filter). En medlem i den här rollen kan skicka och ta emot meddelanden från köer eller ämnen/prenumerationer.
  • Azure Service Bus Data Sender: Använd den här rollen för att ge sändningsåtkomst till Service Bus-namnområdet och dess entiteter.
  • Azure Service Bus-datamottagare: Använd den här rollen för att ge ta emot åtkomst till Service Bus-namnområdet och dess entiteter.

Om du vill skapa en anpassad roll läser du Rättigheter som krävs för Service Bus-åtgärder.

Lägga till Microsoft Entra-användare i rollen Som Azure Service Bus-ägare

Lägg till ditt Microsoft Entra-användarnamn i rollen Azure Service Bus-dataägare på Service Bus-namnområdesnivå. Det gör att en app som körs i kontexten för ditt användarkonto kan skicka meddelanden till en kö eller ett ämne och ta emot meddelanden från en kö eller ett ämnes prenumeration.

Viktigt!

I de flesta fall tar det en minut eller två innan rolltilldelningen sprids i Azure. I sällsynta fall kan det ta upp till åtta minuter. Om du får autentiseringsfel när du först kör koden väntar du en stund och försöker igen.

  1. Om du inte har sidan Service Bus-namnområde öppen i Azure-portalen letar du upp Service Bus-namnområdet med hjälp av huvudsökfältet eller det vänstra navigeringsfältet.

  2. På översiktssidan väljer du Åtkomstkontroll (IAM) på den vänstra menyn.

  3. På sidan Åtkomstkontroll (IAM) väljer du fliken Rolltilldelningar .

  4. Välj + Lägg till på den översta menyn och sedan Lägg till rolltilldelning från den resulterande nedrullningsbara menyn.

    A screenshot showing how to assign a role.

  5. Använd sökrutan för att filtrera resultatet till önskad roll. I det här exemplet söker Azure Service Bus Data Owner du efter och väljer matchande resultat. Välj sedan Nästa.

  6. Under Tilldela åtkomst till väljer du Användare, grupp eller tjänstens huvudnamn och sedan + Välj medlemmar.

  7. I dialogrutan söker du efter ditt Microsoft Entra-användarnamn (vanligtvis din user@domain e-postadress) och väljer sedan Välj längst ned i dialogrutan.

  8. Välj Granska + tilldela för att gå till den sista sidan och sedan Granska + tilldela igen för att slutföra processen.

Installera paketet med NPM (Node Package Manager)

  1. Om du vill installera nödvändiga npm-paket för Service Bus öppnar du en kommandotolk som finns npm i sökvägen, ändrar katalogen till den mapp där du vill ha dina exempel och kör sedan det här kommandot.

  2. Installera följande paket:

    npm install @azure/service-bus @azure/identity
    

Skicka meddelanden till en kö

Följande exempelkod visar hur du skickar ett meddelande till en kö.

Du måste ha loggat in med Azure CLI för att din lokala dator ska kunna tillhandahålla den lösenordslösa az login autentisering som krävs i den här koden.

  1. Öppna din favoritredigerare, till exempel Visual Studio Code.

  2. Skapa en fil med namnet send.js och klistra in koden nedan i den. Den här koden skickar namnen på forskare som meddelanden till din kö.

    Viktigt!

    Den lösenordslösa autentiseringsuppgiften tillhandahålls med StandardAzureCredential.

    const { ServiceBusClient } = require("@azure/service-bus");
    const { DefaultAzureCredential } = require("@azure/identity");
    
    // Replace `<SERVICE-BUS-NAMESPACE>` with your namespace
    const fullyQualifiedNamespace = "<SERVICE-BUS-NAMESPACE>.servicebus.windows.net";
    
    // Passwordless credential
    const credential = new DefaultAzureCredential();
    
    // name of the queue
    const queueName = "<QUEUE NAME>"
    
    const messages = [
        { body: "Albert Einstein" },
        { body: "Werner Heisenberg" },
        { body: "Marie Curie" },
        { body: "Steven Hawking" },
        { body: "Isaac Newton" },
        { body: "Niels Bohr" },
        { body: "Michael Faraday" },
        { body: "Galileo Galilei" },
        { body: "Johannes Kepler" },
        { body: "Nikolaus Kopernikus" }
        ];
    
    async function main() {
        // create a Service Bus client using the passwordless authentication to the Service Bus namespace
        const sbClient = new ServiceBusClient(fullyQualifiedNamespace, credential);
    
        // createSender() can also be used to create a sender for a topic.
        const sender = sbClient.createSender(queueName);
    
        try {
            // Tries to send all messages in a single batch.
            // Will fail if the messages cannot fit in a batch.
            // await sender.sendMessages(messages);
    
            // create a batch object
            let batch = await sender.createMessageBatch();
            for (let i = 0; i < messages.length; i++) {
                // for each message in the array
    
                // try to add the message to the batch
                if (!batch.tryAddMessage(messages[i])) {
                    // if it fails to add the message to the current batch
                    // send the current batch as it is full
                    await sender.sendMessages(batch);
    
                    // then, create a new batch
                    batch = await sender.createMessageBatch();
    
                    // now, add the message failed to be added to the previous batch to this batch
                    if (!batch.tryAddMessage(messages[i])) {
                        // if it still can't be added to the batch, the message is probably too big to fit in a batch
                        throw new Error("Message too big to fit in a batch");
                    }
                }
            }
    
            // Send the last created batch of messages to the queue
            await sender.sendMessages(batch);
    
            console.log(`Sent a batch of messages to the queue: ${queueName}`);
    
            // Close the sender
            await sender.close();
        } finally {
            await sbClient.close();
        }
    }
    
    // call the main function
    main().catch((err) => {
        console.log("Error occurred: ", err);
        process.exit(1);
        });
    
  3. Ersätt <SERVICE-BUS-NAMESPACE> med Service Bus-namnområdet.

  4. Ersätt <QUEUE NAME> med namnet på kön.

  5. Kör sedan kommandot i en kommandotolk för att köra den här filen.

    node send.js
    
  6. Du bör se följande utdata.

    Sent a batch of messages to the queue: myqueue
    

Ta emot meddelanden från en kö

Du måste ha loggat in med Azure CLI för att din lokala dator ska kunna tillhandahålla den lösenordslösa az login autentisering som krävs i den här koden.

  1. Öppna din favoritredigerare, till exempel Visual Studio Code

  2. Skapa en fil med namnet receive.js och klistra in följande kod i den.

    const { delay, ServiceBusClient, ServiceBusMessage } = require("@azure/service-bus");
    const { DefaultAzureCredential } = require("@azure/identity");
    
    // Replace `<SERVICE-BUS-NAMESPACE>` with your namespace
    const fullyQualifiedNamespace = "<SERVICE-BUS-NAMESPACE>.servicebus.windows.net";
    
    // Passwordless credential
    const credential = new DefaultAzureCredential();
    
    // name of the queue
    const queueName = "<QUEUE NAME>"
    
     async function main() {
        // create a Service Bus client using the passwordless authentication to the Service Bus namespace
        const sbClient = new ServiceBusClient(fullyQualifiedNamespace, credential);
    
        // createReceiver() can also be used to create a receiver for a subscription.
        const receiver = sbClient.createReceiver(queueName);
    
        // function to handle messages
        const myMessageHandler = async (messageReceived) => {
            console.log(`Received message: ${messageReceived.body}`);
        };
    
        // function to handle any errors
        const myErrorHandler = async (error) => {
            console.log(error);
        };
    
        // subscribe and specify the message and error handlers
        receiver.subscribe({
            processMessage: myMessageHandler,
            processError: myErrorHandler
        });
    
        // Waiting long enough before closing the sender to send messages
        await delay(20000);
    
        await receiver.close();
        await sbClient.close();
    }
    // call the main function
    main().catch((err) => {
        console.log("Error occurred: ", err);
        process.exit(1);
     });
    
  3. Ersätt <SERVICE-BUS-NAMESPACE> med Service Bus-namnområdet.

  4. Ersätt <QUEUE NAME> med namnet på kön.

  5. Kör sedan kommandot i en kommandotolk för att köra den här filen.

    node receive.js
    

Du bör se följande utdata.

Received message: Albert Einstein
Received message: Werner Heisenberg
Received message: Marie Curie
Received message: Steven Hawking
Received message: Isaac Newton
Received message: Niels Bohr
Received message: Michael Faraday
Received message: Galileo Galilei
Received message: Johannes Kepler
Received message: Nikolaus Kopernikus

På sidan Översikt för Service Bus-namnområdet i Azure-portalen kan du se antal inkommande och utgående meddelanden. Du kan behöva vänta i en minut eller så och sedan uppdatera sidan för att se de senaste värdena.

Incoming and outgoing message count

Välj kön på den här översiktssidan för att gå till sidan Service Bus-kö . Du ser också antalet inkommande och utgående meddelanden på den här sidan. Du ser även annan information, till exempel köns aktuella storlek , maximal storlek, antal aktiva meddelanden och så vidare.

Queue details

Felsökning

Om du får något av följande fel när du kör den lösenordslösa versionen av JavaScript-koden kontrollerar du att du är inloggad via Azure CLI-kommandot az login och att lämplig roll tillämpas på ditt Azure-användarkonto:

  • "Skicka" anspråk krävs för att utföra den här åtgärden
  • "Ta emot" anspråk krävs för att utföra den här åtgärden

Rensa resurser

Gå till Service Bus-namnområdet i Azure-portalen och välj Ta bort på Azure-portalen för att ta bort namnområdet och kön i det.

Nästa steg

Se följande dokumentation och exempel: