This content originally appeared on DEV Community and was authored by Anton Martyniuk
Clean Architecture aims to separate the concerns of the application into distinct layers, promoting high cohesion and low coupling.
Vertical Slice Architecture (VSA) is a design approach that structures an application by features rather than technical layers.
Each slice encapsulates all aspects of a specific feature, including the UI, business logic, and data access.
This approach contrasts with traditional architectures that typically segregate an application into horizontal layers.
In this blog post you will learn the benefits of both architecture styles and how you can combine them to create an even better architecture.
On my website: antondevtips.com I share .NET and Architecture best practices.
Subscribe to become a better developer.
Download the source code for this blog post for free.
Clean Architecture
Clean Architecture aims to separate the concerns of the application into distinct layers, promoting high cohesion and low coupling.
It consists of the following layers:
- Domain: contains core business objects such as entities.
- Application Layer: implementation of Application use cases.
- Infrastructure: implementation of external dependencies like database, cache, message queue, authentication provider, etc.
- Presentation: implementation of an interface with the outside world like WebApi, gRPC, GraphQL, MVC, etc.
Clean Architecture has the following advantages:
Separation of Concerns: Clean Architecture enforces a clear separation between different layers of the application, such as the UI, business logic, and data access.
This separation allows each layer to focus on its specific responsibility, making the codebase more maintainable and understandable.Testability: By isolating the business logic from the infrastructure and UI, Clean Architecture makes it easier to write unit tests.
The core of the application (the use cases and entities) can be tested without worrying about external dependencies.Flexibility: Clean Architecture allows you to change the technology stack (e.g., switching from one database provider to another) with minimal impact on the core business logic.
This flexibility is achieved by abstracting infrastructure concerns behind interfaces that the core application depends on.Code Reusability: By decoupling the core business logic from the implementation details, Clean Architecture encourages code reusability across different projects or layers within the same project.
Long-term Adaptability: Clean Architecture is designed to withstand changes in technology or business requirements.
By keeping the business logic independent of external factors, the architecture remains adaptable over time.
Every architectural style is a tradeoff that comes with benefits and drawbacks.
Here are the drawbacks of Clean Architecture:
Complexity: Clean Architecture introduces multiple layers and abstractions, which can increase the complexity of the codebase, especially for small projects.
Developers may find it overwhelming if the architecture is applied unnecessarily to simple applications.Overhead: The separation of concerns and the use of interfaces can lead to additional boilerplate code, which might slow down the development process.
This overhead can be particularly noticeable in smaller projects where the benefits of Clean Architecture may not be as noticeable.Learning Curve: For developers who are not familiar with Clean Architecture, there is a steep learning curve.
Understanding the principles and correctly applying them can take time, especially for those new to software architecture patterns.Initial Setup Time: Setting up a Clean Architecture project from scratch requires careful planning and organization.
The initial setup time can be longer compared to more straightforward architectural approaches.
Vertical Slice Architecture
Vertical Slice Architecture is an extremely popular way to structure your projects nowadays.
It strives for high cohesion within a slice (feature) and loose coupling between slices.
It structures an application by features rather than technical layers.
Each slice encapsulates all aspects of a specific feature, including the UI, business logic, and data access.
VSA has the following advantages:
- Feature Focused: changes are isolated to specific features, reducing the risk of unintended side effects.
- Scalability: easier to scale development by allowing other developers and teams to work on different features independently.
- Flexibility: allows using different technologies or approaches within each slice as needed.
- Maintainability: easier to navigate in the solution, understand and maintain since all aspects of a feature are contained within a single slice.
- Reduced Coupling: minimizes dependencies between different slices.
Let's explore what are the disadvantages of Vertical Slice Architecture:
- Duplication: potential for code duplication across slices.
- Consistency: ensuring consistency across slices and managing cross-cutting concerns (e.g., error handling, logging, validation) requires careful planning.
- Large number of classes and files: large application can have a lot of vertical slices, each containing multiple small classes.
With the first two disadvantages, you can deal by carefully designing your architecture.
For example, you can extract common functionality to its own classes.
And use MediatR pipelines to manage the cross-cutting concerns such as error handling, logging, validation, etc.
The third disadvantage could be dealt with a good folder structure.
Clean Architecture vs Vertical Slice Architecture
On one hand, Clean Architecture offers clear separation between different layers of the application.
But on the other hand, you need to navigate across multiple projects to explore the implementation of a single use case.
The best part of Clean Architecture is that you have a Domain-centric design of your application that significantly simplifies the development of complex domains and projects.
Vertical Slice Architecture instead allows you to organize your code that offers rapid navigation and development.
A single use case implementation is one place.
What if we can take the best parts of both worlds and combine Clean Architecture with Vertical Slices?
Let's get into it.
How To Structure Your Projects with Clean Architecture and Vertical Slices
I found that combining Clean Architecture with Vertical Slices is a great architecture design for the complex applications.
In small applications or in applications that don't have complex business logic, you can use Vertical Slices without Clear Architecture.
As a core, I use Clean Architecture layers and combine them with Vertical Slices.
Here is how the layers are being modified:
- Domain: contains core business objects such as entities (remains unchanged).
- Infrastructure: implementation of external dependencies like database, cache, message queue, authentication provider, etc (remains unchanged).
- Application and Presentation Layers are combined with Vertical Slices.
Let's jump straight into the code.
We'll explore the Shipment Application.
Here's my solution structure:
Domain Project
Let's start exploring this application from the Domain project:
I use Domain-Driven Design (DDD) for my domain project, here what the Shipment entity looks like:
public class Shipment
{
private readonly List<ShipmentItem> _items = [];
public Guid Id { get; private set; }
public string Number { get; private set; }
public string OrderId { get; private set; }
public Address Address { get; private set; }
public string Carrier { get; private set; }
public string ReceiverEmail { get; private set; }
public ShipmentStatus Status { get; private set; }
public IReadOnlyList<ShipmentItem> Items => _items.AsReadOnly();
public DateTime CreatedAt { get; private set; }
public DateTime? UpdatedAt { get; private set; }
private Shipment() { }
public static Shipment Create(
string number,
string orderId,
Address address,
string carrier,
string receiverEmail,
List<ShipmentItem> items)
{
var shipment = new Shipment
{
Id = Guid.NewGuid(),
Number = number,
OrderId = orderId,
Address = address,
Carrier = carrier,
ReceiverEmail = receiverEmail,
Status = ShipmentStatus.Created,
CreatedAt = DateTime.UtcNow
};
shipment.AddItems(items);
return shipment;
}
}
Shipment entity has additional methods following DDD:
public void AddItem(ShipmentItem item)
{
_items.Add(item);
UpdatedAt = DateTime.UtcNow;
}
public void AddItems(List<ShipmentItem> items)
{
_items.AddRange(items);
UpdatedAt = DateTime.UtcNow;
}
public void RemoveItem(ShipmentItem item)
{
_items.Remove(item);
UpdatedAt = DateTime.UtcNow;
}
public void UpdateAddress(Address newAddress)
{
Address = newAddress;
UpdatedAt = DateTime.UtcNow;
}
public ErrorOr<Success> Process()
{
if (Status is not ShipmentStatus.Created)
{
return Error.Validation("Can only update to Processing from Created status");
}
Status = ShipmentStatus.Processing;
UpdatedAt = DateTime.UtcNow;
return Result.Success;
}
public ErrorOr<Success> Dispatch()
{
if (Status is not ShipmentStatus.Processing)
{
return Error.Validation("Can only update to Dispatched from Processing status");
}
Status = ShipmentStatus.Dispatched;
UpdatedAt = DateTime.UtcNow;
return Result.Success;
}
...
For complex domains with various business rules, a domain-driven design is a good fit.
In DDD you encapsulate all business logic within the entities as they implement the business rules.
In our example Shipment can be in one of the following states:
public enum ShipmentStatus
{
Created,
Processing,
Dispatched,
InTransit,
Delivered,
Received,
Cancelled
}
So it's beneficial to have all business rules on how states are changed in a single class.
Infrastructure Project
In the Infrastructure project I like putting implementation of external integrations like: a database, cache, authentication, etc.
If in your projects you don't need to implement repositories or other external integrations — you can simply omit the Infrastructure project.
Be pragmatic, as I showed in one of the previous posts — you can use EF Core directly in the Vertical Slices.
Features Projects
Here is how my Features project looks like
Here I combine Application and Presentation Layers into Vertical Slices.
For complex Features (Slices) I like using MediatR commands and queries:
internal sealed record CreateShipmentCommand(
string OrderId,
Address Address,
string Carrier,
string ReceiverEmail,
List<ShipmentItem> Items)
: IRequest<ErrorOr<ShipmentResponse>>;
internal sealed class CreateShipmentCommandHandler(
IShipmentRepository repository,
IUnitOfWork unitOfWork,
ILogger<CreateShipmentCommandHandler> logger)
: IRequestHandler<CreateShipmentCommand, ErrorOr<ShipmentResponse>>
{
public async Task<ErrorOr<ShipmentResponse>> Handle(
CreateShipmentCommand request,
CancellationToken cancellationToken)
{
var shipmentAlreadyExists = await repository.ExistsByOrderIdAsync(request.OrderId, cancellationToken);
if (shipmentAlreadyExists)
{
logger.LogInformation("Shipment for order '{OrderId}' is already created", request.OrderId);
return Error.Conflict($"Shipment for order '{request.OrderId}' is already created");
}
var shipmentNumber = new Faker().Commerce.Ean8();
var shipment = request.MapToShipment(shipmentNumber);
await repository.AddAsync(shipment, cancellationToken);
await unitOfWork.SaveChangesAsync(cancellationToken);
logger.LogInformation("Created shipment: {@Shipment}", shipment);
var response = shipment.MapToResponse();
return response;
}
}
I use minimal API endpoints that call the given MediatR command/query:
public class CreateShipmentEndpoint : IEndpoint
{
public void MapEndpoint(WebApplication app)
{
app.MapPost("/api/shipments", Handle);
}
private static async Task<IResult> Handle(
[FromBody] CreateShipmentRequest request,
IValidator<CreateShipmentRequest> validator,
IMediator mediator,
CancellationToken cancellationToken)
{
var validationResult = await validator.ValidateAsync(request, cancellationToken);
if (!validationResult.IsValid)
{
return Results.ValidationProblem(validationResult.ToDictionary());
}
var command = request.MapToCommand();
var response = await mediator.Send(command, cancellationToken);
if (response.IsError)
{
return response.Errors.ToProblem();
}
return Results.Ok(response.Value);
}
}
I extract cross-cutting concerns like mapping and validation into separate files within a feature's folder.
In more simple use cases, I can use repository or even EF Core directly inside the feature's endpoint:
public class DispatchShipmentEndpoint : IEndpoint
{
public void MapEndpoint(WebApplication app)
{
app.MapPost("/api/shipments/dispatch/{shipmentNumber}", Handle);
}
private static async Task<IResult> Handle(
[FromRoute] string shipmentNumber,
IShipmentRepository repository,
IUnitOfWork unitOfWork,
ILogger<DispatchShipmentEndpoint> logger,
IMediator mediator,
CancellationToken cancellationToken)
{
var shipment = await repository.GetByNumberAsync(shipmentNumber, cancellationToken);
if (shipment is null)
{
logger.LogDebug("Shipment with number {ShipmentNumber} not found", shipmentNumber);
return Error.NotFound("Shipment.NotFound", $"Shipment with number '{shipmentNumber}' not found").ToProblem();
}
var response = shipment.Dispatch();
if (response.IsError)
{
return response.Errors.ToProblem();
}
await unitOfWork.SaveChangesAsync(cancellationToken);
logger.LogInformation("Dispatched shipment with {ShipmentNumber}", shipmentNumber);
return Results.NoContent();
}
}
Thanks to Domain-Driven Design all my business logic with dispatching Shipment is encapsulated within the entity.
This significantly simplifies our use-case implementation and reduces the code duplication.
Here is the diagram, what my updated Architecture looks like:
Summary
I find the best way to structure complex projects is by using Domain and Infrastructure Layers from Clean Architecture and combining the Application and Presentation Layers into Vertical Slices.
Domain Layer allows you to encapsulate business rule within the corresponding entities.
The Infrastructure Layer allows you to avoid code duplication of external integrations.
Vertical Slices are a fantastic way to achieve high cohesion within each slice and low coupling across different slices.
If you want to learn more about Vertical Slices - I recommend reading my blog post.
On my website: antondevtips.com I share .NET and Architecture best practices.
Subscribe to become a better developer.
Download the source code for this blog post for free.
This content originally appeared on DEV Community and was authored by Anton Martyniuk
Anton Martyniuk | Sciencx (2024-08-27T18:38:13+00:00) The Best Way To Structure Your .NET Projects with Clean Architecture and Vertical Slices. Retrieved from https://www.scien.cx/2024/08/27/the-best-way-to-structure-your-net-projects-with-clean-architecture-and-vertical-slices/
Please log in to upload a file.
There are no updates yet.
Click the Upload button above to add an update.