Snabbstart: Skicka och ta emot meddelanden från en Azure Service Bus-kö (.NET)

I den här snabbstarten 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 .NET-konsolprogram för att skicka en uppsättning meddelanden till kön.

4. Skriv ett .NET-konsolprogram för att ta emot dessa meddelanden från kön.

   Kommentar

   Den här snabbstarten innehåller stegvisa instruktioner för att implementera ett enkelt scenario med att skicka en batch meddelanden till en Service Bus-kö och sedan ta emot dem. En översikt över .NET-klientbiblioteket finns i Azure Service Bus-klientbiblioteket för .NET. Fler exempel finns i Service Bus .NET-exempel 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.

• Azure-prenumeration. Om du vill använda Azure-tjänster, inklusive Azure Service Bus, behöver du en prenumeration. Om du inte har ett befintligt Azure-konto kan du registrera dig för en kostnadsfri utvärderingsversion.
• Visual Studio 2022. Exempelprogrammet använder nya funktioner som introducerades i C# 10. Du kan fortfarande använda Service Bus-klientbiblioteket med tidigare C#-språkversioner, men syntaxen kan variera. Om du vill använda den senaste syntaxen rekommenderar vi att du installerar .NET 6.0 eller senare och anger språkversionen till latest. Om du använder Visual Studio är versioner före Visual Studio 2022 inte kompatibla med de verktyg som behövs för att skapa C# 10-projekt.

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.

   

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.

      

   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.

   

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

   

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.

   

Autentisera appen till Azure

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

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 niska veze 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 niska veze för att ansluta till ett Service Bus-namnområde. Om du inte har använt Azure tidigare kan det vara enklare att följa niska veze 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.

Starta Visual Studio och logga in på Azure

Du kan auktorisera åtkomst till Service Bus-namnområdet med hjälp av följande steg:

1. Starta Visual Studio. Om du ser fönstret Kom igång väljer du länken Fortsätt utan kod i den högra rutan.

2. Välj knappen Logga in längst upp till höger i Visual Studio.

   

3. Logga in med det Microsoft Entra-konto som du tilldelade en roll till tidigare.

   

Skicka meddelanden till kön

Det här avsnittet visar hur du skapar ett .NET-konsolprogram för att skicka meddelanden till en Service Bus-kö.

Skapa ett konsolprogram

1. I Visual Studio väljer du Arkiv ->Ny ->Projekt-meny .

2. I dialogrutan Skapa ett nytt projekt gör du följande: Om du inte ser den här dialogrutan väljer du Arkiv på menyn, väljer Nytt och sedan Projekt.

   1. Välj C# för programmeringsspråket.

   2. Välj Konsol för programmets typ.

   3. Välj Konsolapp i resultatlistan.

   4. Välj sedan Nästa.

      

3. Ange QueueSender som projektnamn, ServiceBusQueueQuickStart som lösningsnamn och välj sedan Nästa.

   

4. På sidan Ytterligare information väljer du Skapa för att skapa lösningen och projektet.

Lägg till NuGet-paketen i projektet

Lägg till kod för att skicka meddelanden till kön

