Merged ConnectionFactory features

antonyvorontsov · antonyvorontsov · commit 4788539b14a2 · 2019-12-07T01:30:39.000+03:00
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,8 @@
 **/.project
-**/.vs/
 **/bin/
 **/obj/
+**/.vs/
 **/.vscode/
+**/.idea/
 **/*.xproj.user
 **/*.csproj.user
diff --git a/RabbitMQ.Client.Core.DependencyInjection.sln b/RabbitMQ.Client.Core.DependencyInjection.sln
@@ -15,11 +15,13 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{19ADB6D2-AC61-476A-9FF4-F827574658C7}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Examples.ConsumerHost", "src\Examples.ConsumerHost\Examples.ConsumerHost.csproj", "{10C10C9D-F2ED-43C8-B235-780DD75EF8E6}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Examples.ConsumerHost", "examples\Examples.ConsumerHost\Examples.ConsumerHost.csproj", "{10C10C9D-F2ED-43C8-B235-780DD75EF8E6}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Examples.ConsumerConsole", "src\Examples.ConsumerConsole\Examples.ConsumerConsole.csproj", "{6E75E157-373A-4056-898B-3713CDD5C06C}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Examples.ConsumerConsole", "examples\Examples.ConsumerConsole\Examples.ConsumerConsole.csproj", "{6E75E157-373A-4056-898B-3713CDD5C06C}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Examples.Producer", "src\Examples.Producer\Examples.Producer.csproj", "{1F81E848-7781-448F-BBBB-6A1E509B76CC}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Examples.Producer", "examples\Examples.Producer\Examples.Producer.csproj", "{1F81E848-7781-448F-BBBB-6A1E509B76CC}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "examples", "examples", "{04EFD8F7-5120-4072-9728-64203F6F4873}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -49,9 +51,9 @@ Global
 	EndGlobalSection
 	GlobalSection(NestedProjects) = preSolution
 		{0C8EA737-64AC-4C41-8F80-11BFFEE23CE2} = {19ADB6D2-AC61-476A-9FF4-F827574658C7}
-		{10C10C9D-F2ED-43C8-B235-780DD75EF8E6} = {19ADB6D2-AC61-476A-9FF4-F827574658C7}
-		{6E75E157-373A-4056-898B-3713CDD5C06C} = {19ADB6D2-AC61-476A-9FF4-F827574658C7}
-		{1F81E848-7781-448F-BBBB-6A1E509B76CC} = {19ADB6D2-AC61-476A-9FF4-F827574658C7}
+		{6E75E157-373A-4056-898B-3713CDD5C06C} = {04EFD8F7-5120-4072-9728-64203F6F4873}
+		{10C10C9D-F2ED-43C8-B235-780DD75EF8E6} = {04EFD8F7-5120-4072-9728-64203F6F4873}
+		{1F81E848-7781-448F-BBBB-6A1E509B76CC} = {04EFD8F7-5120-4072-9728-64203F6F4873}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {0EBBD182-65B2-47F9-ABBE-64B5B8C9652F}
diff --git a/examples/Examples.ConsumerConsole/CustomAsyncMessageHandler.cs b/examples/Examples.ConsumerConsole/CustomAsyncMessageHandler.cs
@@ -15,7 +15,7 @@ public CustomAsyncMessageHandler(ILogger<CustomAsyncMessageHandler> logger)
 
         public async Task Handle(string message, string routingKey)
         {
-            await Task.Run(() => _logger.LogInformation("A weird example of runnig something async.")).ConfigureAwait(false);
+            _logger.LogInformation($"A weird example of running something async with message {message}.");
         }
     }
 }
