Как пользоваться контейнером для внедрения зависимостей (DI-контейнером)?

Пожалуйста, объясните, как функционирует DI-контейнер. В контейнере действительно указываются только примитивные типы данных, или все объектные зависимости создаются с помощью автовайринга и Reflection API? <br/><br/> К примеру, у меня есть контроллер, который принимает модель и вид. Вид, в свою очередь, принимает шаблоны в виде обычных строк, которые нужно подключить. Модель получает класс соединения с БД, а класс БД требует массив с настройками подключения. Также присутствует класс пагинации, который должен быть инъектирован в контроллер и принимает три параметра типа int в своем конструкторе. <br/> Необходимо ли в контейнере размещать названия всех шаблонов и массив с настройками подключения к БД? Каким образом следует поступить с пагинацией, если три аргумента типа int вычисляются в контроллере и потом вызывается класс?
  • 8 октября 2024 г. 9:25
Ответы на вопрос 3
Контейнер для внедрения зависимостей (DI-контейнер) — это инструмент, который помогает управлять зависимостями между объектами в приложении. Основная задача DI-контейнера заключается в автоматизации процесса создания объектов и их зависимости, что позволяет упростить код и сделать его более удобным для тестирования.

### Как функционирует DI-контейнер

1. **Регистрация зависимостей**: В контейнере регистрируются классы и их зависимости. Например, вы можете зарегистрировать сервисы, репозитории или контроллеры, указывая, как они должны быть созданы.

2. **Разрешение зависимостей**: Когда вам нужен объект, вы запрашиваете его у контейнера. Контейнер использует информацию о зарегистрированных зависимостях для создания и конфигурации объекта. Это включает в себя вызов конструктора объекта и передача необходимых зависимостей.

3. **Автовайринг и Reflection API**: Многие современные DI-контейнеры используют технику автовайринга (automatic wiring), что позволяет автоматически определять и разрешать зависимости, основываясь на типах параметров конструкторов. Это может включать в себя использование Reflection API для получения информации о доступных конструкторах и их параметрах.

### Примеры использования DI-контейнера

#### Пример регистрации зависимостей:

```csharp
public void ConfigureServices(IServiceCollection services)
{
    services.AddScoped<DatabaseConnection>(provider => 
        new DatabaseConnection(Configuration.GetConnectionString("DefaultConnection")));
    
    services.AddScoped<Model>();
    services.AddScoped<View>();
    services.AddScoped<Controller>();
    services.AddScoped<Pagination>();
}
```

#### Пример разрешения зависимостей:

```csharp
public class Controller
{
    private readonly Model _model;
    private readonly View _view;
    private readonly Pagination _pagination;

    public Controller(Model model, View view, Pagination pagination)
    {
        _model = model;
        _view = view;
        _pagination = pagination;
    }

    // Логика контроллера
}
```

### Обработка параметров в конструкторах

В вашем случае, у вас есть контроллер, который нуждается в модели, виде и пагинации. Если параметры пагинации — это три целых числа, которые вычисляются в контроллере, вы не можете просто их передать через DI-контейнер. Вместо этого, вы можете рассмотреть следующие подходы:

1. **Внедрение зависимостей**: Если параметры пагинации могут быть внешними и постоянными, вы можете создать специальный класс для конфигурации и зарегистрировать его в контейнере.

2. **Передача параметров во время вызова**: Вы можете оставить пагинацию в контроллере, чтобы вычислять значения и затем передавать их в метод пагинации.

```csharp
public void Paginate(int page, int pageSize, int totalCount)
{
    var pagination = new Pagination(page, pageSize, totalCount);
    // Логика пагинации
}
```

### Шаблоны и массив настроек подключения

Если ваши шаблоны фиксированы и не будут менять, их можно указать напрямую в коде или передать как строки в тот класс, который отвечает за их обработку. Однако массив с настройками подключения к базе данных также можно хранить в конфигурационных файлах (например, в `appsettings.json`) и подставлять через DI-контейнер. Например:

```csharp
services.Configure<DatabaseSettings>(Configuration.GetSection("DatabaseSettings"));
```

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

