FreeMediator 1.4.2

FreeMediator

FreeMediator is a free and open-source alternative to the popular MediatR package by Jimmy Bogard.

• It strives to be a drop-in replacement for MediatR, with the same API and functionality, and is created purely on the background of MediatR going commercial.
• It is not a fork of MediatR, but rather a new implementation that aims to be as compatible as possible with the original. Let me know in the Issues section if you find any incompatibilities.

As such the first version only deals with the basic stuff:

• Sending requests and receiving responses
• Pipeline behavior support for requests (both open and closed behaviors)
• Publishing notifications
• Generic request handlers of same arity as IRequestHandler<>, IRequestHandler<,>, IRequestHandler<,FIXED_TYPE> or IRequestHandler<FIXED_TYPE,> (the last two being partial arity match, check changelog v.1.2.0 for details)
• Generic notification handlers of same arity as INotificationHandler<>

Feel free to send a PR if you want to add any missing features, (make sure to read CONTRIBUTING.md first).

OR just open an Issue for missing features, and I'll have a look.

Features outside of the original MediatR

• Pipeline behavior support for notifications (both open and closed behaviors)

Current limitations

• No support for streaming
• No support for implementing multiple handlers in a single class if they have the same return type

Usage

FreeMediator is intended to be used with .Net Dependency Injection, so start off by adding it to your DI:

services.AddMediator(config => 
{
    config.RegisterServicesFromAssemblyContaining<SomeRequest>(); // There are other ways to register services as well
});

This will scan the assembly containing SomeRequest for all classes implementing IRequestHandler<TRequest, TResponse> and INotificationHandler<TNotification> and register them with the DI container.

It also registers the IMediator interface itself (as well as a ISender and IPublisher interface, which are both subsets of IMediator).

From here on simply inject IMediator (or ISender/IPublisher) into your classes and use it to send requests or publish notifications:

public class SomeService
{
    private readonly IMediator _mediator;

    public SomeService(IMediator mediator
    {
        _mediator = mediator;
    }

    public async Task<SomeResponse> DoSomethingAsync(CancellationToken cancellationToken)
    {
        var response = await _sender.Send(new SomeRequest(), cancellationToken);
        return response;
    }
}

Migrating from MediatR

These are the most common things you'll need to do, when migrating from MediatR to FreeMediator:

• Replace PackageReference to MediatR with PackageReference to FreeMediator

• Search'n'Replace "AddMediatR" with "AddMediator"

• Search'n'Replace "using MediatR;" with "using FreeMediator;"

• Search'n'Replace "MediatRServiceConfiguration" with "IMediatorConfiguration"

• Search for .TypeEvaluator = XYZ and replace it with .IgnoreServices(!XYZ) IMPORTANT take notice that IgnoreServices is the exact opposite of TypeEvaluator, meaning whatever you did before you want to inverse now. This is because TypeEvaluator is a whitelist, and IgnoreServices is a blacklist.

• You may need to add generic constraints to your IPipelineBehaviors, your IDE will point you in the right direction

• If you implement multiple IRequestHandlers on a single class, you probably have to split those into a single class per request to handle. Your IDE will point you in the right direction

• If you have any sealed generic requesthandlers, you'll need to unseal them and make sure they're somewhat visible (e.g. internal). This is necessary because FreeMediator wraps these using inheritance, for DI with generics to work. You should receive an Exception explaning this as well, if you fall into this category.

Changelog

See the CHANGELOG for a list of changes and new features.

Documentation

Auto generated documentation via DocFx is available here: https://steffenskov.github.io/FreeMediator/