diff --git a/examples/Examples.ConsumerConsole/CustomAsyncNonCyclicMessageHandler.cs b/examples/Examples.ConsumerConsole/CustomAsyncNonCyclicMessageHandler.cs
@@ -15,7 +15,7 @@ public CustomAsyncNonCyclicMessageHandler(ILogger<CustomAsyncNonCyclicMessageHan
 
         public async Task Handle(string message, string routingKey, IQueueService queueService)
         {
-            _logger.LogInformation("A weird example of runnig something async.");
+            _logger.LogInformation("A weird example of running something async.");
             var response = new { message, routingKey };
             await queueService.SendAsync(response, "exchange.name", "routing.key");
         }
diff --git a/examples/Examples.ConsumerConsole/Examples.ConsumerConsole.csproj b/examples/Examples.ConsumerConsole/Examples.ConsumerConsole.csproj
@@ -14,7 +14,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <ProjectReference Include="..\RabbitMQ.Client.Core.DependencyInjection\RabbitMQ.Client.Core.DependencyInjection.csproj" />
+    <ProjectReference Include="..\..\src\RabbitMQ.Client.Core.DependencyInjection\RabbitMQ.Client.Core.DependencyInjection.csproj" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/examples/Examples.ConsumerConsole/Program.cs b/examples/Examples.ConsumerConsole/Program.cs
@@ -32,8 +32,8 @@ static void ConfigureServices(IServiceCollection services)
 
             services.AddRabbitMqClient(rabbitMqSection)
                 .AddConsumptionExchange("exchange.name", exchangeSection)
-                .AddAsyncMessageHandlerSingleton<CustomAsyncMessageHandler>("routing.key")
-                .AddAsyncNonCyclicMessageHandlerSingleton<CustomAsyncNonCyclicMessageHandler>("routing.key");
+                .AddAsyncMessageHandlerSingleton<CustomAsyncMessageHandler>("routing.key");
+                //.AddAsyncNonCyclicMessageHandlerSingleton<CustomAsyncNonCyclicMessageHandler>("routing.key");
         }
     }
 }
diff --git a/examples/Examples.ConsumerConsole/appsettings.json b/examples/Examples.ConsumerConsole/appsettings.json
@@ -5,7 +5,12 @@
     }
   },
   "RabbitMq": {
-    "HostName": "127.0.0.1",
+    "TcpEndpoints": [
+      {
+        "HostName": "127.0.0.1",
+        "Port": 5672
+      }
+    ],
     "Port": "5672",
     "UserName": "guest",
     "Password": "guest"
diff --git a/examples/Examples.ConsumerHost/ConsumingService.cs b/examples/Examples.ConsumerHost/ConsumingService.cs
diff --git a/examples/Examples.ConsumerHost/CustomMessageHandler.cs b/examples/Examples.ConsumerHost/CustomMessageHandler.cs
diff --git a/examples/Examples.ConsumerHost/CustomNonCyclicMessageHandler.cs b/examples/Examples.ConsumerHost/CustomNonCyclicMessageHandler.cs
diff --git a/examples/Examples.ConsumerHost/Examples.ConsumerHost.csproj b/examples/Examples.ConsumerHost/Examples.ConsumerHost.csproj
@@ -15,7 +15,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <ProjectReference Include="..\RabbitMQ.Client.Core.DependencyInjection\RabbitMQ.Client.Core.DependencyInjection.csproj" />
+    <ProjectReference Include="..\..\src\RabbitMQ.Client.Core.DependencyInjection\RabbitMQ.Client.Core.DependencyInjection.csproj" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/examples/Examples.ConsumerHost/Program.cs b/examples/Examples.ConsumerHost/Program.cs
@@ -27,8 +27,8 @@ public static async Task Main()
 
                   services.AddRabbitMqClient(rabbitMqSection)
                       .AddConsumptionExchange("exchange.name", exchangeSection)
-                      .AddMessageHandlerTransient<CustomMessageHandler>("routing.key")
-                      .AddNonCyclicMessageHandlerSingleton<CustomNonCyclicMessageHandler>("routing.key");
+                      .AddMessageHandlerTransient<CustomMessageHandler>("routing.key");
+                      //.AddNonCyclicMessageHandlerSingleton<CustomNonCyclicMessageHandler>("routing.key");
 
                   services.AddSingleton<IHostedService, ConsumingService>();
               });
diff --git a/examples/Examples.ConsumerHost/appsettings.json b/examples/Examples.ConsumerHost/appsettings.json
diff --git a/examples/Examples.Producer/Examples.Producer.csproj b/examples/Examples.Producer/Examples.Producer.csproj
@@ -10,7 +10,7 @@
   </ItemGroup>
   
   <ItemGroup>
