Привет. Дай урок по гексогональной архитектуре ASP NET WEB API
- User
Привет. Дай урок по гексогональной архитектуре ASP NET WEB API
- Assistant
Привет! Давай рассмотрим гексагональную архитектуру (Hexagonal Architecture) в контексте ASP.NET Web API. Гексагональная архитектура, также известная как "Порты и Адаптеры" (Ports and Adapters), представляет собой архитектурный стиль, который помогает создавать приложения с четким разделением ответственности и изоляцией бизнес-логики от внешних систем.
Что такое гексагональная архитектура?
Гексагональная архитектура предлагает организовать приложение так, чтобы его ядро (бизнес-логика) было изолировано от внешних зависимостей. Это достигается путем использования интерфейсов (портов) и их реализаций (адаптеров). Такая архитектура облегчает тестирование, позволяет легко менять инфраструктуру без затрагивания бизнес-логики и способствует более чистому и поддерживаемому коду.
Основные компоненты гексагональной архитектуры:
- Доменный слой (Domain Layer): содержит бизнес-логику и сущности.
- Порты (Ports): интерфейсы, через которые внешние системы взаимодействуют с доменом.
- Адаптеры (Adapters): реализации портов, которые связывают домен с внешними системами (базы данных, веб-сервисы и т.д.).
Реализация гексагональной архитектуры в ASP.NET Web API
Давайте шаг за шагом создадим приложение, следуя принципам гексагональной архитектуры.
Шаг 1: Создание решения и проектов
Создай новое решение в Visual Studio и добавь следующие проекты:
- Domain: Библиотека классов (.NET Standard), содержащая доменные сущности и бизнес-логику.
- Application: Библиотека классов (.NET Standard), содержащая интерфейсы (порты) и сервисы.
- Infrastructure: Библиотека классов (.NET Core), содержащая реализации интерфейсов (адаптеры).
- WebAPI: Веб-приложение ASP.NET Core Web API.
Шаг 2: Доменный слой (Domain)
Проект: Domain
Это ядро приложения. Здесь находятся доменные сущности и бизнес-логика.
Пример доменной сущности:
// Domain/Entities/Product.cs namespace Domain.Entities { public class Product { public Guid Id { get; set; } public string Name { get; set; } public decimal Price { get; set; } // Бизнес-логика внутри сущности public void ApplyDiscount(decimal percentage) { if (percentage < 0 || percentage > 100) throw new ArgumentException("Invalid discount percentage"); Price -= Price * (percentage / 100); } } }Шаг 3: Порты и сервисы (Application)
Проект: Application
Здесь определяются интерфейсы (порты) и сервисы, которые используются для взаимодействия между доменом и внешними системами.
Интерфейс репозитория:
// Application/Interfaces/IProductRepository.cs using Domain.Entities; namespace Application.Interfaces { public interface IProductRepository { Task<Product> GetByIdAsync(Guid id); Task<IEnumerable<Product>> GetAllAsync(); Task AddAsync(Product product); Task UpdateAsync(Product product); Task DeleteAsync(Guid id); } }Интерфейс сервиса:
// Application/Interfaces/IProductService.cs using Domain.Entities; namespace Application.Interfaces { public interface IProductService { Task<Product> GetProductAsync(Guid id); Task<IEnumerable<Product>> GetAllProductsAsync(); Task CreateProductAsync(Product product); Task UpdateProductAsync(Product product); Task DeleteProductAsync(Guid id); } }Реализация сервиса:
// Application/Services/ProductService.cs using Application.Interfaces; using Domain.Entities; namespace Application.Services { public class ProductService : IProductService { private readonly IProductRepository _repository; public ProductService(IProductRepository repository) { _repository = repository; } public async Task<Product> GetProductAsync(Guid id) { return await _repository.GetByIdAsync(id); } public async Task<IEnumerable<Product>> GetAllProductsAsync() { return await _repository.GetAllAsync(); } public async Task CreateProductAsync(Product product) { // Дополнительная бизнес-логика может быть добавлена здесь await _repository.AddAsync(product); } public async Task UpdateProductAsync(Product product) { // Дополнительная бизнес-логика может быть добавлена здесь await _repository.UpdateAsync(product); } public async Task DeleteProductAsync(Guid id) { await _repository.DeleteAsync(id); } } }Шаг 4: Адаптеры (Infrastructure)
Проект: Infrastructure
Здесь реализуются интерфейсы из проекта Application.
Реализация репозитория с использованием Entity Framework Core:
// Infrastructure/Data/AppDbContext.cs using Domain.Entities; using Microsoft.EntityFrameworkCore; namespace Infrastructure.Data { public class AppDbContext : DbContext { public DbSet<Product> Products { get; set; } public AppDbContext(DbContextOptions<AppDbContext> options) : base(options) { } } }Репозиторий:
// Infrastructure/Repositories/ProductRepository.cs using Application.Interfaces; using Domain.Entities; using Infrastructure.Data; using Microsoft.EntityFrameworkCore; namespace Infrastructure.Repositories { public class ProductRepository : IProductRepository { private readonly AppDbContext _context; public ProductRepository(AppDbContext context) { _context = context; } public async Task<Product> GetByIdAsync(Guid id) { return await _context.Products.FindAsync(id); } public async Task<IEnumerable<Product>> GetAllAsync() { return await _context.Products.ToListAsync(); } public async Task AddAsync(Product product) { _context.Add(product); await _context.SaveChangesAsync(); } public async Task UpdateAsync(Product product) { _context.Update(product); await _context.SaveChangesAsync(); } public async Task DeleteAsync(Guid id) { var product = await GetByIdAsync(id); _context.Remove(product); await _context.SaveChangesAsync(); } } }Шаг 5: Настройка Web API
Проект: WebAPI
Здесь мы связываем все вместе и настраиваем зависимости.
Startup.cs или Program.cs (в зависимости от версии ASP.NET Core):
// WebAPI/Program.cs var builder = WebApplication.CreateBuilder(args); // Добавляем контроллеры builder.Services.AddControllers(); // Добавляем контекст базы данных builder.Services.AddDbContext<AppDbContext>(options => options.UseSqlServer(builder.Configuration.GetConnectionString("DefaultConnection"))); // Регистрация зависимостей builder.Services.AddScoped<IProductRepository, ProductRepository>(); builder.Services.AddScoped<IProductService, ProductService>(); var app = builder.Build(); // Настраиваем маршрут app.MapControllers(); app.Run();Контроллер:
// WebAPI/Controllers/ProductsController.cs using Application.Interfaces; using Domain.Entities; using Microsoft.AspNetCore.Mvc; namespace WebAPI.Controllers { [Route("api/[controller]")] [ApiController] public class ProductsController : ControllerBase { private readonly IProductService _service; public ProductsController(IProductService service) { _service = service; } [HttpGet] public async Task<IEnumerable<Product>> Get() { return await _service.GetAllProductsAsync(); } [HttpGet("{id}")] public async Task<ActionResult<Product>> Get(Guid id) { var product = await _service.GetProductAsync(id); if (product == null) return NotFound(); return product; } [HttpPost] public async Task<ActionResult> Post(Product product) { await _service.CreateProductAsync(product); return CreatedAtAction(nameof(Get), new { id = product.Id }, product); } [HttpPut("{id}")] public async Task<ActionResult> Put(Guid id, Product product) { if (id != product.Id) return BadRequest(); await _service.UpdateProductAsync(product); return NoContent(); } [HttpDelete("{id}")] public async Task<ActionResult> Delete(Guid id) { await _service.DeleteProductAsync(id); return NoContent(); } } }Шаг 6: Настройка подключения к базе данных
Добавь строку подключения в
appsettings.json:// WebAPI/appsettings.json { "ConnectionStrings": { "DefaultConnection": "Server=(localdb)\\mssqllocaldb;Database=HexagonalDb;Trusted_Connection=True;" }, // ... }Не забудь выполнить миграции и создать базу данных:
Add-Migration InitialCreate -StartupProject WebAPI -Context AppDbContext Update-Database -StartupProject WebAPI -Context AppDbContextПреимущества данного подхода
- Модульность: Каждый слой отвечает за свою зону ответственности.
- Тестируемость: Бизнес-логику можно легко тестировать в отрыве от инфраструктуры.
- Гибкость: Легко менять реализации (например, заменить базу данных) без изменения бизнес-логики.
- Поддерживаемость: Четкое разделение слоев упрощает понимание и поддержку кода.
Заключение
Гексагональная архитектура способствует созданию более чистых и поддерживаемых приложений, разделяя бизнес-логику и инфраструктуру. В ASP.NET Web API это достигается путем разделения кодовой базы на проекты, использования интерфейсов для определения портов и реализации адаптеров для связи с внешними системами.
Рекомендуется далее:
- Добавить тесты для доменного слоя и сервисов.
- Реализовать валидацию входящих данных.
- Добавить обработку исключений.
- Рассмотреть использование CQRS и Mediator для более сложных сценариев.
Надеюсь, этот урок помог тебе понять, как применить гексагональную архитектуру в ASP.NET Web API!