Architecture
This project is an example of architecture using new technologies and best practices.
The goal is to share knowledge and use it as reference for new projects.
Thanks for enjoying!
Technologies
Practices
- Clean Code
- SOLID Principles
- DDD (Domain-Driven Design)
- Separation of Concerns
Run
Command Line
Prerequisites
Steps
- Open directory source\Web\Frontend in command line and execute npm run restore.
- Open directory source\Web in command line and execute dotnet run.
- Open https://localhost:8090.
Visual Studio Code
Prerequisites
Steps
- Open directory source\Web\Frontend in command line and execute npm run restore.
- Open source directory in Visual Studio Code.
- Press F5.
Visual Studio
Prerequisites
Steps
- Open directory source\Web\Frontend in command line and execute npm run restore.
- Open source\Architecture.sln in Visual Studio.
- Set Architecture.Web as startup project.
- Press F5.
Docker
Prerequisites
Steps
- Execute docker-compose up --build -d in root directory.
- Open http://localhost:8090.
Utils
Books
- Clean Code: A Handbook of Agile Software Craftsmanship - Robert C. Martin (Uncle Bob)
- Clean Architecture: A Craftsman's Guide to Software Structure and Design - Robert C. Martin (Uncle Bob)
- Implementing Domain-Driven Design - Vaughn Vernon
- Domain-Driven Design Distilled - Vaughn Vernon
- Domain-Driven Design: Tackling Complexity in the Heart of Software - Eric Evans
- Domain-Driven Design Reference: Definitions and Pattern Summaries - Eric Evans
Visual Studio Code Extensions
Nuget Packages
Source: https://github.com/rafaelfgx/DotNetCore
Published: https://www.nuget.org/profiles/rafaelfgx
Layers
Web: Frontend and API.
Application: Flow control.
Domain: Business rules and domain logic.
Model: Data transfer objects.
Database: Data persistence.
Web
Frontend
Service
export class AppCustomerService {
constructor(private readonly http: HttpClient, private readonly gridService: GridService) { }
add = (customer: Customer) => this.http.post<number>("customers", customer);
delete = (id: number) => this.http.delete(`customers/${id}`);
get = (id: number) => this.http.get<Customer>(`customers/${id}`);
grid = (parameters: GridParameters) => this.gridService.get<Customer>("customers/grid", parameters);
inactivate = (id: number) => this.http.patch(`customers/${id}/inactivate`, {});
list = () => this.http.get<Customer[]>("customers");
update = (customer: Customer) => this.http.put(`customers/${customer.id}`, customer);
}
Guard
export class AppGuard implements CanActivate {
constructor(private readonly appAuthService: AppAuthService) { }
canActivate() {
if (this.appAuthService.authenticated()) { return true; }
this.appAuthService.signin();
return false;
}
}
ErrorHandler
export class AppErrorHandler implements ErrorHandler {
constructor(private readonly appModalService: AppModalService) { }
handleError(error: any) {
if (error instanceof HttpErrorResponse) {
switch (error.status) {
case 422: {
this.appModalService.alert(error.error);
return;
}
}
}
console.error(error);
}
}
HttpInterceptor
export class AppHttpInterceptor implements HttpInterceptor {
constructor(private readonly appAuthService: AppAuthService) { }
intercept(request: HttpRequest<any>, next: HttpHandler) {
request = request.clone({
setHeaders: { Authorization: `Bearer ${this.appAuthService.token()}` }
});
return next.handle(request);
}
}
API
Startup
public sealed class Startup
{
public void Configure(IApplicationBuilder application)
{
application.UseException();
application.UseHttps();
application.UseRouting();
application.UseResponseCompression();
application.UseAuthentication();
application.UseAuthorization();
application.UseEndpoints();
application.UseSpa();
}
public void ConfigureServices(IServiceCollection services)
{
services.AddSecurity();
services.AddResponseCompression();
services.AddControllersMvcJsonOptions();
services.AddSpa();
services.AddContext();
services.AddServices();
}
}
Controller
[ApiController]
[Route("customers")]
public sealed class CustomerController : ControllerBase
{
private readonly ICustomerService _customerService;
public CustomerController(ICustomerService customerService)
{
_customerService = customerService;
}
[HttpPost]
public Task<IActionResult> AddAsync(CustomerModel model)
{
return _customerService.AddAsync(model).ResultAsync();
}
[HttpDelete("{id}")]
public Task<IActionResult> DeleteAsync(long id)
{
return _customerService.DeleteAsync(id).ResultAsync();
}
[HttpGet("{id}")]
public Task<IActionResult> GetAsync(long id)
{
return _customerService.GetAsync(id).ResultAsync();
}
[HttpGet("grid")]
public Task<IActionResult> GridAsync([FromQuery] GridParameters parameters)
{
return _customerService.GridAsync(parameters).ResultAsync();
}
[HttpPatch("{id}/inactivate")]
public Task InactivateAsync(long id)
{
return _customerService.InactivateAsync(id);
}
[HttpGet]
public Task<IActionResult> ListAsync()
{
return _customerService.ListAsync().ResultAsync();
}
[HttpPut("{id}")]
public Task<IActionResult> UpdateAsync(CustomerModel model)
{
return _customerService.UpdateAsync(model).ResultAsync();
}
}
Application
Service
public sealed class CustomerService : ICustomerService
{
private readonly ICustomerFactory _customerFactory;
private readonly ICustomerRepository _customerRepository;
private readonly IUnitOfWork _unitOfWork;
public CustomerService
(
ICustomerFactory customerFactory,
ICustomerRepository customerRepository,
IUnitOfWork unitOfWork
)
{
_customerFactory = customerFactory;
_customerRepository = customerRepository;
_unitOfWork = unitOfWork;
}
public async Task<IResult<long>> AddAsync(CustomerModel model)
{
var validation = await new AddCustomerModelValidator().ValidationAsync(model);
if (validation.Failed) return validation.Fail<long>();
var customer = _customerFactory.Create(model);
await _customerRepository.AddAsync(customer);
await _unitOfWork.SaveChangesAsync();
return customer.Id.Success();
}
public async Task<IResult> DeleteAsync(long id)
{
await _customerRepository.DeleteAsync(id);
await _unitOfWork.SaveChangesAsync();
return Result.Success();
}
public Task<CustomerModel> GetAsync(long id)
{
return _customerRepository.GetModelAsync(id);
}
public Task<Grid<CustomerModel>> GridAsync(GridParameters parameters)
{
return _customerRepository.GridAsync(parameters);
}
public async Task InactivateAsync(long id)
{
var customer = new Customer(id);
customer.Inactivate();
await _customerRepository.InactivateAsync(customer);
await _unitOfWork.SaveChangesAsync();
}
public Task<IEnumerable<CustomerModel>> ListAsync()
{
return _customerRepository.ListModelAsync();
}
public async Task<IResult> UpdateAsync(CustomerModel model)
{
var validation = await new UpdateCustomerModelValidator().ValidationAsync(model);
if (validation.Failed) return validation;
var customer = _customerFactory.Create(model);
await _customerRepository.UpdateAsync(customer.Id, customer);
await _unitOfWork.SaveChangesAsync();
return Result.Success();
}
}
Factory
public sealed class CustomerFactory : ICustomerFactory
{
public Customer Create(CustomerModel model)
{
return new Customer
(
model.Id,
new Name(model.FirstName, model.LastName),
new Email(model.Email)
);
}
}
Domain
Entity
public sealed class Customer : Entity<long>
{
public Customer(long id) : base(id) { }
public Customer
(
long id,
Name name,
Email email
)
: base(id)
{
Name = name;
Email = email;
Activate();
}
public Name Name { get; private set; }
public Email Email { get; private set; }
public Status Status { get; private set; }
public void Activate()
{
Status = Status.Active;
}
public void Inactivate()
{
Status = Status.Inactive;
}
}
ValueObject
public sealed record Name(string FirstName, string LastName);
Model
Model
public sealed record CustomerModel
{
public long Id { get; init; }
public string FirstName { get; init; }
public string LastName { get; init; }
public string Email { get; init; }
}
ModelValidator
public abstract class CustomerModelValidator : AbstractValidator<CustomerModel>
{
public void Id() => RuleFor(customer => customer.Id).NotEmpty();
public void FirstName() => RuleFor(customer => customer.FirstName).NotEmpty();
public void LastName() => RuleFor(customer => customer.LastName).NotEmpty();
public void Email() => RuleFor(customer => customer.Email).EmailAddress();
}
public sealed class AddCustomerModelValidator : CustomerModelValidator
{
public AddCustomerModelValidator() => FirstName(); LastName(); Email();
}
public sealed class UpdateCustomerModelValidator : CustomerModelValidator
{
public UpdateCustomerModelValidator() => Id(); FirstName(); LastName(); Email();
}
Database
Context
public sealed class Context : DbContext
{
public Context(DbContextOptions options) : base(options) { }
protected override void OnModelCreating(ModelBuilder builder)
{
builder.ApplyConfigurationsFromAssembly(typeof(Context).Assembly).Seed();
}
}
Configuration
public sealed class CustomerConfiguration : IEntityTypeConfiguration<Customer>
{
public void Configure(EntityTypeBuilder<Customer> builder)
{
builder.ToTable(nameof(Customer), nameof(Customer));
builder.HasKey(customer => customer.Id);
builder.Property(customer => customer.Id).ValueGeneratedOnAdd().IsRequired();
builder.Property(customer => customer.Status).IsRequired();
builder.OwnsOne(customer => customer.Name, customerName =>
{
customerName.Property(name => name.FirstName).HasColumnName(nameof(Name.FirstName)).HasMaxLength(100).IsRequired();
customerName.Property(name => name.LastName).HasColumnName(nameof(Name.LastName)).HasMaxLength(200).IsRequired();
});
builder.OwnsOne(customer => customer.Email, customerEmail =>
{
customerEmail.Property(email => email.Value).HasColumnName(nameof(User.Email)).HasMaxLength(300).IsRequired();
customerEmail.HasIndex(email => email.Value).IsUnique();
});
}
}
Repository
public sealed class CustomerRepository : EFRepository<Customer>, ICustomerRepository
{
public CustomerRepository(Context context) : base(context) { }
public Task<CustomerModel> GetModelAsync(long id)
{
return Queryable.Where(CustomerExpression.Id(id)).Select(CustomerExpression.Model).SingleOrDefaultAsync();
}
public Task<Grid<CustomerModel>> GridAsync(GridParameters parameters)
{
return Queryable.Select(CustomerExpression.Model).GridAsync(parameters);
}
public Task InactivateAsync(Customer customer)
{
return UpdatePartialAsync(customer.Id, new { customer.Status });
}
public async Task<IEnumerable<CustomerModel>> ListModelAsync()
{
return await Queryable.Select(CustomerExpression.Model).ToListAsync();
}
}
Expression
public static class CustomerExpression
{
public static Expression<Func<Customer, CustomerModel>> Model => customer => new CustomerModel
{
Id = user.Id,
FirstName = user.Name.FirstName,
LastName = user.Name.LastName,
Email = user.Email.Value
};
public static Expression<Func<Customer, bool>> Id(long id) => customer => customer.Id == id;
}