Какой код нужно переносить в отдельные классы?

Question

[Timur Asgard]

Привет!

Не могу понять в какой момент повторяющийся код стоит переносить в отдельные классы (назовем их handler(ами)) из контроллеров.

• Предположим в контроллере есть такой код $result = ['my_data' => $var]; а где то в другом контроллере строчка повторяется. И теперь из-за этого нужно придумывать название handler(а) характеризующий данный процесс и переносить код туда?
  
• А если контроллер выполняет одновременно 5 больших действий? Мне все это придется переносить в 1 handler(а)? Получится God класс (это не есть хорошо), но и отделить я их не могу так как код связан очень сильно.
  

В общем наставьте на путь истинный.

Comments

[Максим]

По хорошему контроллер должен иметь высокое зацепление, то есть он не должен выполнять слишком много обязанностей, а должен делегировать их другим классам, которыми он оперирует.

[Timur Asgard]

Максим, т.е. изначально разрабатывается функционал а только потом контроллер который будет оперировать этим функционалом?

[Максим]

Вот хороший комментарий из википедии: "Начинающие программисты очень часто трактуют архитектурную модель MVC как пассивную модель MVC: модель выступает исключительно совокупностью функций для доступа к данным, а контроллер содержит бизнес-логику. В результате — код моделей по факту является средством получения данных из СУБД, а контроллер — типичным модулем, наполненным бизнес-логикой."

[Максим]

Timur Asgard, да

[Timur Asgard]

Константин, возможно пример не совсем удачный, но суть в том что есть какие то не сложные вещи но часто повторяющиеся.

[Максим]

Константин, что плохого в классах? По этом поводу даже принцип проектирования есть, называется Pure Fabrication (чистая выдумка), когда создается класс для функций, которым не нашлось места в других классах, это нормальная практика.

Answer 1

[Sergej]

Не надо называть из хендлерами.
Если брать пример $result = ['my_data' => $var];
То не надо конечно. Но я понимаю о чем вы. Хотя если оперировать объектами в полной мере, то можно создать что то типа responseMyData

Контроллер принимает реквест и отдает респонс, вызывая хендлр. Больше в нем не должно быть и строчки кода.
За исключением каких то индивидуальных реализаций. Вот пример моих контроллеров. Убрал под

Код котроллера - спойлер

<?php

class orderController extends AbstractController {

    /**
     * @ApiDoc(
     *     section="travelSystem",
     *     input=OrderRequest::class,
     *     statusCodes={
     *          200="sucess",
     *          404="Order not found"
     *     },
     *     views={"night_build"}
     * )
     * @RestDoc(
     *     security={Access::ORDER}
     * )
     * 
     * @return Response
     */
    public function orderAction(OrderRequest $orderRequest): Response
    {
        // Команда - простой объект с геттерами
        $command = new orderCommand(
            $orderRequest->getHotel(),
            $orderRequest->getCheckIn()
        );
        // Хендлер - в котором как раз и происходят все 
        // нужные нам операции по обработке
        $this->get('commandBus')->handle($command);

        return $this->responseForRest();
    }
}

Как вы видите, тут имеются свои особенности, но котроллер тоненький.
Что же происходит в текущем хендлере?
Там проверяется существование дублирующих записей (а это вызов репы и условие), далее вызывается модель для order, которая получает команды и уходит на запись. Это приходится дублировать, т.к. код по сути индивидуальный для каждого обработчика но схож по функционалу.

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

Допустим мы делаем запись чего в блог, отправляем в хендлер нашу команду или что там может быть в laravel, где происходит обработка. В обработке может быть запись в БД а так же загрузка изображения.
Вот загрузку изображения, стоит выделить в отдельный сервис.

Comments

[Timur Asgard]

действительно, как то совсем забыл про существование команд в виде геттеров

[Sergej]

Timur Asgard, у меня сеттеров вообще нет. Они инициализируются в специализированном обработчике (который ручками написан) на основе маппинга и интерфейсов.

[Timur Asgard]

а как быть с повторяющимся кодом, который выдергивает из базы данные и формирует эти данные в нормальный вид? куда такой код положить?

[Timur Asgard]

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

[Sergej]

Timur Asgard, Ну если вы пишите чистый SQL, то можно под это создать сервис.
Если работаете объектами, то можно создать абстракцию, с готовым набором, который будет расширять хендлер.

Во второму вопросу -
1) что то в сессии - это значит ручками (ведь что то это не одно и тоже)
2) идет в БД - это уже отдельный объект, который вызывается в нужном вам месте
3) Подключение к сервису - это шлюз по сути, отдельная операция с своими объектами и обработчиками

Т.е. в хендлере имеется выборка сессии, вызов объекта по обработки данных в БД (хотя необязательно.), затем вызов объекта шлюза и отдаем готовое пользователю,

Если честно, без кода, ТЗ и юзерстори, тяжело так сходу в пятницу ночью ответить верно)

[Timur Asgard]

SharkMan, быть может набросаете псевдокод по второму примеру? Думаю на этом от вас отстану ;)
ЗЫ могу на пиво подбросить несколько монеток, пишите реквизиты на почту timur.asgard at gmail.com

[Sergej]

Timur Asgard,
Код из головы, мог и ошибиться где то в синтаксисе, все же тут писать, это не в ide )
Это просто пример ваших операций =)

class TestDataHandler extends AbstractHandler {

    /** @var RepositoryManagerInterface */
    protected $repositoryManager;

    /** @var SessionManagerInterface */
    protected $sessionManager;

    /** @var SessionDataModifyInterface */
    protected $sessionDataModify;

    public function __construct (
        RepositoryManagerInterface $repository, 
        SessionManagerInterface $sessionManager,
        SessionDataModifyInterface $sessionDataModify
    ) 
    {
        $this->repositoryManager = $repository
        $this->sessionManager = $sessionManager;
        $this->sessionDataModify = $sessionDataModify;
    }

    
    public function handle($command)
    {
        // берет то что в сессии, что то с этими данными делает
        $users = $this->sessionDataModify->sort(
            $this->sessionManage->getUsers()
        );

        // отом это дело идет в базу и оттуда берутся данные
        $repository = $this->repositoryManager->getRepository(Users::class); 
        // метод в объекте репозитория, польчаем пользователей
        if (!$usersList = $repository->findUsers($users)) { 
            // исключение
        }

        // записывая новые данные
        $model = new YourModel(
            $command->getId(),
            $command->getYourParam()
            //....
        );
        $this->repositoryManager->save($model);

        // , затем идет подключение к стороннему сервису и что то делает
        $response = $this->gate->push($usersList);
        // возвразаем все в контроллер и далее уже в его респонс
        return new ResponseDataFromGate($response)
    }
}