1. Ersätt innehållet i Program.cs med följande kod. De viktiga stegen beskrivs i följande avsnitt med ytterligare information i kodkommentarna.

   • Lösenordslös
   • Anslutningssträng

   • Skapar ett ServiceBusClient-objekt med hjälp av objektet DefaultAzureCredential . DefaultAzureCredential identifierar och använder automatiskt autentiseringsuppgifterna för din Visual Studio-inloggning för att autentisera till Azure Service Bus.
   • Anropar metoden CreateSender i ServiceBusClient-objektet för att skapa ett ServiceBusSender-objekt för den specifika Service Bus-kön.
   • Skapar ett ServiceBusMessageBatch-objekt med hjälp av metoden ServiceBusSender.CreateMessageBatchAsync .
   • Lägg till meddelanden i batchen med hjälp av ServiceBusMessageBatch.TryAddMessage.
   • Skickar batchen med meddelanden till Service Bus-kön med hjälp av metoden ServiceBusSender.SendMessagesAsync .

   Viktigt!

   Uppdatera platshållarvärdena (<NAMESPACE-NAME> och <QUEUE-NAME>) i kodfragmentet med namnen på Service Bus-namnområdet och kön.

   using Azure.Messaging.ServiceBus;
   using Azure.Identity;
   
   // name of your Service Bus queue
   // the client that owns the connection and can be used to create senders and receivers
   ServiceBusClient client;
   
   // the sender used to publish messages to the queue
   ServiceBusSender sender;
   
   // number of messages to be sent to the queue
   const int numOfMessages = 3;
   
   // The Service Bus client types are safe to cache and use as a singleton for the lifetime
   // of the application, which is best practice when messages are being published or read
   // regularly.
   //
   // Set the transport type to AmqpWebSockets so that the ServiceBusClient uses the port 443. 
   // If you use the default AmqpTcp, ensure that ports 5671 and 5672 are open.
   var clientOptions = new ServiceBusClientOptions
   { 
       TransportType = ServiceBusTransportType.AmqpWebSockets
   };
   //TODO: Replace the "<NAMESPACE-NAME>" and "<QUEUE-NAME>" placeholders.
   client = new ServiceBusClient(
       "<NAMESPACE-NAME>.servicebus.windows.net",
       new DefaultAzureCredential(),
       clientOptions);
   sender = client.CreateSender("<QUEUE-NAME>");
   
   // create a batch 
   using ServiceBusMessageBatch messageBatch = await sender.CreateMessageBatchAsync();
   
   for (int i = 1; i <= numOfMessages; i++)
   {
       // try adding a message to the batch
       if (!messageBatch.TryAddMessage(new ServiceBusMessage($"Message {i}")))
       {
           // if it is too large for the batch
           throw new Exception($"The message {i} is too large to fit in the batch.");
       }
   }
   
   try
   {
       // Use the producer client to send the batch of messages to the Service Bus queue
       await sender.SendMessagesAsync(messageBatch);
       Console.WriteLine($"A batch of {numOfMessages} messages has been published to the queue.");
   }
   finally
   {
       // Calling DisposeAsync on client types is required to ensure that network
       // resources and other unmanaged objects are properly cleaned up.
       await sender.DisposeAsync();
       await client.DisposeAsync();
   }
   
   Console.WriteLine("Press any key to end the application");
   Console.ReadKey();
   

2. Skapa projektet och se till att det inte finns några fel.

3. Kör programmet och vänta på bekräftelsemeddelandet.

   A batch of 3 messages has been published to the queue
   

   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.

4. Följ dessa steg i Azure-portalen:

   1. Gå till Service Bus-namnområdet.

   2. På sidan Översikt väljer du kön i fönstret längst ned i mitten.

      

   3. Observera värdena i avsnittet Essentials .

      

   Observera följande värden:

   • Värdet för antal aktiva meddelanden för kön är nu 3. Varje gång du kör den här avsändarappen utan att hämta meddelandena ökar det här värdet med 3.
   • Köns aktuella storlek ökar varje gång appen lägger till meddelanden i kön.
   • I diagrammet Meddelanden i det nedre avsnittet Mått kan du se att det finns tre inkommande meddelanden för kön.

Ta emot meddelanden från kön

I det här avsnittet skapar du ett .NET-konsolprogram som tar emot meddelanden från kön.

Skapa ett projekt för mottagaren

1. I Istraživač rešenja-fönstret högerklickar du på lösningen ServiceBusQueueQuickStart, pekar på Lägg till och väljer Nytt projekt.
2. Välj Konsolprogram och välj Nästa.
3. Ange QueueReceiver som Projektnamn och välj Skapa.
4. I fönstret Istraživač rešenja högerklickar du på QueueReceiver och väljer Ange som ett startprojekt.

