dotnet-cqrs/README.md

This project was originally initiated by Powered Software Inc. and was forked from the PoweredSoft.CQRS Repository

CQRS

Our implementation of query and command responsibility segregation (CQRS).

Getting Started

Install nuget package to your awesome project.

Full Version	NuGet	NuGet Install
OpenHarbor.CQRS		PM> Install-Package OpenHarbor.CQRS
OpenHarbor.CQRS.AspNetCore		PM> Install-Package OpenHarbor.CQRS.AspNetCore
OpenHarbor.CQRS.FluentValidation		PM> Install-Package OpenHarbor.CQRS.FluentValidation
OpenHarbor.CQRS.DynamicQuery		PM> Install-Package OpenHarbor.CQRS.DynamicQuery
OpenHarbor.CQRS.DynamicQuery.AspNetCore		PM> Install-Package OpenHarbor.CQRS.DynamicQuery.AspNetCore

Abstractions Packages.

Full Version	NuGet	NuGet Install
OpenHarbor.CQRS.Abstractions		PM> Install-Package OpenHarbor.CQRS.Abstractions
OpenHarbor.CQRS.AspNetCore.Abstractions		PM> Install-Package OpenHarbor.CQRS.AspNetCore.Abstractions
OpenHarbor.CQRS.DynamicQuery.Abstractions		PM> Install-Package OpenHarbor.CQRS.AspNetCore.Abstractions

Sample of startup code for aspnetcore MVC

public void ConfigureServices(IServiceCollection services)
{
    // make sure to add your queries and commands before the .AddPoweredSoftQueries and .AddPoweredSoftCommands
    AddQueries(services);
    AddCommands(services);

    // adds the non related to aspnet core features.
    services.AddOpenHarborCQRS();
    
    services
        .AddControllers()
        .AddOpenHarborQueries() // adds queries to aspnetcore mvc.(you can make it configurable to load balance only commands on a instance)
        .AddOpenHarborCommands() // adds commands to aspnetcore mvc. (you can make it configurable to load balance only commands on a instance)
        .AddFluentValidation();

    services.AddSwaggerGen();
}

Example how to add your queries and commands.

private void AddCommands(IServiceCollection services)
{
    services.AddCommand<CreatePersonCommand, CreatePersonCommandHandler>();
    services.AddTransient<IValidator<CreatePersonCommand>, CreatePersonCommandValidator>();

    services.AddCommand<EchoCommand, string, EchoCommandHandler>();
    services.AddTransient<IValidator<EchoCommand>, EchoCommandValidator>();
}

private void AddQueries(IServiceCollection services)
{
    services.AddQuery<PersonQuery, IQueryable<Person>, PersonQueryHandler>();
}

Fluent Validation

We use fluent validation in all of our projects, but we don't want it to be enforced.

If you install. PoweredSoft.CQRS.FluentValidation you can use this way of registrating your commands.

public void ConfigureServices(IServiceCollection services) 
{
    // without Package.
    services.AddCommand<EchoCommand, string, EchoCommandHandler>();
    services.AddTransient<IValidator<EchoCommand>, EchoCommandValidator>();
}

public void ConfigureServices(IServiceCollection services) 
{
    // with PoweredSoft.CQRS.FluentValidation package.
    services.AddCommandWithValidator<EchoCommand, string, EchoCommandHandler, EchoCommandValidator>();
}