The main idea of creating this project is implementing an infrastructure for up and running distributed system with the latest technology and architecture like Vertical Slice Architecture, Event Sourcing, CQRS, DDD, gRpc, MongoDB, RabbitMq, Masstransit in .Net, and we will not deal mainly with business. π
- The Goals of This Project
- Plan
- Technologies - Libraries
- The Domain and Bounded Context - Service Boundary
- Structure of Project
- How to Run
- Support
- Contribution
- Microservices based on
Domain Driven Design (DDD)
implementation. - Correct
separation of bounded contexts
for each microservice. - Communication between bounded contexts through asynchronous
MessageBus
andevents
. - Communication internally between our microservices with
gRPC
synchronously. - Simple
CQRS
implementation and Event Driven Architecture with usingSqlServer
inwrite side
andMongoDB
inread side
. I use aninternal processor
for syncingread side
andwrite side
without event sourcing. - Using
event store
to store all historical state of aggregate. (Booking-Microservice) - Using
Inbox Pattern
for guaranty message Idempotency for receiver microservice andExactly-once Delivery pattern
and usingOutbox Pattern
for ensuring about any messagelost and At-Least one Delivery
rule. - Implementing various types of testing like
Unit Testing
,Integration Testing
. - Using
Health Check
for reporting the health of app infrastructure components. - Using
Best Practice
andNew Technologies
andDesign Patterns
. - Using
Docker-Compose
andKubernetes
for our deployment mechanism.
πThis project is a work in progress, new features will be added over time.π
I will try to register future goals and additions in the Issues section of this repository.
High-level plan is represented in the table
Feature | Status |
---|---|
API Gateway | Completed βοΈ |
Identity Service | Completed βοΈ |
Flight Service | Completed βοΈ |
Passenger Service | Completed βοΈ |
Booking Service | Completed βοΈ |
Building Blocks | Completed βοΈ |
- βοΈ
.NET 6
- .NET Framework and .NET Core, including ASP.NET and ASP.NET Core - βοΈ
MVC Versioning API
- Set of libraries which add service API versioning to ASP.NET Web API, OData with ASP.NET Web API, and ASP.NET Core - βοΈ
EF Core
- Modern object-database mapper for .NET. It supports LINQ queries, change tracking, updates, and schema migrations - βοΈ
Masstransit
- Distributed Application Framework for .NET. - βοΈ
MediatR
- Simple, unambitious mediator implementation in .NET. - βοΈ
FluentValidation
- Popular .NET validation library for building strongly-typed validation rules - βοΈ
Swagger & Swagger UI
- Swagger tools for documenting API's built on ASP.NET Core - βοΈ
Serilog
- Simple .NET logging with fully-structured events - βοΈ
Polly
- Polly is a .NET resilience and transient-fault-handling library that allows developers to express policies such as Retry, Circuit Breaker, Timeout, Bulkhead Isolation, and Fallback in a fluent and thread-safe manner - βοΈ
Scrutor
- Assembly scanning and decoration extensions for Microsoft.Extensions.DependencyInjection - βοΈ
Opentelemetry-dotnet
- The OpenTelemetry .NET Client - βοΈ
DuendeSoftware IdentityServer
- The most flexible and standards-compliant OpenID Connect and OAuth 2.x framework for ASP.NET Core - βοΈ
EasyCaching
- Open source caching library that contains basic usages and some advanced usages of caching which can help us to handle caching more easier. - βοΈ
Mapster
- Convention-based object-object mapper in .NET. - βοΈ
Hellang.Middleware.ProblemDetails
- A middleware for handling exception in .Net Core - βοΈ
IdGen
- Twitter Snowflake-alike ID generator for .Net - βοΈ
Yarp
- Reverse proxy toolkit for building fast proxy servers in .NET - βοΈ
Tye
- Developer tool that makes developing, testing, and deploying microservices and distributed applications easier - βοΈ
gRPC-dotnet
- gRPC functionality for .NET. - βοΈ
EventStore
- The open-source, functional database with Complex Event Processing. - βοΈ
MongoDB.Driver
- .NET Driver for MongoDB. - βοΈ
xUnit.net
- A free, open source, community-focused unit testing tool for the .NET Framework. - βοΈ
Respawn
- Respawn is a small utility to help in resetting test databases to a clean state. - βοΈ
Mongo2Go
- Providing multiple, temporary and isolated MongoDB databases for unit tests (or to be precise: integration tests).
-
Identity Service
: The Identity Service is a bounded context for the authentication and authorization of users using Identity Server. This service is responsible for creating new users and their corresponding roles and permissions using .Net Core Identity and Jwt authentication and authorization. -
Flight Service
: The Flight Service is a bounded contextCRUD
service to handle flight related operations. -
Passenger Service
: The Passenger Service is a bounded context for managing passenger information, tracking activities and subscribing to get notification for out of stock products. -
Booking Service
: The Booking Service is a bounded context for managing all operation related to booking ticket.
In this project I used a mix of clean architecture, vertical slice architecture and I used feature folder structure to structure my files.
I used yarp reverse proxy to route synchronous and asynchronous requests to the corresponding microservice. Each microservice has its dependencies such as databases, files etc. Each microservice is decoupled from other microservices and developed and deployed separately. Microservices talk to each other with Rest or gRPC for synchronous calls and use RabbitMq or Kafka for asynchronous calls.
We have a separate microservice (IdentityServer) for authentication and authorization of each request. Once signed-in users are issued a JWT token. This token is used by other microservices to validate the user, read claims and allow access to authorized/role specific endpoints.
I used RabbitMQ as my MessageBroker for async communication between microservices using the eventual consistency mechanism. Each microservice uses MassTransit to interface with RabbitMQ providing, messaging, availability, reliability, etc.
Microservices are event based
which means they can publish and/or subscribe to any events occurring in the setup. By using this approach for communicating between services, each microservice does not need to know about the other services or handle errors occurred in other microservices.
After saving data in write side, I save a Internal Command record in my Persist Messages storage (like something we do in outbox pattern) and after committing transaction in write side, trigger our command handler in read side and this handler could save their read models in our MongoDB database.
I treat each request as a distinct use case or slice, encapsulating and grouping all concerns from front-end to back.
When adding or changing a feature in an application in n-tire architecture, we are typically touching many "layers" in an application. We are changing the user interface, adding fields to models, modifying validation, and so on. Instead of coupling across a layer, we couple vertically along a slice. We minimize coupling
between slices
, and maximize coupling
in a slice
.
With this approach, each of our vertical slices can decide for itself how to best fulfill the request. New features only add code, we're not changing shared code and worrying about side effects.
Instead of grouping related action methods in one controller, as found in traditional ASP.net controllers, I used the REPR pattern. Each action gets its own small endpoint, consisting of a route, the action, and an IMediator
instance (see MediatR). The request is passed to the IMediator
instance, routed through a Mediatr pipeline
where custom middleware can log, validate and intercept requests. The request is then handled by a request specific IRequestHandler
which performs business logic before returning the result.
The use of the mediator pattern in my controllers creates clean and thin controllers. By separating action logic into individual handlers we support the Single Responsibility Principle and Don't Repeat Yourself principles, this is because traditional controllers tend to become bloated with large action methods and several injected Services
only being used by a few methods.
I used CQRS to decompose my features into small parts that makes our application:
- Maximize performance, scalability and simplicity.
- Easy to maintain and add features to. Changes only affect one command or query, avoiding breaking changes or creating side effects.
- It gives us better separation of concerns and cross-cutting concern (with help of mediatr behavior pipelines), instead of bloated service classes doing many things.
Using the CQRS pattern, we cut each business functionality into vertical slices, for each of these slices we group classes (see technical folders structure) specific to that feature together (command, handlers, infrastructure, repository, controllers, etc). In our CQRS pattern each command/query handler is a separate slice. This is where you can reduce coupling between layers. Each handler can be a separated code unit, even copy/pasted. Thanks to that, we can tune down the specific method to not follow general conventions (e.g. use custom SQL query or even different storage). In a traditional layered architecture, when we change the core generic mechanism in one layer, it can impact all methods.
Run the following commands for Config SSL in your system
dotnet dev-certs https -ep %USERPROFILE%\.aspnet\https\aspnetapp.pfx -p {password here}
dotnet dev-certs https --trust
Note: for running this command in
powershell
use$env:USERPROFILE
instead of%USERPROFILE%
Run this app in docker using the docker-compose.yaml file with the below command at the root of the application:
docker-compose -f ./deployments/docker-compose/docker-compose.yaml up -d
Also we have a seprate docker file for up and running infrastracture.yaml independently:
docker-compose -f ./deployments/docker-compose/infrastracture.yaml up -d
Each microservice uses swagger open api, navigate to /swagger for a list of every endpoint. For testing apis I used the REST Client plugin for VSCode running this file booking.rest.
If you like my work, feel free to:
- β this repository. And we will be happy together :)
Thanks a bunch for supporting me!
Thanks to all contributors, you're awesome and this wouldn't be possible without you! The goal is to build a categorized community-driven collection of very well-known resources.
- https://github.com/jbogard/ContosoUniversityDotNetCore-Pages
- https://github.com/kgrzybek/modular-monolith-with-ddd
- https://github.com/oskardudycz/EventSourcing.NetCore
- https://github.com/thangchung/clean-architecture-dotnet
- https://github.com/jasontaylordev/CleanArchitecture
- https://github.com/pdevito3/MessageBusTestingInMemHarness
- https://github.com/devmentors/FeedR
This project is made available under the MIT license. See LICENSE for details.