Merge pull request #27 from AntonyVorontsov/feature/queue-service-separation

WIP: IQueueService separation.

Author: antonyvorontsov

RabbitMQ.Client.Core.DependencyInjection.sln

@@ -42,6 +42,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "tests", "tests", "{9D0289B2
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "RabbitMQ.Client.Core.DependencyInjection.Tests", "tests\RabbitMQ.Client.Core.DependencyInjection.Tests\RabbitMQ.Client.Core.DependencyInjection.Tests.csproj", "{85907F19-00B0-4BA6-9B7C-0452A174903D}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Examples.AdvancedConfiguration", "examples\Examples.AdvancedConfiguration\Examples.AdvancedConfiguration.csproj", "{0C713913-8D54-49E7-AADD-45497216E2EF}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -68,6 +70,10 @@ Global
 		{85907F19-00B0-4BA6-9B7C-0452A174903D}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{85907F19-00B0-4BA6-9B7C-0452A174903D}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{85907F19-00B0-4BA6-9B7C-0452A174903D}.Release|Any CPU.Build.0 = Release|Any CPU
+		{0C713913-8D54-49E7-AADD-45497216E2EF}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{0C713913-8D54-49E7-AADD-45497216E2EF}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{0C713913-8D54-49E7-AADD-45497216E2EF}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{0C713913-8D54-49E7-AADD-45497216E2EF}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -79,6 +85,7 @@ Global
 		{1F81E848-7781-448F-BBBB-6A1E509B76CC} = {04EFD8F7-5120-4072-9728-64203F6F4873}
 		{93D59B0E-856C-4260-B50E-57FE5C0F5073} = {BC4CDBDE-4AEE-44B3-B00B-380EB1AC5E62}
 		{85907F19-00B0-4BA6-9B7C-0452A174903D} = {9D0289B2-C566-46CC-A53A-471BCBA0F277}
+		{0C713913-8D54-49E7-AADD-45497216E2EF} = {04EFD8F7-5120-4072-9728-64203F6F4873}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {0EBBD182-65B2-47F9-ABBE-64B5B8C9652F}

examples/Examples.AdvancedConfiguration/Controllers/ExampleController.cs

@@ -0,0 +1,32 @@
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Logging;
+using RabbitMQ.Client.Core.DependencyInjection;
+
+namespace Examples.AdvancedConfiguration.Controllers
+{
+    [ApiController]
+    [Route("api/example")]
+    public class ExampleController : ControllerBase
+    {
+        readonly ILogger<ExampleController> _logger;
+        readonly IProducingService _producingService;
+
+        public ExampleController(
+            IProducingService producingService,
+            ILogger<ExampleController> logger)
+        {
+            _producingService = producingService;
+            _logger = logger;
+        }
+
+        [HttpGet]
+        public async Task<IActionResult> Get()
+        {
+            _logger.LogInformation($"Sending messages with {typeof(IProducingService)}.");
+            var message = new { message = "text" };
+            await _producingService.SendAsync(message, "consumption.exchange", "routing.key");
+            return Ok(message);
+        }
+    }
+}

examples/Examples.AdvancedConfiguration/Examples.AdvancedConfiguration.csproj

@@ -0,0 +1,11 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+    <PropertyGroup>
+        <TargetFramework>netcoreapp3.1</TargetFramework>
+    </PropertyGroup>
+
+    <ItemGroup>
+      <ProjectReference Include="..\..\src\RabbitMQ.Client.Core.DependencyInjection\RabbitMQ.Client.Core.DependencyInjection.csproj" />
+    </ItemGroup>
+    
+</Project>

examples/Examples.AdvancedConfiguration/MessageHandlers/CustomAsyncMessageHandler.cs

@@ -0,0 +1,15 @@
+using System.Threading.Tasks;
+using RabbitMQ.Client.Core.DependencyInjection;
+
+namespace Examples.AdvancedConfiguration.MessageHandlers
+{
+    public class CustomAsyncMessageHandler : IAsyncMessageHandler
+    {
+        public async Task Handle(string message, string routingKey)
+        {
+            // The message handler does not do anything.
+            // It is just an example.
+            await Task.CompletedTask;
+        }
+    }
+}

examples/Examples.AdvancedConfiguration/MessageHandlers/CustomAsyncNonCyclicMessageHandler.cs

@@ -0,0 +1,15 @@
+using System.Threading.Tasks;
+using RabbitMQ.Client.Core.DependencyInjection;
+
+namespace Examples.AdvancedConfiguration.MessageHandlers
+{
+    public class CustomAsyncNonCyclicMessageHandler : IAsyncNonCyclicMessageHandler
+    {
+        public async Task Handle(string message, string routingKey, IQueueService queueService)
+        {
+            // The message handler does not do anything.
+            // It is just an example.
+            await Task.CompletedTask;
+        }
+    }
+}