Lägg till NuGet-paketen i projektet

Lägg till koden för att ta emot meddelanden från kön

I det här avsnittet lägger du till kod för att hämta meddelanden från kön.

1. Lägg till följande kod i Program klassen:

   • Lösenordslös
   • Anslutningssträng

   using System.Threading.Tasks;
   using Azure.Identity;
   using Azure.Messaging.ServiceBus;
   
   // the client that owns the connection and can be used to create senders and receivers
   ServiceBusClient client;
   
   // the processor that reads and processes messages from the queue
   ServiceBusProcessor processor;
   

2. Lägg till följande metoder i slutet av Program klassen.

   // handle received messages
   async Task MessageHandler(ProcessMessageEventArgs args)
   {
       string body = args.Message.Body.ToString();
       Console.WriteLine($"Received: {body}");
   
       // complete the message. message is deleted from the queue. 
       await args.CompleteMessageAsync(args.Message);
   }
   
   // handle any errors when receiving messages
   Task ErrorHandler(ProcessErrorEventArgs args)
   {
       Console.WriteLine(args.Exception.ToString());
       return Task.CompletedTask;
   }
   

3. Lägg till följande kod i slutet av Program klassen. De viktiga stegen beskrivs i följande avsnitt med ytterligare information i kodkommentarna.

   • Lösenordslös
   • Anslutningssträng

   • Skapar ett ServiceBusClient-objekt med hjälp av objektet DefaultAzureCredential . DefaultAzureCredential identifierar och använder automatiskt autentiseringsuppgifterna för din Visual Studio-inloggning för att autentisera till Azure Service Bus.
   • Anropar metoden CreateProcessor på ServiceBusClient objektet för att skapa ett ServiceBusProcessor-objekt för den angivna Service Bus-kön.
   • Anger hanterare för ProcessMessageAsync- och ProcessErrorAsync-händelserna för ServiceBusProcessor-objektet.
   • Börjar bearbeta meddelanden genom att anropa StartProcessingAsync på ServiceBusProcessor objektet.
   • När användaren trycker på en nyckel för att avsluta bearbetningen anropar den StopProcessingAsync på ServiceBusProcessor objektet.

   Viktigt!

   Uppdatera platshållarvärdena (<NAMESPACE-NAME> och <QUEUE-NAME>) i kodfragmentet med namnen på Service Bus-namnområdet och kön.

   // The Service Bus client types are safe to cache and use as a singleton for the lifetime
   // of the application, which is best practice when messages are being published or read
   // regularly.
   //
   // Set the transport type to AmqpWebSockets so that the ServiceBusClient uses port 443. 
   // If you use the default AmqpTcp, make sure that ports 5671 and 5672 are open.
   
   // TODO: Replace the <NAMESPACE-NAME> placeholder
   var clientOptions = new ServiceBusClientOptions()
   {
       TransportType = ServiceBusTransportType.AmqpWebSockets
   };
   client = new ServiceBusClient(
       "<NAMESPACE-NAME>.servicebus.windows.net",
       new DefaultAzureCredential(),
       clientOptions);
   
   // create a processor that we can use to process the messages
   // TODO: Replace the <QUEUE-NAME> placeholder
   processor = client.CreateProcessor("<QUEUE-NAME>", new ServiceBusProcessorOptions());
   
   try
   {
       // add handler to process messages
       processor.ProcessMessageAsync += MessageHandler;
   
       // add handler to process any errors
       processor.ProcessErrorAsync += ErrorHandler;
   
       // start processing 
       await processor.StartProcessingAsync();
   
       Console.WriteLine("Wait for a minute and then press any key to end the processing");
       Console.ReadKey();
   
       // stop processing 
       Console.WriteLine("\nStopping the receiver...");
       await processor.StopProcessingAsync();
       Console.WriteLine("Stopped receiving messages");
   }
   finally
   {
       // Calling DisposeAsync on client types is required to ensure that network
       // resources and other unmanaged objects are properly cleaned up.
       await processor.DisposeAsync();
       await client.DisposeAsync();
   }
   

