Xer.Cqrs icon indicating copy to clipboard operation
Xer.Cqrs copied to clipboard

A lightweight and easy-to-use CQRS + DDD library

What is Xer.Cqrs?

Xer.Cqrs is a convenience package that contains all packages needed to build a CQRS write side with DDD concepts. It groups together other lightweight XerProjects libraries:

  • Domain Driven - contains Domain Driven Design (DDD) components/concepts.
  • Command Stack - contains components for handling commands.
  • Event Stack - contains components for handling events.

Build

Branch Status
Master Build status
Dev Build status

Table of contents

  • Overview
  • Features
  • Installation
  • Getting Started
    • Command Handling
    • Event Handling

Overview

Simple CQRS library

This project composes of components for implementing the CQRS pattern (Command Handling, Event Handling) with DDD concepts (Aggregate Roots, Entities, Value Objects, Domain Events). This library was built with simplicity, modularity and pluggability in mind.

Features

  • Send commands to registered command handlers.
  • Send events to registered event handlers.
  • Provides simple abstraction for hosted command/event handlers which can be registered just like a regular command/event handler.
  • Multiple ways of registering command/event handlers:
    • Simple handler registration (no IoC container).

    • IoC container registration

      • achieved by creating implementations of IContainerAdapter or using pre-made extensions pakcages for supported containers.
        • Microsoft.DependencyInjection

          NuGet

          See https://github.com/XerProjects/Xer.Cqrs.Extensions.Microsoft.DependencyInjection for source.

        • SimpleInjector

          NuGet

          See https://github.com/XerProjects/Xer.Cqrs.Extensions.SimpleInjector for source.

        • Autofac

          NuGet

          See https://github.com/XerProjects/Xer.Cqrs.Extensions.Autofac for source.

    • Attribute registration

      • achieved by marking methods with [CommandHandler] or [EventHandler] attributes from the Xer.Cqrs.CommandStack.Extensions.Attributes and Xer.Cqrs.EventStack.Extensions.Attributes packages.

        • Xer.Cqrs.CommandStack.Extensions.Attributes

          NuGet

          See https://github.com/XerProjects/Xer.Cqrs.CommandStack.Extensions.Attributes/ for source.

        • Xer.Cqrs.EventStack.Extensions.Attributes

          NuGet

          See https://github.com/XerProjects/Xer.Cqrs.EventStack.Extensions.Attributes/ for source.

Installation

You can simply clone this repository, build the source, reference the dll from the project, and code away!

Xer.Cqrs is available as a Nuget package:

  • NuGet

To install Nuget package:

  1. Open command prompt
  2. Go to project directory
  3. Add the packages to the project:
    dotnet add package Xer.Cqrs
    
  4. Restore the packages:
    dotnet restore
    

Getting Started

(Samples are in ASP.NET Core)

Command Handling

See https://github.com/XerProjects/Xer.Cqrs.CommandStack/blob/dev/README.md for documentation.

Event Handling

See https://github.com/XerProjects/Xer.Cqrs.EventStack/blob/dev/README.md for documentation.