### Общие рекомендации
- Используйте DI-контейнер для управления зависимостями, но избегайте жесткой привязки объектов, когда это возможно.
- Рассмотрите возможность создания вспомогательных классов для параметров, если они могут быть параметризованы, но не требуют повторного создания.
- Храните конфигурации отдельно, в том числе настройки подключения к БД, для упрощения изменений в будущем. 

Таким образом, контейнер для внедрения зависимостей будет значительно упрощать работу с объектами и их взаимозависимостями в вашем приложении.
В самом контейнере задаются только примитивные типы данных?

В DI контейнере обычно регистрируют объекты, общие для всего приложения, а не для конкретного запроса. Например, коннект к базе, роутер, кеш. Автовайринг примитивных типов в DI - прямая дорога к путанице и сложным для обнаружения ошибкам.

А все объектные зависимости решаются с помощью автовайринга через Reflection API?

Можно и так. А можно руками связи выставить. Или аннотациями. Разные способы бывают, смотря какие поддерживаются выбранной вами реализацией DI.

К примеру, у меня есть контроллер.

В случае с контроллерами обычно делают front controller, на который сваливаются абсолютно все запросы, а дальше он сам определяет какой из контроллеров нужно создать и передаёт запрос на обработку ему.

Сам вид принимает шаблоны, это обычные строки с разванием шаблонов, которые нужно подключить.

Если строки с названием шаблонов фиксированы, хранятся в конфиге/базе и одинаковы для всех страниц и всех пользователей, то можно шаблон и в DI зарегистрировать. В противном случае лучше создавать его во фронт контроллере. Либо зарегистрировать в DI фабрику шаблонов, которая будет создавать объекты вью в зависимости от переданных параметров. Аналогично и с моделью.

Модель принимает класс соединения с БД, а БД принимает массив с настройками подключения.

В контейнере можно зарегистрировать объект Settings, в котором хранятся данные для подключения к базе и прочие глобальные настройки, а затем инжектить его в класс для работы с базой. Ещё контейнер может сам выступать хранилищем настроек и инжектить их (в том числе примитивные). Так сделано в DI компоненте Symfony.

Есть еще класс пагинации, он тоже должен быть в контроллере и его конструктор принимает три параметра типа int.

Опять же, если эти три параметра не зависят от запроса, то можно зарегистрировать пагинатор в DI. Если зависят, то можно из конструктора перенести эти параметры в метод и вызывать его в контроллере. Например: $page = $this->paginator->calulatePage($one, $two, $three)
DI-контейнер это один из основных инструментов который должен быть в вашем приложении. Одно из правил SOLID это инверсия зависимостей, которая решается внедрением DI-контейнера с Автовайрингом для удобства. 
Уже много лет использую https://container.thephpleague.com/ и работа с зависимостями перестала был проблемой.
Теперь по вашей задаче:
У вас есть контроллер HomeController который должен иметь две зависимости, например UserRepository и Pagination.
Какие зависимости должен иметь контроллер через абстракцию ? UserRepository потому что репозиторий это как правило класс который реализует слой хранения данных, который в свою очередь может меняться так как относится к слою инфраструктуры, поэтому у вас есть UserRepositoryInterface. Но вот к чему относится Pagination ? - к слою представления где у вас и находится контроллер, по сути использовать абстракции для него нет смысла, также как и для Response и Request и тд.
Поэтому ваш код будет выглядеть так:
class HomeCotroller{

   public function __construct(protected Request $request, protected UserRepositoryInterface $userRepository)

  }
  public function index(): Response { 

    $params = $this->request->getAll()
    //тут логика получения переменных

    $pagination = new Pagination($param1, $param2);
    $pagiationHtml = $pagitation->render();

    //тут логика построения html через шаблонизатор

    return new Response($html);
 }


По поводу конфига с настройками: в DI контейнере есть возможность использовать singlitone объекты , создаете адаптер подключения к базе MysqlAdapter который в конструкторе берет настройки из вашего .env файла и создает соединение 1 раз. И дальше можете адаптер использовать его через инфекцию в ваши репозитории.
Похожие вопросы