Skip to content
Event Sourcing, CQRS and DDD framework for C#/.NET Core.
C# Other
  1. C# 98.7%
  2. Other 1.3%
Branch: develop
Clone or download

Latest commit

Latest commit 0d58d86 Mar 22, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Examples/Todos updated Revo.Examples.Todos sample app Mar 21, 2020
Extensions removed APNS and FCM (push notification) channel support from Revo.Ex… Feb 4, 2020
Providers better help text in DatabaseMigrator & removed redundant using clauses Mar 19, 2020
Revo.Core fixed: event version parsed from types whose name ends with V letter … Feb 9, 2020
Revo.DataAccess added IReadRepository.GetManyAsync and FindManyAsync Feb 26, 2020
Revo.Domain -breaking change: null tenants now cannot access other tenant's data … Mar 19, 2020
Revo.Infrastructure -breaking change: null tenants now cannot access other tenant's data … Mar 19, 2020
Revo.Testing EventExtensions for testing now also adds dates to metadata Aug 30, 2019
Tests -breaking change: null tenants now cannot access other tenant's data … Mar 19, 2020
Tools/Revo.Tools.DatabaseMigrator better help text in DatabaseMigrator & removed redundant using clauses Mar 19, 2020
res updated .csproj NuGet information Jul 14, 2018
.gitignore added standalone database migration tool Revo.Tools.DatabaseMigrator … Nov 6, 2019
Common.props future version 1.16.0 Mar 19, 2020
LICENSE added license May 5, 2018
NuGet.config replaced System.Collections.Generic.MultiValueDictionary with own imp… Jul 16, 2018
README.md Update README.md Mar 22, 2020
RELEASE_NOTES.md updated Revo.Examples.Todos sample app Mar 21, 2020
Revo.sln removed APNS and FCM (push notification) channel support from Revo.Ex… Feb 4, 2020
Revo.sln.DotSettings updated Revo.Examples.Todos sample app Mar 21, 2020
appveyor.yml fixed Cake script being unable to download packages.config due to a T… Aug 12, 2019
build.cake Cake script now uses VS2019 build toolset Aug 9, 2019
build.ps1 added standalone database migration tool Revo.Tools.DatabaseMigrator … Nov 6, 2019
build.sh added standalone database migration tool Revo.Tools.DatabaseMigrator … Nov 6, 2019

README.md

Revo framework

Build status NuGet package version Docs GitHub issues Contributions License

Revo Framework

Revo is an application framework for modern server C#/.NET applications built with event sourcing, CQRS and DDD.

Table of contents

Features

The framework combines the concepts of event sourcing, CQRS and DDD to provide support for building applications that are scalable, maintainable, can work in distributed environments and are easy to integrate with outside world. As such, it takes some rather opinionated approaches on the design of certain parts of its architecture. Revo also offers other common features and infrastructure that is often necessary for building complete applications – for example, authorizations, validations, messaging, integrations, multi-tenancy or testing. Furthermore, its extensions implement other useful features like entity history change-tracking, auditing or user notifications.

Domain-Driven Design
Building blocks for rich DDD-style domain models (aggregates, entities, value objects, domain events, repositories...).

Event Sourcing
Implementing event-sourced entity persistence with support for multiple event store backends (PostgreSQL, MSSQL, SQLite...).

CQRS
Segregating command and query responsibilities with:

A/synchronous event processing
Support for both synchronous and asynchronous event processing, guaranteed at-least-once delivery, event queues with strict sequence ordering (optionally), event source catch-ups, optional pseudo-synchronous event dispatch for listeners (projectors, for example).

Data access
Thin abstraction layer for easy data persistence (e.g. querying read models) using Entity Framework Core, Entity Framework 6, RavenDB, testable in-memory database or other data providers. Includes support for simple database migrations.

Projections
Support for read-model projections with various backends (e.g. Entity Framework Core (PostgreSQL, MSSQL, SQLite,...), Entity Framework 6, RavenDB...), automatic idempotency- and concurrency-handling, etc.

SOA, messaging and integration
Scale and integrate by publishing and receiving events, commands and queries using common messaging patterns,
e.g. with RabbitMQ message queue (using EasyNetQ connector or Rebus service bus).

Sagas
Coordinating long-running processes or inter-aggregate cooperation with sagas that react to events
(a.k.a. process managers).

Authorization
Basic permission/role-based ACL for commands and queries, fine-grained row filtering.

Other minor features:

