Как расширить контроллер?

Как расширить контроллер в ASP.NET Core

Расширение контроллеров в ASP.NET Core — это ключевая практика для улучшения архитектуры приложения, повышения читаемости кода и соблюдения принципов SOLID. Под "расширением" обычно понимают два направления: 1) добавление новых функциональных возможностей к существующим контроллерам и 2) создание более абстрактных, reusable компонентов для управления поведением контроллеров.

Основные подходы к расширению контроллеров

1. Использование фильтров (Filters)

Фильтры позволяют внедрять логику до и после выполнения действий контроллера. Это идеальный способ для кроссплатформенных задач: авторизация, валидация, обработка исключений, логирование.

// Пример фильтра для логирования
public class LogActionFilter : IActionFilter
{
    private readonly ILogger _logger;

    public LogActionFilter(ILogger logger)
    {
        _logger = logger;
    }

    public void OnActionExecuting(ActionExecutingContext context)
    {
        _logger.LogInformation($"Action {context.ActionDescriptor.DisplayName} started");
    }

    public void OnActionExecuted(ActionExecutedContext context)
    {
        _logger.LogInformation($"Action {context.ActionDescriptor.DisplayName} completed");
    }
}

// Регистрация в контроллере
[ServiceFilter(typeof(LogActionFilter))]
public class ProductController : ControllerBase
{
    // ... действия контроллера
}

Фильтры можно применять на уровне:

• Глобально (регистрация в Startup.cs)
• На контроллер (атрибут на классе)
• На действие (атрибут на методе)

2. Применение Middleware

Middleware работает на уровне HTTP pipeline и может обрабатывать запросы до их попадания в контроллер. Это полезно для задач, не зависящих от конкретного контроллера: компрессия ответов, кастомная обработка заголовков.

// Пример middleware для добавления кастомного заголовка
public class CustomHeaderMiddleware
{
    private readonly RequestDelegate _next;

    public CustomHeaderMiddleware(RequestDelegate next)
    {
        _next = next;
    }

    public async Task Invoke(HttpContext context)
    {
        context.Response.Headers.Add("X-Custom-Header", "Extended-Controller");
        await _next(context);
    }
}

// Регистрация в Startup.cs
app.UseMiddleware<CustomHeaderMiddleware>();

3. Создание базовых контроллеров (Base Controller)

Наследование от общего базового класса — один из самых распространенных способов централизации общей логики.

// Базовый контроллер с общими методами
public abstract class ApiBaseController : ControllerBase
{
    protected IActionResult HandleResult<T>(Result<T> result)
    {
        if (result.IsSuccess)
            return Ok(result.Value);
        
        return BadRequest(result.Error);
    }

    protected Guid GetCurrentUserId()
    {
        return Guid.Parse(User.FindFirst(ClaimTypes.NameIdentifier).Value);
    }
}

// Использование в производных контроллерах
public class OrderController : ApiBaseController
{
    public IActionResult GetOrder(int id)
    {
        var result = _orderService.GetOrder(id, GetCurrentUserId());
        return HandleResult(result);
    }
}

4. Использование интерфейсов и dependency injection

Внедрение общих сервисов через интерфейсы позволяет контроллеру использовать расширенную логику без прямого её включения.

// Интерфейс для расширенной функциональности
public interface IControllerExtensions
{
    Task ValidateModelAsync(object model);
    string GenerateETag(object data);
}

// Контроллер с внедренным сервисом расширений
public class ExtendedController : ControllerBase
{
    private readonly IControllerExtensions _extensions;

    public ExtendedController(IControllerExtensions extensions)
    {
        _extensions = extensions;
    }

    [HttpPost]
    public async Task<IActionResult> Create([FromBody] ProductDto product)
    {
        await _extensions.ValidateModelAsync(product);
        // ... основная логика
    }
}

5. Реализация кастомных атрибутов

Атрибуты — мощный инструмент для декларативного расширения поведения действий контроллера.

// Атрибут для кастомной валидации
public class ValidateEntityExistsAttribute : TypeFilterAttribute
{
    public ValidateEntityExistsAttribute(Type entityType) : base(typeof(ValidateEntityExistsFilter))
    {
        Arguments = new object[] { entityType };
    }
}

// Использование на действии контроллера
[ValidateEntityExists(typeof(Product))]
public IActionResult UpdateProduct(int id, ProductDto dto)
{
    // Продукт гарантированно существует благодаря фильтру
    // ... логика обновления
}

Практические рекомендации

• Придерживайтесь принципа единственной ответственности: Расширения должны решать одну конкретную проблему (логирование, валидация, трансформация данных).
• Избегайте чрезмерного наследования: Сложные цепи наследования контроллеров затрудняют понимание кода. Вместо этого используйте композицию (сервисы, фильтры).
• Тестируемость: Все расширения должны быть легко тестируемыми через unit tests. Избегайте статических методов и жестких зависимостей.
• Конфигурируемость: Расширения должны позволять настройку через параметры или конфигурационные файлы.

Пример комплексного расширения

Представим контроллер, который использует несколько подходов одновременно:

[ApiController]
[Route("api/[controller]")]
[ServiceFilter(typeof(LoggingFilter))] // Фильтр для логирования
[Authorize(Policy = "ExtendedAccess")] // Политика авторизации
public class ExtendedApiController : ApiBaseController // Наследование базового
{
    private readonly IAdvancedProcessingService _processor;

    public ExtendedApiController(IAdvancedProcessingService processor)
    {
        _processor = processor; // Dependency injection
    }

    [HttpPost("process")]
    [ValidateModel] // Кастомный атрибут валидации
    [RateLimit(requestsPerMinute = 100)] // Атрибут ограничения запросов
    public async Task<IActionResult> ProcessData([FromBody] ComplexModel model)
    {
        var processedData = await _processor.TransformAsync(model, GetCurrentUserId());
        return HandleResult(processedData); // Метод из базового контроллера
    }
}

Ключевой вывод: Расширение контроллеров в ASP.NET Core — это не просто добавление новых методов, а систематическое применение паттернов и инструментов фреймворка для создания гибкой, поддерживаемой и масштабируемой архитектуры. Выбор конкретного метода зависит от задачи: фильтры для кроссплатформенных операций, базовые контроллеры для общей бизнес-логики, middleware для обработки HTTP-конвейера, а dependency injection для инкапсуляции сложных сервисов.