RootBlocks 0.6.0

RootBlocks

RootBlocks is a set of .NET packages that provide the building blocks of Domain-Driven Design (DDD). It covers entities, aggregate roots, value objects, enumeration classes, domain events, a unit of work with an outbox, and persistence helpers for Entity Framework Core. You write the business rules and RootBlocks handles the repetitive parts.

public class Post : Entity< PostId >, IAggregateRoot
{
    public string Title { get; private set; }
    public DateTime? PublishedOn { get; private set; }

    public Post( string title ) : base( PostId.New() ) => Title = title;

    public void Publish()
    {
        PublishedOn = DateTime.UtcNow;
        AddDomainEvent( new PostPublished( Id ) );
    }
}

// In a command handler
var post = await posts.GetByIdAsync( postId, cancellationToken );
post.Publish();
unitOfWork.RegisterDirty( post );
await unitOfWork.CommitAsync( cancellationToken ); // saves, then publishes PostPublished

Packages

See Target frameworks for what each target means for your project.

Installation

Install the packages you need from NuGet:

dotnet add package RootBlocks
dotnet add package RootBlocks.Persistence.EntityFramework
dotnet add package RootBlocks.Messaging.MediatR
dotnet add package RootBlocks.Persistence.SqlClient   # or .Npgsql, .MySqlClient, .Oracle, .SQLite

RootBlocks does not ship an identifier type. Entity<T> accepts any T : IEquatable<T>, such as Guid, int or string. For strongly-typed IDs like PostId, use the separate StronglyTypedIdentifier library, which also provides the EF Core and ASP.NET Core integration for those IDs. The examples in these docs use it.

Documentation

• Getting started: build a working aggregate, from the domain model to the API, step by step.
• Core library
  • Domain model: entities, aggregate roots, value objects, enumerations, domain events and domain exceptions.
  • Utilities: pagination, extension methods, validation, retry and the other abstractions.
• Packages
  • Entity Framework persistence
  • Connection factory and database drivers
  • Messaging with MediatR
  • Serialization
  • Logging with Serilog
  • OpenAPI
• Configuration reference: every registration method and setting in one place.
• Target frameworks
• The Blogs sample: a full reference application.
• Contributing: building, testing, versioning and releasing.

Sample

samples/Blogs is a minimal API that uses every package together. It has three aggregates (Person, Blog, Post), MediatR commands, EF Core for writes and Dapper for reads. See the sample guide.

dotnet run --project samples/Blogs/src/Blogs.Api/

License

MIT © Sébastien de Salvador