-    <ProjectReference Include="..\RabbitMQ.Client.Core.DependencyInjection\RabbitMQ.Client.Core.DependencyInjection.csproj" />
+    <ProjectReference Include="..\..\src\RabbitMQ.Client.Core.DependencyInjection\RabbitMQ.Client.Core.DependencyInjection.csproj" />
   </ItemGroup>
 
 </Project>
diff --git a/examples/Examples.Producer/Message.cs b/examples/Examples.Producer/Message.cs
diff --git a/examples/Examples.Producer/Program.cs b/examples/Examples.Producer/Program.cs
diff --git a/src/RabbitMQ.Client.Core.DependencyInjection/Configuration/RabbitMqClientOptions.cs b/src/RabbitMQ.Client.Core.DependencyInjection/Configuration/RabbitMqClientOptions.cs
@@ -1,13 +1,41 @@
-﻿namespace RabbitMQ.Client.Core.DependencyInjection.Configuration
+﻿using System.Collections.Generic;
+
+namespace RabbitMQ.Client.Core.DependencyInjection.Configuration
 {
     /// <summary>
     /// RabbitMQ configuration model.
     /// </summary>
     public class RabbitMqClientOptions
     {
+        /// <summary>
+        /// Collection of AMPQ TCP endpoints.
+        /// It can be used when RabbitMQ HA cluster is set up and you have to connect multiple hosts with different ports.
+        /// </summary>
+        /// <remarks>
+        /// Has the first priority between properties TcpEndpoints, HostNames and HostName.
+        /// If all properties are set, TcpEndpoints will be used.
+        /// </remarks>
+        public IEnumerable<RabbitMqTcpEndpoint> TcpEndpoints { get; set; }
+
+        /// <summary>
+        /// Collection of RabbitMQ server host names.
+        /// It can be used when RabbitMQ HA cluster is set up and you have to connect multiple hosts.
+        /// If HostNames collection is null or empty then HostName will be used to create connection.
+        /// Otherwise HostNames collection will be used and HostName property value will be ignored.
+        /// </summary>
+        /// <remarks>
+        /// Has the second priority between properties TcpEndpoints, HostNames and HostName.
+        /// If HostNames collection property and HostName property both set then HostNames will be used.
+        /// </remarks>
+        public IEnumerable<string> HostNames { get; set; }
+
         /// <summary>
         /// RabbitMQ server.
         /// </summary>
+        /// <remarks>
+        /// Has the third priority between properties TcpEndpoints, HostNames and HostName.
+        /// HostName will be used if only TcpEndpoints and HostNames properties are not set.
+        /// </remarks>
         public string HostName { get; set; } = "127.0.0.1";
 
         /// <summary>
@@ -49,5 +77,10 @@ public class RabbitMqClientOptions
         /// Heartbeat timeout.
         /// </summary>
         public ushort RequestedHeartbeat { get; set; } = 60;
+
+        /// <summary>
+        /// Application-specific connection name, will be displayed in the management UI if RabbitMQ server supports it.
+        /// </summary>
+        public string ClientProvidedName { get; set; }
     }
 }
