Как правильно передавать ошибки вверх по дереву вызовов классов?

Question

[Алексей Коновалов]

Всем привет! Есть некий файл входа и выхода, пускай это будет index.php
В нем мы определяем какой контроллер запустить а так же отдаем данные обратно пользователю с помощью общего класса Response, который хранит в себе все, что нужно вернуть:

• Общие ошибки
  
• Ошибки ввода в поля
  
• Готовые данные которые нужно вернуть
  

Ошибки и данные в класс добавляются с помощью методов:

$Response->addErr("Сообщение", 455214); // сообщение и код ошибки нужен для фронтенда
$Response->addFieldErr("title", "Сообщение"); // название поля с ошибкой и сообщение об ошибке
$Response->addData("items", $posts_array); // json массив постов
$Response->addData("attachments", $attachments_array); // json массив вложений к постам

Ну а вконце index.php просто выполняем функцию: $Response->returnResponse();

Но вот проблема тут.
Например, нужно добавить комментарий к посту и действия кода следующие (мы отправили ID поста и текст комментария):
index.php вызывает контроллер AddCommentInPost, контроллер вызывает:

• Модель PostModel, которая пытается получить пост, к которому мы добавляем комментарий для того, чтобы проверить существует ли такой пост PostsModel->getPostById($_GET['id']);
  
• Метод модели CommentsModel, который валидирует входящие данные и добавляет комментарий в БД
  
• Если все хорошо, то модель CommentsModel возвращает объект комментария CommentEntity
  

Так вот... Что если при валидации произошла ошибка? Как мне вернуть поля с ошибками в контроллер AddCommentInPost? Ведь я не могу вызывать класс Response из модели, т.к. модель не должна ничего знать о внешнем мире.

Но при такой задаче у меня еще есть идея.... например, чтобы CommentsModel в случае любой ошибки отдавало false, а класс AddCommentInPost, видя, что пришел не объект а false понимал, что произошла какая-то ошибка и уже с помощью метода CommentsModel::getErrors() получал и обрабатывал массив с ошибками, которые сохранила в себе модель.
У нас получилось такое дерево: index.php - AddCommentInPost - CommentsModel::getErrors()
И получается что все хорошо, т.к. AddCommentInPost имеет связь с Response и может записать туда ошибки. НО ЧТО ЕСЛИ бы между AddCommentInPost и CommentsModel был еще один класс, как тогда передать ошибки из CommentsModel в AddCommentInPost?

Answer 1

[Александр Новиков]

Использовать Exceptions
php.net/manual/ru/language.exceptions.php
В случае если выбросить Exception в любом месте дерева вызовов он как раз будет пробираться до самого верха пока не попадется в catch блок
В месте где формируется сообщение (в контроллере) отлавливать и приводить в нужный вид

Comments

[Алексей Коновалов]

Спасибо за отклик! Я прочитал много статей про исключения, но везде рекомендуется использовать их только в случае если ошибка непредвиденная.
Вероятно должен быть более красивый способ. Или это и есть красивый способ? Мне важно понять, чтобы я потом не споткнулся о какие-то камни возможные, которых не видно сейчас

[Александр Новиков]

Алексей Коновалов, а какая ошибка "предвиденная"?
по сути да, можно написать код чуть иначе, без Exceptions в контроллере, в контроллере только модель и сервис, провести какой-то кастомный 'Validate', делать массив 'errors', проверять его на длину и тд.
Но возникают вопросы. Что тогда есть ошибка? Возвращенный из функции false? null? пустой массив? массив с ключом 'errors'? массив с ключом 'errors' где значение по ключу не пустой массив?

Exceptions - это базовая конструкция языка, которой точно не стоит пренебрегать, и бояться пользоваться. Явная ошибка всегда лучше чем неявная
Прокинутый неотловленный Exception всплывет еще на staging окружении, в то время как кастомные 'errors' могут жить в коде незамеченными на проде годами.
Конкретно нормально именованный Exception еще и коду читаемости добавляет

Чисто интереса ради в текущем проекте сделал поиск по вхождениям Exceptions в кодовую базу - 3038 вхождений (включая выбрасывание новых и отлов, в том числе и в vendor). Проект среднего размера, чуть меньше 5 лет ему

Опять же случаи возникновения эксепшенов можно собирать и анализировать (https://sentry.io/welcome/)

Статьи на "почитать" :
https://habr.com/post/264417/
https://www.alainschlesser.com/structuring-php-exc...

[Imrahil]

Алексей Коновалов,
прочитайте https://www.ozon.ru/context/detail/id/33506422/
Там прекрасно описано почему использовать throw хороший правильный и надежный выбор

Answer 2

[Юрий]

делать явную валидацию, а не как побочный эффект.

$errors = $commentsModel->validate($comment);
if (!$errors) {
    $status = $commentsModel->save($comment);
}

Comments

[Алексей Коновалов]

В случае если бы между AddCommentInPost и CommentsModel был еще один или несколько классов - проблема бы осталась.

[Imrahil]

это методология PEAR_Error, в современном PHP лучше генерировать исколючения