Useful.Azure.ServiceBus.Abstractions
2.0.0
dotnet add package Useful.Azure.ServiceBus.Abstractions --version 2.0.0
NuGet\Install-Package Useful.Azure.ServiceBus.Abstractions -Version 2.0.0
<PackageReference Include="Useful.Azure.ServiceBus.Abstractions" Version="2.0.0" />
paket add Useful.Azure.ServiceBus.Abstractions --version 2.0.0
#r "nuget: Useful.Azure.ServiceBus.Abstractions, 2.0.0"
// Install Useful.Azure.ServiceBus.Abstractions as a Cake Addin #addin nuget:?package=Useful.Azure.ServiceBus.Abstractions&version=2.0.0 // Install Useful.Azure.ServiceBus.Abstractions as a Cake Tool #tool nuget:?package=Useful.Azure.ServiceBus.Abstractions&version=2.0.0
Useful.Azure.ServiceBus.Abstractions
The purpose of this project is to to provide a wrapper for Azure Service Bus to send messages as JSON and abstract some of the configuration away. This also aids in unit testing by providing interfaces for the Sender and Receiver.
Supported .NET Frameworks - .NET 6 and .NET 7
<a href="https://badge.fury.io/nu/Useful.Azure.ServiceBus.Abstractions"><img src="https://badge.fury.io/nu/Useful.Azure.ServiceBus.Abstractions.svg" alt="NuGet version" height="18"></a>
Configuration
Add the packages for your app
NOTE: Azure.Identity and Microsoft.Extensions.Azure are used for Managed Identity connections
dotnet add package Azure.Identity
dotnet add package Microsoft.Extensions.Azure
dotnet add package Useful.Azure.ServiceBus.Abstractions
Basic Console App Usage
Sending
Create a message structure e.g.
public record MyMessage
{
public string Name { get; init; }
}
Create an instance of the ServiceBusFactory e.g.
var factory = new ServiceBusFactory();
Create a Sender with a connection string for the Service Bus e.g.
var sender = await factory.CreateSenderAsync<MyMessage>(ServiceBusConnectionString, "myTopic");
or using Managed Identity
const string fullyQualifiedNamespace = "<your namespace>.servicebus.windows.net";
var sender = await factory.CreateSenderAsync<MyMessage>(fullyQualifiedNamespace, new DefaultAzureCredential(), "myTopic");
Then use the SendAsJsonAsync method to send to the Service Bus
await sender.SendAsJsonAsync(new MyMessage { Name = "Bilbo Baggins" });
When creating the Sender there is also a number of options that can be configured e.g.
var sender = await factory.CreateSenderAsync<MyMessage>(fullyQualifiedNamespace, new DefaultAzureCredential(), "myTopic", new SenderOptions { ConnectionCanCreateTopicOrQueue = true } );
The defaults for the SenderOptions are:
public record SenderOptions
{
public bool ConnectionCanCreateTopicOrQueue { get; set; } = false;
public ServiceBusTransportType ServiceBusTransportType { get; set; } = ServiceBusTransportType.AmqpTcp;
public TimeSpan Delay { get; set; } = TimeSpan.FromSeconds(0.8);
public TimeSpan MaxDelay { get; set; } = TimeSpan.FromMinutes(1);
public int MaxRetries { get; set; } = 3;
public ServiceBusRetryMode Mode { get; set; } = ServiceBusRetryMode.Exponential;
}
Receiving
Create a Receiver with a connection string for the Service Bus e.g.
var receiver = await factory.CreateTopicReceiverAsync<MyMessage>(ServiceBusConnectionString, "myTopic", "mySub");
or using Managed Identity
var receiver = await factory.CreateTopicReceiverAsync<MyMessage>(fullyQualifiedNamespace, new DefaultAzureCredential(), "myTopic", "mySub");
Then to listen for incoming messages e.g.
NOTE : The receive method takes an exception func<> to provide feedback and returns an IObservable to get messages
var observer = receiver.Receive(args =>
{
Console.WriteLine(args.Exception.Message);
return Task.CompletedTask;
});
And finally subscribe to receive the messages e.g.
observer.Subscribe(x => Console.WriteLine($"From Topic {x}"));
TIP: Running in a console app you'll need to keep it open, so add a ReadKey at the bottom
Console.ReadKey();
When creating the Receiver there is also a number of options that can be configured e.g.
var receiver = await factory.CreateTopicReceiverAsync<MyMessage>(fullyQualifiedNamespace, new DefaultAzureCredential(), "myTopic", "mySub", new ReceiverOptions { ConnectionCanCreateTopicOrQueue = true });
The defaults for the ReceiverOptions are:
public record ReceiverOptions
{
public bool ConnectionCanCreateTopicOrQueue { get; set; } = false;
public int MaxConcurrentCalls { get; set; } = 10;
public ServiceBusReceiveMode ReceiveMode { get; set; } = ServiceBusReceiveMode.PeekLock;
}
Basic Injection Usage
Inject the Factory in program.cs e.g.
var builder = WebApplication.CreateBuilder(args);
// Add services to the container.
builder.Services.AddSingleton<IServiceBusFactory, ServiceBusFactory>();
Example
await using var sender = await _serviceBusFactory.CreateSenderAsync<MyMessage>(SendConnectionString, "myTopic");
await sender.SendAsJsonAsync(new MyMessage { Name = "Bilbo Baggins" });
or a Sender e.g.
var builder = WebApplication.CreateBuilder(args);
// Add services to the container.
var factory = new ServiceBusFactory();
var sender = await factory.CreateSenderAsync<MyMessage>(builder.Configuration["ServiceBusSendConnectionString"], "myTopic");
builder.Services.AddSingleton(sender);
Multiple Senders to different topics
var builder = WebApplication.CreateBuilder(args);
// Add services to the container.
var factory = new ServiceBusFactory();
var sender = await factory.CreateSenderAsync<MyMessage>(builder.Configuration["ServiceBusSendConnectionString"], "myTopic");
var otherSender = await factory.CreateSenderAsync<MyOtherMessage>(builder.Configuration["ServiceBusSendConnectionString"], "myOtherTopic");
builder.Services.AddSingleton(sender);
builder.Services.AddSingleton(otherSender);
Example
await _sender.SendAsJsonAsync(new MyMessage { Name = "Bilbo Baggins" });
or a Receiver
var builder = WebApplication.CreateBuilder(args);
// Add services to the container.
var factory = new ServiceBusFactory();
var receiver = await factory.CreateTopicReceiverAsync<MyMessage>(builder.Configuration["ServiceBusReceiveConnectionString"], "myTopic", "mySub");
builder.Services.AddSingleton(receiver);
Multiple Receivers from different topics
var builder = WebApplication.CreateBuilder(args);
// Add services to the container.
var factory = new ServiceBusFactory();
var receiver = await factory.CreateTopicReceiverAsync<MyMessage>(builder.Configuration["ServiceBusReceiveConnectionString"], "myTopic", "mySub");
var otherReceiver = await factory.CreateTopicReceiverAsync<MyOtherMessage>(builder.Configuration["ServiceBusReceiveConnectionString"], "myOtherTopic", "mySub");
builder.Services.AddSingleton(receiver);
builder.Services.AddSingleton(otherReceiver);
Example
var observer = receiver.Receive(args =>
{
Console.WriteLine(args.Exception.Message);
return Task.CompletedTask;
});
observer.Subscribe(x => Console.WriteLine($"From Topic {x.Name}"));
Example with Methods
var observer = receiver.Receive(ExceptionHandler);
observer.Subscribe(IncomingMessage);
private void IncomingMessage(MyMessage message)
{
Console.WriteLine($"From Topic {message.Name}")
}
private Task ExceptionHandler(ProcessErrorEventArgs args)
{
Console.WriteLine(args.Exception.Message);
return Task.CompletedTask;
}
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
- Azure.Messaging.ServiceBus (>= 7.12.0)
- System.Reactive (>= 5.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
2.0.0 | 271 | 3/19/2023 |
1.0.2-preview | 415 | 5/4/2020 |
1.0.1 | 1,470 | 1/6/2019 |
1.0.0 | 837 | 10/21/2018 |
0.0.4-preview | 641 | 10/8/2018 |
0.0.3-preview | 611 | 10/8/2018 |
0.0.2-preview | 593 | 10/8/2018 |
Update to use latest Azure Service Bus libraries Azure.Messaging.ServiceBus 7.12.0 and rework of wrapper