diff --git a/src/RabbitMQ.Client.Core.DependencyInjection/Configuration/RabbitMqTcpEndpoint.cs b/src/RabbitMQ.Client.Core.DependencyInjection/Configuration/RabbitMqTcpEndpoint.cs
@@ -0,0 +1,18 @@
+namespace RabbitMQ.Client.Core.DependencyInjection.Configuration
+{
+    /// <summary>
+    /// Model of AMPQ Tcp endpoint.
+    /// </summary>
+    public class RabbitMqTcpEndpoint
+    {
+        /// <summary>
+        /// RabbitMQ server.
+        /// </summary>
+        public string HostName { get; set; }
+
+        /// <summary>
+        /// Tcp connection port.
+        /// </summary>
+        public int Port { get; set; }
+    }
+}
diff --git a/src/RabbitMQ.Client.Core.DependencyInjection/QueueService.cs b/src/RabbitMQ.Client.Core.DependencyInjection/QueueService.cs
@@ -69,22 +69,7 @@ public QueueService(
             _asyncNonCyclicHandlers = TransformMessageHandlersCollection(asyncnonCyclicHandlers);
 
             _logger = loggerFactory.CreateLogger<QueueService>();
-
-            var optionsValue = options.Value;
-            var factory = new ConnectionFactory
-            {
-                HostName = optionsValue.HostName,
-                Port = optionsValue.Port,
-                UserName = optionsValue.UserName,
-                Password = optionsValue.Password,
-                VirtualHost = optionsValue.VirtualHost,
-                AutomaticRecoveryEnabled = optionsValue.AutomaticRecoveryEnabled,
-                TopologyRecoveryEnabled = optionsValue.TopologyRecoveryEnabled,
-                RequestedConnectionTimeout = optionsValue.RequestedConnectionTimeout,
-                RequestedHeartbeat = optionsValue.RequestedHeartbeat
-            };
-
-            _connection = factory.CreateConnection();
+            _connection = CreateRabbitMqConnection(options.Value);
             // Event handling.
             _connection.CallbackException += HandleConnectionCallbackException;
             _connection.ConnectionRecoveryError += HandleConnectionRecoveryError;
@@ -556,5 +541,52 @@ static Dictionary<string, object> CreateArguments(string exchangeName, string ro
                 { "x-message-ttl", secondsDelay * 1000 },
                 { "x-expires", secondsDelay * 1000 + QueueExpirationTime }
             };
+
+        static IConnection CreateRabbitMqConnection(RabbitMqClientOptions options)
+        {
+            var factory = new ConnectionFactory
+            {
+                Port = options.Port,
+                UserName = options.UserName,
+                Password = options.Password,
+                VirtualHost = options.VirtualHost,
+                AutomaticRecoveryEnabled = options.AutomaticRecoveryEnabled,
+                TopologyRecoveryEnabled = options.TopologyRecoveryEnabled,
+                RequestedConnectionTimeout = options.RequestedConnectionTimeout,
+                RequestedHeartbeat = options.RequestedHeartbeat
+            };
+
+            if (options.TcpEndpoints?.Any() == true)
+            {
+                var clientEndpoints = options.TcpEndpoints.Select(x => new AmqpTcpEndpoint(x.HostName, x.Port)).ToList();
+                return factory.CreateConnection(clientEndpoints);
+            }
+
+            return string.IsNullOrEmpty(options.ClientProvidedName)
+                ? CreateConnection(options, factory)
+                : CreateNamedConnection(options, factory);
+        }
+
+        static IConnection CreateNamedConnection(RabbitMqClientOptions options, ConnectionFactory factory)
+        {
+            if (options.HostNames?.Any() == true)
+            {
+                return factory.CreateConnection(options.HostNames.ToList(), options.ClientProvidedName);
+            }
+
+            factory.HostName = options.HostName;
+            return factory.CreateConnection(options.ClientProvidedName);
+        }
+
+        static IConnection CreateConnection(RabbitMqClientOptions options, ConnectionFactory factory)
+        {
+            if (options.HostNames?.Any() == true)
+            {
+                return factory.CreateConnection(options.HostNames.ToList());
+            }
+
+            factory.HostName = options.HostName;
+            return factory.CreateConnection();
+        }
     }
 }
diff --git a/src/RabbitMQ.Client.Core.DependencyInjection/RabbitMQ.Client.Core.DependencyInjection.csproj b/src/RabbitMQ.Client.Core.DependencyInjection/RabbitMQ.Client.Core.DependencyInjection.csproj
@@ -3,10 +3,8 @@
   <PropertyGroup>
     <TargetFramework>netcoreapp2.2</TargetFramework>
     <LangVersion>latest</LangVersion>
-    <Version>2.2.0</Version>
+    <Version>2.2.1</Version>
     <PackageTags>RabbitMQ</PackageTags>
-    <PackageLicenseFile>LICENSE.txt</PackageLicenseFile>
-    <PackageIcon>icon.png</PackageIcon>
     <RepositoryUrl>https://github.com/AntonyVorontsov/RabbitMQ.Client.Core.DependencyInjection</RepositoryUrl>
     <Company />
     <Description>.Net Core library-wrapper of RabbitMQ.Client for Dependency Injection.</Description>