Show me how it looks!

Super-short example of a simple application that can save tasks using event-sourced aggregates and then query them back from a RDBMS.

Event

The event that happens when changing a task's name.

public class TodoRenamedEvent : DomainAggregateEvent
{
    public TodoRenamedEvent(string name)
    {
        Name = name;
    }

    public string Name { get; }
}

Aggregate

The task aggregate root.

public class Todo : EventSourcedAggregateRoot
{
    public Todo(Guid id, string name) : base(id)
    {
        Rename(name);
    }
    
    protected Todo(Guid id) : base(id)
    {
    }
    
    public string Name { get; private set; }
    
    public void Rename(string name)
    {
        if (!Name != name)
        {
            Publish(new TodoRenamedEvent(name));
        }
    }
    
    private void Apply(TodoRenamedEvent ev)
    {
        Name = ev.Name;
    }
}

Command and command handler

Command to save a new task.

public class CreateTodoCommand : ICommand
{
    public CreateTodoCommand(string name)
    {
        Name = name;
    }

    [Required]
    public string Name { get; }
}
public class TodoCommandHandler : ICommandHandler<CreateTodoCommand>
{
    private readonly IRepository repository;
    
    public TodoCommandHandler(IRepository repository)
    {
        this.repository = repository;
    }
    
    public Task HandleAsync(CreateTodoCommand command, CancellationToken cancellationToken)
    {
        var todo = new Todo(command.Id);
        todo.Rename(command.Name);
        repository.Add(todoList);
        return Task.CompletedTask;
    }   
}

Read model and projection

Read model and a projection for the event-sourced aggregate.

public class TodoReadModel : EntityReadModel
{
    public string Name { get; set; }
}
public class TodoListReadModelProjector : EFCoreEntityEventToPocoProjector<Todo, TodoReadModel>
{
    public TodoListReadModelProjector(IEFCoreCrudRepository repository) : base(repository)
    {
    }
    
    private void Apply(IEventMessage<TodoRenamedEvent> ev)
    {
        Target.Name = ev.Event.Name;
    }
}

Query and query handler

Query to read the tasks back from a RDBMS.

public class GetTodosQuery : IQuery<IQueryable<TodoReadModel>>
{
}
public class TaskQueryHandler : IQueryHandler<GetTodoQuery, IQueryable<TodoReadModel>>
{
    private readonly IReadRepository readRepository;
    
    public TaskListQueryHandler(IReadRepository readRepository)
    {
        this.readRepository = readRepository;
    }
    
    public Task<IQueryable<TodoReadModel>> HandleAsync(GetTodoListsQuery query, CancellationToken cancellationToken)
    {
        return Task.FromResult(readRepository
            .FindAll<TodoListReadModel>());
    }
}

Getting started

If you are new to the framework, you can

You can also start by reading the reference guide.

Binaries

Binaries are up for grabs in form of NuGet packages:

Core
Revo.Core NuGet package version
Revo.DataAccess NuGet package version
Revo.Domain NuGet package version
Revo.Infrastructure NuGet package version
Revo.Testing NuGet package version
Data access
Revo.EFCore NuGet package version
Revo.EF6 NuGet package version
Revo.RavenDB NuGet package version
Platforms
Revo.AspNetCore NuGet package version
Revo.AspNet NuGet package version
Revo.Hangfire NuGet package version
Integrations
Revo.EasyNetQ (RabbitMQ connector) NuGet package version
Revo.Rebus (service bus, deprecated) NuGet package version
Other extensions
Revo.Extensions.History NuGet package version
Revo.Extensions.Notifications NuGet package version

Most applications will require at least Revo.Core, Revo.DataAccess, Revo.Domain, Revo.Infrastructure packages to get started with and then typically a platform package like Revo.Platforms.AspNetCore (ASP.NET Core platform implementation) and a data-access package like Revo.EFCore (for Entity Framework Core support).

Requirements

The framework is written in C# 7.1 and targets the .NET Standard 2.0 specification; some of its modules currently also use .NET Core 2.1 (ASP.NET Core) or .NET Framework 4.7.1 where needed (e.g. Entity Framework 6 support). Revo also makes a heavy use of the C# async/await pattern and uses the TAP (Task Asynchronous Pattern) throughout its entire codebase (i.e. async all the way).

License

MIT License

Copyright (c) 2017-2018 Martin Zima
Copyright (c) 2017-2018 ASP a.s.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH > THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

You can’t perform that action at this time.