4. Den slutförda Program klassen ska matcha följande kod:

   • Lösenordslös
   • Anslutningssträng

   using System.Threading.Tasks;
   using Azure.Messaging.ServiceBus;
   using Azure.Identity;
   
   // the client that owns the connection and can be used to create senders and receivers
   ServiceBusClient client;
   
   // the processor that reads and processes messages from the queue
   ServiceBusProcessor processor;
   
   // The Service Bus client types are safe to cache and use as a singleton for the lifetime
   // of the application, which is best practice when messages are being published or read
   // regularly.
   //
   // Set the transport type to AmqpWebSockets so that the ServiceBusClient uses port 443.
   // If you use the default AmqpTcp, make sure that ports 5671 and 5672 are open.
   
   // TODO: Replace the <NAMESPACE-NAME> and <QUEUE-NAME> placeholders
   var clientOptions = new ServiceBusClientOptions() 
   {
       TransportType = ServiceBusTransportType.AmqpWebSockets
   };
   client = new ServiceBusClient("<NAMESPACE-NAME>.servicebus.windows.net", 
       new DefaultAzureCredential(), clientOptions);
   
   // create a processor that we can use to process the messages
   // TODO: Replace the <QUEUE-NAME> placeholder
   processor = client.CreateProcessor("<QUEUE-NAME>", new ServiceBusProcessorOptions());
   
   try
   {
       // add handler to process messages
       processor.ProcessMessageAsync += MessageHandler;
   
       // add handler to process any errors
       processor.ProcessErrorAsync += ErrorHandler;
   
       // start processing 
       await processor.StartProcessingAsync();
   
       Console.WriteLine("Wait for a minute and then press any key to end the processing");
       Console.ReadKey();
   
       // stop processing 
       Console.WriteLine("\nStopping the receiver...");
       await processor.StopProcessingAsync();
       Console.WriteLine("Stopped receiving messages");
   }
   finally
   {
       // Calling DisposeAsync on client types is required to ensure that network
       // resources and other unmanaged objects are properly cleaned up.
       await processor.DisposeAsync();
       await client.DisposeAsync();
   }
   
   // handle received messages
   async Task MessageHandler(ProcessMessageEventArgs args)
   {
       string body = args.Message.Body.ToString();
       Console.WriteLine($"Received: {body}");
   
       // complete the message. message is deleted from the queue. 
       await args.CompleteMessageAsync(args.Message);
   }
   
   // handle any errors when receiving messages
   Task ErrorHandler(ProcessErrorEventArgs args)
   {
       Console.WriteLine(args.Exception.ToString());
       return Task.CompletedTask;
   }
   

5. Skapa projektet och se till att det inte finns några fel.

6. Kör mottagarprogrammet. Du bör se de mottagna meddelandena. Tryck på valfri tangent för att stoppa mottagaren och programmet.

   Wait for a minute and then press any key to end the processing
   Received: Message 1
   Received: Message 2
   Received: Message 3
   
   Stopping the receiver...
   Stopped receiving messages
   

7. Kontrollera portalen igen. Vänta några minuter och uppdatera sidan om du inte ser 0 aktiva meddelanden.

   • Antal aktiva meddelanden och aktuella storleksvärden är nu 0.

   • I diagrammet Meddelanden i det nedre avsnittet Mått kan du se att det finns tre inkommande meddelanden och tre utgående meddelanden för kön.

     

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.

Se även

Se följande dokumentation och exempel:

• Azure Service Bus-klientbibliotek för .NET – Readme
• Exempel på GitHub
• .NET API-referens
• Ta bort infrastrukturproblem med ramverk på högre nivå som NServiceBus

Nästa steg