I recently wrote a blog post introducing some of my favourite NuGet packages: . In that post, I briefly introduced a package called MediatR. Today, I will dedicate this post to revisiting MediatR in further detail. My Top 4 NuGet Packages for ASP.NET Core What is MediatR? MediatR is an implementation of the mediator pattern. It is a behavioural software design pattern that helps you to build simpler code by making all components communicate via a "mediator" object, instead of directly with each other. This helps the code to remain highly decoupled and reduces the number of complex dependencies between objects. A good real-world example of the mediator pattern is the air-traffic control (ATC) tower at airports. If every plane had to directly communicate with every other plane, it would be chaos. Instead, they all report to the ATC tower, and the tower decides how to relay those messages to other aircraft. In this, scenario the ATC tower is the mediator object. Using the MediatR package, one sends some data as an object to the mediator object. Depending on the type of data that is sent to the mediator object, it decides which other objects/services to call. MediatR handles two forms of message: Requests - can only send messages to one other object/service. Can return the result from that object/service to the original caller. Notifications - can send messages to multiple objects/services. Cannot receive any data back. Settting up MediatR To get MediatR, install the MediatR package from NuGet. If you are using ASP NET Core, you should also install the MediatR.Extensions.Microsoft.DependencyInjection, which provides an easy way to register all of the MediaR services: { services.AddMediatR( (Startup));
} // Startup.cs ( ) public void ConfigureServices IServiceCollection services // other services typeof If you are using a different method of dependency injection, please on how to configure MediatR for your container. check the wiki Sending Requests To send a request, you need to create two objects: a request and a request handler. The request object should implement the IRequest or IRequest<TResponse> interfaces, depending on whether or not you want to return any data. The request object should consist of any data that you want to send to the handler. : < >
{ A { ; ; } B { ; ; }
} public class AdditionRequest IRequest int public int get set public int get set The request handler should implement the IRequestHandler<TRequest> or IRequestHandler<TRequest, TResponse> interfaces, where TRequest is the request object that you just created. : < , >
{ { result = request.A + request.B; Task.FromResult(result);
    }
} public class AdditionRequestHandler IRequestHandler AdditionRequest int Task< > ( ) public int Handle AdditionRequest request, CancellationToken cancellationToken var return To then send the request via MediatR, one must use the Send method on the IMediator instance, passing in an instance of AdditionRequest. { IMediator _mediator; {
        _mediator = mediator;
    } { request = AdditionRequest { A = a, B = b }; result = _mediator.Send(request); result;
    }
} public class MyCalculator private readonly ( ) public MyCalculator IMediator mediator Task< > ( ) public async int Add a, b int int var new var await return Note that if you choose not to return anything from a request handler, MediatR actually has a special 'nothing' value that you must return instead, called Unit. : { } : < >
{ { Task.FromResult(Unit.Value);
    }
} public class MyRequest IRequest // some properties public class MyRequestHandler IRequestHandler MyRequest Task<Unit> ( ) public Handle MyRequest request, CancellationToken cancellationToken // do stuff return Sending Notifications Sending notifications is very similar to sending requests, in that a notification object and a notification handler object must be created. The difference here is that multiple notification handler objects can be created, which will all be called when a notification is sent to MediatR. : { } : < >
{ { Task.CompletedTask;
    }
} : < >
{ { Task.CompletedTask;
    }
} public class MyNotification INotification // some properties public class MyNotificationHandler1 INotificationHandler MyNotification Task ( ) public Handle MyNotification notification, CancellationToken cancellationToken // do stuff return public class MyNotificationHandler2 INotificationHandler MyNotification Task ( ) public Handle MyNotification notification, CancellationToken cancellationToken // do stuff return Then to actually send the notification, call the the Publish method on the IMediator instance, passing in an instance of your notification object. When Publish is called, both MyNotificationHandler1 and MyNotificationHandler2 will be executed. { IMediator _mediator; {
        _mediator = mediator;
    } { notification = MyNotification
        { }; _mediator.Publish(notification);
    }
} public class MyService private readonly ( ) public MyService IMediator mediator Task ( ) public async Execute var new // initialise await Pipeline Behaviours Pipeline behaviours are a type of middleware that get executed before and after a request (only supports requests, not notifications). They can be useful for a number of different tasks, such as logging, error handling, request validation etc. These behaviours work in the same way that you would expect for middleware: you can chain multiple behaviours together, each behaviour gets executed in turn until it reaches the end of the chain, then the actual request handler is executed, then the result of this is passed back up the chain. For example, a LoggingBehaviour could write to the application log before and after each request: < , > : < , >
{ ILogger<LoggingBehavior<TRequest, TResponse>> _logger; {
        _logger = logger;
    } {
        _logger.LogInformation( ); response = next();

        _logger.LogInformation( ); response;
    }
} public class LoggingBehavior TRequest TResponse IPipelineBehavior TRequest TResponse private readonly ( ) public LoggingBehavior ILogger<LoggingBehavior<TRequest, TResponse>> logger Task<TResponse> ( ) public async Handle TRequest request, CancellationToken cancellationToken, RequestHandlerDelegate<TResponse> next $"Handling " { (TRequest).Name} typeof // go to the next behaviour in the chain/to the request handler var await $"Handled " { (TResponse).Name} typeof return In ASP NET Core, to register each PipelineBehaviour with the IoC container, add the following line to the ConfigureServices method of the the Startup class: services.AddTransient( (IPipelineBehavior<,>), (LoggingBehaviour<,>)); typeof typeof For other containers, . check the wiki Conclusion In this article, I have introduced the mediator pattern and the NuGet package MediatR, which itself is an implementation of the mediator pattern. I have showed you how to send both requests (one-to-one) and notifications (one-to-many), as well as how to write middleware (pipeline behaviours) that gets executed before/after each request. "Ten++ Ways to Make Money as a Developer" eBook I post mostly about full stack .NET and Vue web development. To make sure that you don't miss out on any posts, please follow this blog and . If you found this post helpful, please like it and share it. You can also . subscribe to my newsletter find me on Twitter

Chain

Microsoft

Twitter

Don't Get Bitten by Hidden Bugs: Test Driven Development (TDD) and AAA Testing via xUnit

A Guide to Running ASP.NET Core & SQL Server from Docker

Subscribe to my mailing list

Nominated for 2022 - HackerNoon Contributor of the Year - Es6

Nominated for 2022 - HackerNoon Contributor of the Year - Clean Code

Nominated for 2022 - HackerNoon Contributor of the Year - Dotnet

Nominated for 2022 - HackerNoon Contributor of the Year - Functional Programming

Too Long; Didn't Read

How To Write Decoupled Code with MediatR: The Mediator Pattern

How To Write Decoupled Code with MediatR: The Mediator Pattern

About Author

Comments

TOPICS

THIS ARTICLE WAS FEATURED IN

Related Stories

3 Tips to Improve Your Mental Health as a Developer

C# 8.0 Indices and Ranges

5 Tips to Improve Your Productivity in C# 8.0

7 things you didn’t know about .NET code

A Guide to Running ASP.NET Core & SQL Server from Docker

A Guide to Using Scoped Services Inside Singletons

3 Tips to Improve Your Mental Health as a Developer

C# 8.0 Indices and Ranges

5 Tips to Improve Your Productivity in C# 8.0

7 things you didn’t know about .NET code

A Guide to Running ASP.NET Core & SQL Server from Docker

A Guide to Using Scoped Services Inside Singletons

Light-Mode

Classic

Newspaper

Minty

Dark-Mode

Neon Noir

Minty

HN StartUps