MicroBus is a simple in process Mediator for .NET
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
build
src Improved error handling when Handler returns null instead if Task Jun 23, 2018
.gitattributes
.gitignore
Contribute.md
Enexure.MicroBus.sln
Enexure.MicroBus.sln.DotSettings Upgrade from project.json to csproj Apr 23, 2017
License.md
Logo.Big.png
Logo.Source.png
Logo.png
Readme.md doc (readme) - Syntax highlighting Mar 6, 2017
appveyor.yml
build.bat Ensure the build fails if the PSake script fails Jun 28, 2016
text.settings.json

Readme.md

Enexure.MicroBus

Build status

MicroBus is a simple in process mediator for .NET

PM> Install-Package Enexure.MicroBus.Autofac

I wanted a super simple mediator with great support for global handlers. With MicroBus message handlers and global handlers are first class citizens making it easy to get started.

Registering a set of handlers takes a few just lines of code and is fairly terse.

    var busBuilder = new BusBuilder()
        
        // Global Handlers run in order so these are explicitly registered
        .RegisterGlobalHandler<LoggingHandler>()
        .RegisterGlobalHandler<SecurityHandler>()
        .RegisterGlobalHandler<ValidationHandler>()
        .RegisterGlobalHandler<TransactionHandler>()
        
        // Scan an assembly to find all the handlers
        .RegisterHandlers(assembly);

Once your registrations are sorted out then it's just a matter of adding MicroBus to your DI container. Here is now we register MicroBus to Autofac.

    autofacContainerBuilder.RegisterMicroBus(busBuilder);

MicroBus has two main interfaces, the bus and the mediator. A bus will work with the message types, commands, events and queries(request/response). This imposes a strong set of rules around what a message can do. For example you can only have at most one handler for a query or command.

    given(IMicroBus bus)
    
    bus.SendAsync(new TestCommand());  // ICommand
    bus.QueryAsync(new TestQuery());   // IQuery<Query, Result>
    bus.PublishAsync(new TestEvent()); // IEvent

The other is the mediator which is more general. Messages can be anything and don't need to implement any specific interface. This can be useful when interfacing with existing message contracts.

     given(IMicroMediator mediator)
     
     mediator.SendAsync(anyObject);
     mediator.QueryAsync(anyObject);
     mediator.PublishAsync(anyObject);

Commands are the typical entry point for an application. A command is something that you ask the system to do. For example, create a new page the the name of a command is always in the imperative tense. Commands are also interesting in that they don't return anything. In our create a page example you would say create the page "home" or create an object that I can refer to with this Guid instead of create a page and return the Id. The great part about this is you already know what the Id of the resource is going to be.

    class TestCommand : ICommand { }
    
    class TestCommandHandler : ICommandHandler<TestCommand>
    {
        public async Task Handle(TestCommand command)
        {
            Console.WriteLine("Test command handler");
        }
    }

One of the most important things an application needs is a way to deal with cross cutting concerns. In MicroBus this is where global handlers come in. They provide a great way to do work before messages get to the handlers. They also use the nested Russian Doll style approach so each handler will internally call the next handler or handler in the chain.

    public class CrossCuttingHandler : IDelegatingHandler
    {
        public async Task<object> Handle(INextHandler next, object message)
        {
            using (var transaction = unitOfWork.NewTransaction()) {
                return await next.Handle(message);
            }
        }
    }

Currently MicroBus only comes with built in support for Autofac.

For more examples check out the Enexure.MicroBus.Tests project or this sample WebApi project.