├── .gitignore ├── LICENSE ├── Plain.RabbitMQ.sln ├── Plain.RabbitMQ ├── ConnectionProvider.cs ├── IConnectionProvider.cs ├── IPublisher.cs ├── ISubscriber.cs ├── Plain.RabbitMQ.csproj ├── Publisher.cs └── Subscriber.cs └── README.md /.gitignore: -------------------------------------------------------------------------------- 1 | ## Ignore Visual Studio temporary files, build results, and 2 | ## files generated by popular Visual Studio add-ons. 3 | ## 4 | ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore 5 | 6 | # User-specific files 7 | *.rsuser 8 | *.suo 9 | *.user 10 | *.userosscache 11 | *.sln.docstates 12 | 13 | # User-specific files (MonoDevelop/Xamarin Studio) 14 | *.userprefs 15 | 16 | # Mono auto generated files 17 | mono_crash.* 18 | 19 | # Build results 20 | [Dd]ebug/ 21 | [Dd]ebugPublic/ 22 | [Rr]elease/ 23 | [Rr]eleases/ 24 | x64/ 25 | x86/ 26 | [Aa][Rr][Mm]/ 27 | [Aa][Rr][Mm]64/ 28 | bld/ 29 | [Bb]in/ 30 | [Oo]bj/ 31 | [Ll]og/ 32 | [Ll]ogs/ 33 | 34 | # Visual Studio 2015/2017 cache/options directory 35 | .vs/ 36 | # Uncomment if you have tasks that create the project's static files in wwwroot 37 | #wwwroot/ 38 | 39 | # Visual Studio 2017 auto generated files 40 | Generated\ Files/ 41 | 42 | # MSTest test Results 43 | [Tt]est[Rr]esult*/ 44 | [Bb]uild[Ll]og.* 45 | 46 | # NUnit 47 | *.VisualState.xml 48 | TestResult.xml 49 | nunit-*.xml 50 | 51 | # Build Results of an ATL Project 52 | [Dd]ebugPS/ 53 | [Rr]eleasePS/ 54 | dlldata.c 55 | 56 | # Benchmark Results 57 | BenchmarkDotNet.Artifacts/ 58 | 59 | # .NET Core 60 | project.lock.json 61 | project.fragment.lock.json 62 | artifacts/ 63 | 64 | # StyleCop 65 | StyleCopReport.xml 66 | 67 | # Files built by Visual Studio 68 | *_i.c 69 | *_p.c 70 | *_h.h 71 | *.ilk 72 | *.meta 73 | *.obj 74 | *.iobj 75 | *.pch 76 | *.pdb 77 | *.ipdb 78 | *.pgc 79 | *.pgd 80 | *.rsp 81 | *.sbr 82 | *.tlb 83 | *.tli 84 | *.tlh 85 | *.tmp 86 | *.tmp_proj 87 | *_wpftmp.csproj 88 | *.log 89 | *.vspscc 90 | *.vssscc 91 | .builds 92 | *.pidb 93 | *.svclog 94 | *.scc 95 | 96 | # Chutzpah Test files 97 | _Chutzpah* 98 | 99 | # Visual C++ cache files 100 | ipch/ 101 | *.aps 102 | *.ncb 103 | *.opendb 104 | *.opensdf 105 | *.sdf 106 | *.cachefile 107 | *.VC.db 108 | *.VC.VC.opendb 109 | 110 | # Visual Studio profiler 111 | *.psess 112 | *.vsp 113 | *.vspx 114 | *.sap 115 | 116 | # Visual Studio Trace Files 117 | *.e2e 118 | 119 | # TFS 2012 Local Workspace 120 | $tf/ 121 | 122 | # Guidance Automation Toolkit 123 | *.gpState 124 | 125 | # ReSharper is a .NET coding add-in 126 | _ReSharper*/ 127 | *.[Rr]e[Ss]harper 128 | *.DotSettings.user 129 | 130 | # TeamCity is a build add-in 131 | _TeamCity* 132 | 133 | # DotCover is a Code Coverage Tool 134 | *.dotCover 135 | 136 | # AxoCover is a Code Coverage Tool 137 | .axoCover/* 138 | !.axoCover/settings.json 139 | 140 | # Visual Studio code coverage results 141 | *.coverage 142 | *.coveragexml 143 | 144 | # NCrunch 145 | _NCrunch_* 146 | .*crunch*.local.xml 147 | nCrunchTemp_* 148 | 149 | # MightyMoose 150 | *.mm.* 151 | AutoTest.Net/ 152 | 153 | # Web workbench (sass) 154 | .sass-cache/ 155 | 156 | # Installshield output folder 157 | [Ee]xpress/ 158 | 159 | # DocProject is a documentation generator add-in 160 | DocProject/buildhelp/ 161 | DocProject/Help/*.HxT 162 | DocProject/Help/*.HxC 163 | DocProject/Help/*.hhc 164 | DocProject/Help/*.hhk 165 | DocProject/Help/*.hhp 166 | DocProject/Help/Html2 167 | DocProject/Help/html 168 | 169 | # Click-Once directory 170 | publish/ 171 | 172 | # Publish Web Output 173 | *.[Pp]ublish.xml 174 | *.azurePubxml 175 | # Note: Comment the next line if you want to checkin your web deploy settings, 176 | # but database connection strings (with potential passwords) will be unencrypted 177 | *.pubxml 178 | *.publishproj 179 | 180 | # Microsoft Azure Web App publish settings. Comment the next line if you want to 181 | # checkin your Azure Web App publish settings, but sensitive information contained 182 | # in these scripts will be unencrypted 183 | PublishScripts/ 184 | 185 | # NuGet Packages 186 | *.nupkg 187 | # NuGet Symbol Packages 188 | *.snupkg 189 | # The packages folder can be ignored because of Package Restore 190 | **/[Pp]ackages/* 191 | # except build/, which is used as an MSBuild target. 192 | !**/[Pp]ackages/build/ 193 | # Uncomment if necessary however generally it will be regenerated when needed 194 | #!**/[Pp]ackages/repositories.config 195 | # NuGet v3's project.json files produces more ignorable files 196 | *.nuget.props 197 | *.nuget.targets 198 | 199 | # Microsoft Azure Build Output 200 | csx/ 201 | *.build.csdef 202 | 203 | # Microsoft Azure Emulator 204 | ecf/ 205 | rcf/ 206 | 207 | # Windows Store app package directories and files 208 | AppPackages/ 209 | BundleArtifacts/ 210 | Package.StoreAssociation.xml 211 | _pkginfo.txt 212 | *.appx 213 | *.appxbundle 214 | *.appxupload 215 | 216 | # Visual Studio cache files 217 | # files ending in .cache can be ignored 218 | *.[Cc]ache 219 | # but keep track of directories ending in .cache 220 | !?*.[Cc]ache/ 221 | 222 | # Others 223 | ClientBin/ 224 | ~$* 225 | *~ 226 | *.dbmdl 227 | *.dbproj.schemaview 228 | *.jfm 229 | *.pfx 230 | *.publishsettings 231 | orleans.codegen.cs 232 | 233 | # Including strong name files can present a security risk 234 | # (https://github.com/github/gitignore/pull/2483#issue-259490424) 235 | #*.snk 236 | 237 | # Since there are multiple workflows, uncomment next line to ignore bower_components 238 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) 239 | #bower_components/ 240 | 241 | # RIA/Silverlight projects 242 | Generated_Code/ 243 | 244 | # Backup & report files from converting an old project file 245 | # to a newer Visual Studio version. Backup files are not needed, 246 | # because we have git ;-) 247 | _UpgradeReport_Files/ 248 | Backup*/ 249 | UpgradeLog*.XML 250 | UpgradeLog*.htm 251 | ServiceFabricBackup/ 252 | *.rptproj.bak 253 | 254 | # SQL Server files 255 | *.mdf 256 | *.ldf 257 | *.ndf 258 | 259 | # Business Intelligence projects 260 | *.rdl.data 261 | *.bim.layout 262 | *.bim_*.settings 263 | *.rptproj.rsuser 264 | *- [Bb]ackup.rdl 265 | *- [Bb]ackup ([0-9]).rdl 266 | *- [Bb]ackup ([0-9][0-9]).rdl 267 | 268 | # Microsoft Fakes 269 | FakesAssemblies/ 270 | 271 | # GhostDoc plugin setting file 272 | *.GhostDoc.xml 273 | 274 | # Node.js Tools for Visual Studio 275 | .ntvs_analysis.dat 276 | node_modules/ 277 | 278 | # Visual Studio 6 build log 279 | *.plg 280 | 281 | # Visual Studio 6 workspace options file 282 | *.opt 283 | 284 | # Visual Studio 6 auto-generated workspace file (contains which files were open etc.) 285 | *.vbw 286 | 287 | # Visual Studio LightSwitch build output 288 | **/*.HTMLClient/GeneratedArtifacts 289 | **/*.DesktopClient/GeneratedArtifacts 290 | **/*.DesktopClient/ModelManifest.xml 291 | **/*.Server/GeneratedArtifacts 292 | **/*.Server/ModelManifest.xml 293 | _Pvt_Extensions 294 | 295 | # Paket dependency manager 296 | .paket/paket.exe 297 | paket-files/ 298 | 299 | # FAKE - F# Make 300 | .fake/ 301 | 302 | # CodeRush personal settings 303 | .cr/personal 304 | 305 | # Python Tools for Visual Studio (PTVS) 306 | __pycache__/ 307 | *.pyc 308 | 309 | # Cake - Uncomment if you are using it 310 | # tools/** 311 | # !tools/packages.config 312 | 313 | # Tabs Studio 314 | *.tss 315 | 316 | # Telerik's JustMock configuration file 317 | *.jmconfig 318 | 319 | # BizTalk build output 320 | *.btp.cs 321 | *.btm.cs 322 | *.odx.cs 323 | *.xsd.cs 324 | 325 | # OpenCover UI analysis results 326 | OpenCover/ 327 | 328 | # Azure Stream Analytics local run output 329 | ASALocalRun/ 330 | 331 | # MSBuild Binary and Structured Log 332 | *.binlog 333 | 334 | # NVidia Nsight GPU debugger configuration file 335 | *.nvuser 336 | 337 | # MFractors (Xamarin productivity tool) working folder 338 | .mfractor/ 339 | 340 | # Local History for Visual Studio 341 | .localhistory/ 342 | 343 | # BeatPulse healthcheck temp database 344 | healthchecksdb 345 | 346 | # Backup folder for Package Reference Convert tool in Visual Studio 2017 347 | MigrationBackup/ 348 | 349 | # Ionide (cross platform F# VS Code tools) working folder 350 | .ionide/ 351 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2020 Nirjhar Choudhury 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /Plain.RabbitMQ.sln: -------------------------------------------------------------------------------- 1 |  2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio Version 16 4 | VisualStudioVersion = 16.0.30523.141 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Plain.RabbitMQ", "Plain.RabbitMQ\Plain.RabbitMQ.csproj", "{E7D64C4C-841B-4BD2-94AF-297F191B1512}" 7 | EndProject 8 | Global 9 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 10 | Debug|Any CPU = Debug|Any CPU 11 | Release|Any CPU = Release|Any CPU 12 | EndGlobalSection 13 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 14 | {E7D64C4C-841B-4BD2-94AF-297F191B1512}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 15 | {E7D64C4C-841B-4BD2-94AF-297F191B1512}.Debug|Any CPU.Build.0 = Debug|Any CPU 16 | {E7D64C4C-841B-4BD2-94AF-297F191B1512}.Release|Any CPU.ActiveCfg = Release|Any CPU 17 | {E7D64C4C-841B-4BD2-94AF-297F191B1512}.Release|Any CPU.Build.0 = Release|Any CPU 18 | EndGlobalSection 19 | GlobalSection(SolutionProperties) = preSolution 20 | HideSolutionNode = FALSE 21 | EndGlobalSection 22 | GlobalSection(ExtensibilityGlobals) = postSolution 23 | SolutionGuid = {2B918FA5-D9D2-433B-9425-027150857B72} 24 | EndGlobalSection 25 | EndGlobal 26 | -------------------------------------------------------------------------------- /Plain.RabbitMQ/ConnectionProvider.cs: -------------------------------------------------------------------------------- 1 | using RabbitMQ.Client; 2 | using System; 3 | 4 | namespace Plain.RabbitMQ 5 | { 6 | public class ConnectionProvider : IConnectionProvider 7 | { 8 | private readonly ConnectionFactory _factory; 9 | private readonly IConnection _connection; 10 | private bool _disposed; 11 | 12 | public ConnectionProvider(string url) 13 | { 14 | _factory = new ConnectionFactory 15 | { 16 | Uri = new Uri(url) 17 | }; 18 | _connection = _factory.CreateConnection(); 19 | } 20 | 21 | public IConnection GetConnection() 22 | { 23 | return _connection; 24 | } 25 | 26 | public void Dispose() 27 | { 28 | Dispose(true); 29 | GC.SuppressFinalize(this); 30 | } 31 | 32 | protected virtual void Dispose(bool disposing) 33 | { 34 | if (_disposed) 35 | return; 36 | 37 | if (disposing) 38 | _connection?.Close(); 39 | 40 | _disposed = true; 41 | } 42 | } 43 | } 44 | -------------------------------------------------------------------------------- /Plain.RabbitMQ/IConnectionProvider.cs: -------------------------------------------------------------------------------- 1 | using RabbitMQ.Client; 2 | using System; 3 | 4 | namespace Plain.RabbitMQ 5 | { 6 | public interface IConnectionProvider : IDisposable 7 | { 8 | IConnection GetConnection(); 9 | } 10 | } -------------------------------------------------------------------------------- /Plain.RabbitMQ/IPublisher.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | 4 | namespace Plain.RabbitMQ 5 | { 6 | public interface IPublisher : IDisposable 7 | { 8 | void Publish(string message, string routingKey, IDictionary messageAttributes, string timeToLive = null); 9 | } 10 | } -------------------------------------------------------------------------------- /Plain.RabbitMQ/ISubscriber.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.Threading.Tasks; 4 | 5 | namespace Plain.RabbitMQ 6 | { 7 | public interface ISubscriber : IDisposable 8 | { 9 | void Subscribe(Func, bool> callback); 10 | void SubscribeAsync(Func, Task> callback); 11 | } 12 | } -------------------------------------------------------------------------------- /Plain.RabbitMQ/Plain.RabbitMQ.csproj: -------------------------------------------------------------------------------- 1 |  2 | 3 | 4 | netcoreapp3.1 5 | 0.0.0.4 6 | Nirjhar Choudhury 7 | .Net Core Central 8 | RabbitMQ .Net Core Client 9 | A plain and simple wrapper around RabbitMQ.Client encapsulating the boilerplate code. 10 | 11 | https://dotnetcorecentral.com/ 12 | https://www.youtube.com/c/dotnetcorecentral 13 | https://github.com/choudhurynirjhar/plain-rabbitmq 14 | true 15 | false 16 | 17 | https://github.com/choudhurynirjhar/plain-rabbitmq 18 | 10/03/2020: Initial version 19 | 10/03/2020: Fix namespaces 20 | 10/03/2020: Fix issue with auto ack 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /Plain.RabbitMQ/Publisher.cs: -------------------------------------------------------------------------------- 1 | using RabbitMQ.Client; 2 | using System; 3 | using System.Collections.Generic; 4 | using System.Text; 5 | 6 | namespace Plain.RabbitMQ 7 | { 8 | public class Publisher : IPublisher 9 | { 10 | private readonly IConnectionProvider _connectionProvider; 11 | private readonly string _exchange; 12 | private readonly IModel _model; 13 | private bool _disposed; 14 | 15 | public Publisher(IConnectionProvider connectionProvider, string exchange, string exchangeType, int timeToLive = 30000) 16 | { 17 | _connectionProvider = connectionProvider; 18 | _exchange = exchange; 19 | _model = _connectionProvider.GetConnection().CreateModel(); 20 | var ttl = new Dictionary 21 | { 22 | {"x-message-ttl", timeToLive } 23 | }; 24 | _model.ExchangeDeclare(_exchange, exchangeType, arguments: ttl); 25 | } 26 | 27 | public void Publish(string message, string routingKey, IDictionary messageAttributes, string timeToLive = "30000") 28 | { 29 | var body = Encoding.UTF8.GetBytes(message); 30 | var properties = _model.CreateBasicProperties(); 31 | properties.Persistent = true; 32 | properties.Headers = messageAttributes; 33 | properties.Expiration = timeToLive; 34 | 35 | _model.BasicPublish(_exchange, routingKey, properties, body); 36 | } 37 | 38 | public void Dispose() 39 | { 40 | Dispose(true); 41 | GC.SuppressFinalize(this); 42 | } 43 | 44 | // Protected implementation of Dispose pattern. 45 | protected virtual void Dispose(bool disposing) 46 | { 47 | if (_disposed) 48 | return; 49 | 50 | if (disposing) 51 | _model?.Close(); 52 | 53 | _disposed = true; 54 | } 55 | } 56 | } -------------------------------------------------------------------------------- /Plain.RabbitMQ/Subscriber.cs: -------------------------------------------------------------------------------- 1 | using RabbitMQ.Client; 2 | using RabbitMQ.Client.Events; 3 | using System; 4 | using System.Collections.Generic; 5 | using System.Text; 6 | using System.Threading.Tasks; 7 | 8 | namespace Plain.RabbitMQ 9 | { 10 | public class Subscriber : ISubscriber 11 | { 12 | private readonly IConnectionProvider _connectionProvider; 13 | private readonly string _exchange; 14 | private readonly string _queue; 15 | private readonly IModel _model; 16 | private bool _disposed; 17 | 18 | public Subscriber( 19 | IConnectionProvider connectionProvider, 20 | string exchange, 21 | string queue, 22 | string routingKey, 23 | string exchangeType, 24 | int timeToLive = 30000, 25 | ushort prefetchSize = 10) 26 | { 27 | _connectionProvider = connectionProvider; 28 | _exchange = exchange; 29 | _queue = queue; 30 | _model = _connectionProvider.GetConnection().CreateModel(); 31 | var ttl = new Dictionary 32 | { 33 | {"x-message-ttl", timeToLive } 34 | }; 35 | _model.ExchangeDeclare(_exchange, exchangeType, arguments: ttl); 36 | _model.QueueDeclare(_queue, 37 | durable: true, 38 | exclusive: false, 39 | autoDelete: false, 40 | arguments: null); 41 | _model.QueueBind(_queue, _exchange, routingKey); 42 | _model.BasicQos(0, prefetchSize, false); 43 | } 44 | 45 | public void Subscribe(Func, bool> callback) 46 | { 47 | var consumer = new EventingBasicConsumer(_model); 48 | consumer.Received += (sender, e) => 49 | { 50 | var body = e.Body.ToArray(); 51 | var message = Encoding.UTF8.GetString(body); 52 | bool success = callback.Invoke(message, e.BasicProperties.Headers); 53 | if (success) 54 | { 55 | _model.BasicAck(e.DeliveryTag, true); 56 | } 57 | }; 58 | 59 | _model.BasicConsume(_queue, false, consumer); 60 | } 61 | 62 | public void SubscribeAsync(Func, Task> callback) 63 | { 64 | var consumer = new AsyncEventingBasicConsumer(_model); 65 | consumer.Received += async (sender, e) => 66 | { 67 | var body = e.Body.ToArray(); 68 | var message = Encoding.UTF8.GetString(body); 69 | bool success = await callback.Invoke(message, e.BasicProperties.Headers); 70 | if (success) 71 | { 72 | _model.BasicAck(e.DeliveryTag, true); 73 | } 74 | }; 75 | 76 | _model.BasicConsume(_queue, false, consumer); 77 | } 78 | 79 | public void Dispose() 80 | { 81 | Dispose(true); 82 | GC.SuppressFinalize(this); 83 | } 84 | 85 | // Protected implementation of Dispose pattern. 86 | protected virtual void Dispose(bool disposing) 87 | { 88 | if (_disposed) 89 | return; 90 | 91 | if (disposing) 92 | _model?.Close(); 93 | 94 | _disposed = true; 95 | } 96 | } 97 | } 98 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Plain Rabbitmq 2 | 3 | Plain Rabbitmq is a plain and simple wrapper around RabbitMQ.Client encapsulating the boilerplate code. 4 | 5 | ## Installation 6 | 7 | Use the Nuget package manager [Nuget](https://www.nuget.org/packages/Plain.RabbitMQ/) to install Plain.RabbitMQ 8 | 9 | ```bash 10 | Install-Package Plain.RabbitMQ -Version 0.0.0.4 11 | ``` 12 | 13 | ## Usage 14 | 15 | DI Registration 16 | 17 | ```csharp 18 | services.AddSingleton(new ConnectionProvider("Queue Url")); 19 | services.AddSingleton(x => new Subscriber(x.GetService(), 20 | "exchange name", 21 | "queue name", 22 | "routing key", 23 | ExchangeType.Topic)); 24 | services.AddScoped(x => new Publisher(x.GetService(), 25 | "exchange name", 26 | ExchangeType.Topic)); 27 | ``` 28 | 29 | Publisher 30 | 31 | ```csharp 32 | publisher.Publish(JsonConvert.SerializeObject(object), "routing key", headers); 33 | ``` 34 | 35 | Subscriber 36 | ```csharp 37 | subscriber.Subscribe((message, header) => { 38 | Console.WriteLine(message); 39 | return true; 40 | }); 41 | ``` 42 | 43 | Async Subscriber 44 | ```csharp 45 | subscriber.SubscribeAsync(async (message, header) => { 46 | Console.WriteLine(message); 47 | return await Task.FromResult(true); 48 | }); 49 | ``` 50 | 51 | Example video available in YouTube here: https://youtu.be/rUKqaO8IQCE 52 | 53 | ## Contributing 54 | Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. 55 | 56 | ## License 57 | [MIT](https://choosealicense.com/licenses/mit/) 58 | --------------------------------------------------------------------------------