How ehsanfaridi92/framework works
High-level breakdown
• Build & CI/CD Business:
– BuildScript components, build commands (build.ps1, build.cmd, build.sh)
– Azure Pipeline integration via the Framework-Azure-Pipeline.yaml
– GitHub configurations (such as .github folder)
• Core Framework Modules (within Code/Src):
– Framework.Application.Contracts: Defines command and query contracts and corresponding handlers (ICommand, IRequest, etc.).
– Framework.Application: Implements and orchestrates command/request buses with potential decorators (transactional, logging, etc.).
– Framework.AspNetCore: Contains ASP.NET Core integrations, middleware (exception, rate limiting, logging, images handling), configuration classes and extension methods.
– Other modules such as Framework.Authentication, Framework.Authorization, Framework.Caching (in multiple flavors: abstractions, configuration, dependency injection, DotnetCore, Redis), Framework.Config (with Autofac integration), Framework.Consul, Framework.Core (the core utility layer including domain events, logging, pagination, etc.), Framework.DataAccess (multiple implementations for various databases like ClickHouse, EF, Mongo, NH), Framework.Domain for domain model definitions, as well as messaging and event processing components (Framework.EasyNetQ, Framework.EventProcessor, Framework.MassTransit, Framework.Messages, Framework.Query, Framework.RabbitMQ, Framework.Kafka, Framework.Redis, Framework.Restful, Framework.Security, Framework.Sentry, Framework.Specification, Framework.Swagger), among many others.
• Data Access & Persistence:
– Several libraries exist to support various persistence strategies (ClickHouse, EF, Mongo, NH).
– They contain common patterns such as Unit of Work, Repository, DomainEvent persistence, and mapping configurations.
• Messaging and Event Handling:
– There are dedicated modules managing inter-service and event-driven communication (Kafka, RabbitMQ, MassTransit, EasyNetQ, and related idempotency modules).
– They include configuration modules, producer/consumer interfaces and implementations, and event transformation logic.
• Utility & Testing:
– Framework.Utility, Framework.Testing.Core modules handle cross-cutting utility functions and the testing infrastructure.
– Test projects in Code/Test validate implementations across various modules (for instance unit tests in Framework.Domain.Tests.Unit and Framework.Utility.Tests.Unit).
Relationship and Interactions
• How messaging components interact: applications or event processors publish messages through components in Framework.Messages, RabbitMQ, MassTransit, Kafka, etc.
• Use of dependency injection (e.g., in Framework.Config.Autofac) for decoupling the different modules.
• Decorator patterns found in the code (such as the transactional or logging decorators in the application layer).
Architectural Patterns and Design Principles
• Layered or modular architecture: Infrastructure (Data Access, Messaging, Logging), Application (command/query buses, decorators), and Presentation (ASP.NET Core integrations).
• Heavy use of interfaces (like ICommand, IRequest, IQueryHandler, etc.) for abstraction, which suggests an emphasis on dependency inversion and loose coupling.
• Pattern usage such as Controller/Middleware usage in ASP.NET Core, the Repository/Unit of Work pattern in data access modules, and event-driven designs in messaging/event processing libraries.
• Integration points for external services (e.g., Consul, Sentry, Minio, Hazelcast).