examples/Examples.AdvancedConfiguration/MessageHandlers/CustomMessageHandler.cs

@@ -0,0 +1,13 @@
+using RabbitMQ.Client.Core.DependencyInjection;
+
+namespace Examples.AdvancedConfiguration.MessageHandlers
+{
+    public class CustomMessageHandler : IMessageHandler
+    {
+        public void Handle(string message, string routingKey)
+        {
+            // The message handler does not do anything.
+            // It is just an example.
+        }
+    }
+}

examples/Examples.AdvancedConfiguration/MessageHandlers/CustomNonCyclicMessageHandler.cs

@@ -0,0 +1,13 @@
+using RabbitMQ.Client.Core.DependencyInjection;
+
+namespace Examples.AdvancedConfiguration.MessageHandlers
+{
+    public class CustomNonCyclicMessageHandler : INonCyclicMessageHandler
+    {
+        public void Handle(string message, string routingKey, IQueueService queueService)
+        {
+            // The message handler does not do anything.
+            // It is just an example.
+        }
+    }
+}

examples/Examples.AdvancedConfiguration/Program.cs

@@ -0,0 +1,16 @@
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.Extensions.Hosting;
+
+namespace Examples.AdvancedConfiguration
+{
+    public static class Program
+    {
+        public static void Main(string[] args)
+        {
+            Host.CreateDefaultBuilder(args)
+                .ConfigureWebHostDefaults(webBuilder => webBuilder.UseStartup<Startup>())
+                .Build()
+                .Run();
+        }
+    }
+}

examples/Examples.AdvancedConfiguration/Services/ConsumingHostedService.cs

@@ -0,0 +1,28 @@
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.Extensions.Hosting;
+using RabbitMQ.Client.Core.DependencyInjection;
+
+namespace Examples.AdvancedConfiguration.Services
+{
+    public class ConsumingHostedService : IHostedService
+    {
+        readonly IConsumingService _consumingService;
+        
+        public ConsumingHostedService(IConsumingService consumingService)
+        {
+            _consumingService = consumingService;
+        }
+
+        public Task StartAsync(CancellationToken cancellationToken)
+        {
+            _consumingService.StartConsuming();
+            return Task.CompletedTask;
+        }
+
+        public Task StopAsync(CancellationToken cancellationToken)
+        {
+            return Task.CompletedTask;
+        }
+    }
+}

examples/Examples.AdvancedConfiguration/Startup.cs

@@ -0,0 +1,53 @@
+using Examples.AdvancedConfiguration.MessageHandlers;
+using Examples.AdvancedConfiguration.Services;
+using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
+using RabbitMQ.Client.Core.DependencyInjection;
+
+namespace Examples.AdvancedConfiguration
+{
+    public class Startup
+    {
+        private IConfiguration Configuration { get; }
+        
+        public Startup(IConfiguration configuration)
+        {
+            Configuration = configuration;
+        }
+
+        public void ConfigureServices(IServiceCollection services)
+        {
+            services.AddControllers();
+            
+            // Configurations are the same (same user) and same password, but the only difference - names of connections.
+            var rabbitMqConsumerSection = Configuration.GetSection("RabbitMqConsumer");
+            var rabbitMqProducerSection = Configuration.GetSection("RabbitMqProducer");
+            
+            var producingExchangeSection = Configuration.GetSection("ProducingExchange");
+            var consumingExchangeSection = Configuration.GetSection("ConsumingExchange");
+
+            // There is an example of configuring different message handlers with different parameters.
+            // You can set connection of routing keys or specify the exact exchange that will be listened by giver routing keys (or route patterns) by message handlers.
+            // You can also register singleton or transient RabbitMQ clients (IConsumer and IProducer) and message handlers.
+            // There are a lot of different extension methods that is better take a closer look to.
+            services.AddRabbitMqConsumingClientSingleton(rabbitMqConsumerSection)
+                .AddRabbitMqProducingClientSingleton(rabbitMqProducerSection)
+                .AddProductionExchange("exchange.to.send.messages.only", producingExchangeSection)
+                .AddConsumptionExchange("consumption.exchange", consumingExchangeSection)
+                .AddMessageHandlerTransient<CustomMessageHandler>("routing.key")
+                .AddAsyncMessageHandlerTransient<CustomAsyncMessageHandler>(new[] { "routing.key", "another.routing.key" })
+                .AddNonCyclicMessageHandlerSingleton<CustomNonCyclicMessageHandler>("*.*", "consumption.exchange")
+                .AddAsyncNonCyclicMessageHandlerSingleton<CustomAsyncNonCyclicMessageHandler>("#", "consumption.exchange");
+
+            services.AddHostedService<ConsumingHostedService>();
+        }
+
+        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
+        {
+            app.UseRouting();
+            app.UseEndpoints(endpoints => endpoints.MapControllers());
+        }
+    }
+}