@@ -15,18 +13,22 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <None Include="../../LICENSE.txt" Pack="true" PackagePath="$(PackageLicenseFile)" />
+    <None Include="../../LICENSE.txt">
+      <Pack>True</Pack>
+    </None>
   </ItemGroup>
 
   <ItemGroup>
-    <None Include="../../icon.png" Pack="true" PackagePath="/" />
+    <None Include="../../icon.png">
+      <Pack>True</Pack>
+    </None>
   </ItemGroup>
 
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="2.2.0" />
     <PackageReference Include="Microsoft.Extensions.Logging" Version="2.2.0" />
     <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="2.2.0" />
-    <PackageReference Include="Newtonsoft.Json" Version="12.0.2" />
+    <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
     <PackageReference Include="RabbitMQ.Client" Version="5.1.2" />
   </ItemGroup>
 
diff --git a/src/RabbitMQ.Client.Core.DependencyInjection/RabbitMqClientDependencyInjectionExtensions.cs b/src/RabbitMQ.Client.Core.DependencyInjection/RabbitMqClientDependencyInjectionExtensions.cs
@@ -40,6 +40,8 @@ public static IServiceCollection AddRabbitMqClient(this IServiceCollection servi
             services.Configure<RabbitMqClientOptions>(opt =>
             {
                 opt.HostName = configuration.HostName;
+                opt.HostNames = configuration.HostNames;
+                opt.TcpEndpoints = configuration.TcpEndpoints;
                 opt.Port = configuration.Port;
                 opt.UserName = configuration.UserName;
                 opt.Password = configuration.Password;
@@ -48,6 +50,7 @@ public static IServiceCollection AddRabbitMqClient(this IServiceCollection servi
                 opt.TopologyRecoveryEnabled = configuration.TopologyRecoveryEnabled;
                 opt.RequestedConnectionTimeout = configuration.RequestedConnectionTimeout;
                 opt.RequestedHeartbeat = configuration.RequestedHeartbeat;
+                opt.ClientProvidedName = configuration.ClientProvidedName;
             });
             services.AddSingleton<IQueueService, QueueService>();
             return services;

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ public CustomAsyncMessageHandler(ILogger<CustomAsyncMessageHandler> logger)`
`15`	`15`
`16`	`16`	`public async Task Handle(string message, string routingKey)`
`17`	`17`	`{`
`18`		`- await Task.Run(() => _logger.LogInformation("A weird example of runnig something async.")).ConfigureAwait(false);`
	`18`	`+ _logger.LogInformation($"A weird example of running something async with message {message}.");`
`19`	`19`	`}`
`20`	`20`	`}`
`21`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ public CustomAsyncNonCyclicMessageHandler(ILogger<CustomAsyncNonCyclicMessageHan`
`15`	`15`
`16`	`16`	`public async Task Handle(string message, string routingKey, IQueueService queueService)`
`17`	`17`	`{`
`18`		`- _logger.LogInformation("A weird example of runnig something async.");`
	`18`	`+ _logger.LogInformation("A weird example of running something async.");`
`19`	`19`	`var response = new { message, routingKey };`
`20`	`20`	`await queueService.SendAsync(response, "exchange.name", "routing.key");`
`21`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,8 +32,8 @@ static void ConfigureServices(IServiceCollection services)`
`32`	`32`
`33`	`33`	`services.AddRabbitMqClient(rabbitMqSection)`
`34`	`34`	`.AddConsumptionExchange("exchange.name", exchangeSection)`
`35`		`- .AddAsyncMessageHandlerSingleton<CustomAsyncMessageHandler>("routing.key")`
`36`		`- .AddAsyncNonCyclicMessageHandlerSingleton<CustomAsyncNonCyclicMessageHandler>("routing.key");`
	`35`	`+ .AddAsyncMessageHandlerSingleton<CustomAsyncMessageHandler>("routing.key");`
	`36`	`+ //.AddAsyncNonCyclicMessageHandlerSingleton<CustomAsyncNonCyclicMessageHandler>("routing.key");`
`37`	`37`	`}`
`38`	`38`	`}`
`39`	`39`	`}`