Behaviors

Henk Mollema edited this page Jan 10, 2017 · 2 revisions
Clone this wiki locally

New in MediatR 3.0 are behaviors, which allow you to build your own pipeline directly inside of MediatR without resolving to using decorators around your handlers. It's a more natural way to enhance your handlers with behavior and better supported in containers.

A pipeline behavior is an implementation of IPipelineBehavior<TRequest, TResponse>. It represents a similar pattern to filters in ASP.NET MVC/Web API or pipeline behaviors in NServiceBus. Your pipeline behavior needs to implement one method:

Task<TResponse> Handle(TRequest request, RequestHandlerDelegate<TResponse> next);

The request parameter is the request object passed in through IMediator.Send, while the next parameter is an async continuation for the next action in the behavior chain. In your behavior, you'll need to await or return the invocation of the next delegate. A simple example:

public class LoggingBehavior<TRequest, TResponse> : IPipelineBehavior<TRequest, TResponse> {
    public async Task<TResponse> Handle(TRequest request, RequestHandlerDelegate<TResponse> next) {
        await Logger.InfoAsync($"Handling {typeof(TRequest).Name}");
        var response = await next();
        await Logger.InfoAsync($"Handled {typeof(TResponse).Name}");
        return response;
    }
}

Because the next delegate does not accept the TRequest as a parameter, you can mutate the incoming request but cannot replace it.

Registering pipeline behaviors

Most containers support registering multiple instances of a type. StructureMap for example will allow you to register open generic (and constrained) implementations:

cfg.For(typeof(IPipelineBehavior<,>)).Add(typeof(OuterBehavior<,>));
cfg.For(typeof(IPipelineBehavior<,>)).Add(typeof(InnerBehavior<,>));
cfg.For(typeof(IPipelineBehavior<,>)).Add(typeof(ConstrainedBehavior<,>));

Just register the behaviors in the order you would like them to be called. MediatR uses the MultiInstanceFactory delegate to resolve the IEnumerable<IPipelineBehavior<TRequest, TResponse>> for whatever closed types your request and responses are. For void/Task requests, the TResponse type will be Unit.

Built-in behaviors

To ease development, two built-in behaviors exist: request pre- and post-processors. You can find these in the MediatR.Pipeline namespace, and will need to be explicitly registered with your container.

Additionally, any IRequestPreProcessor and IRequestPostProcessor will need to be registered with the container.