PHP: Объектно-ориентированный дизайн

Пишем код правильно

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

В PHP считается, что набор принципов SOLID — это ответ на вопрос о том как правильно писать код. Но жизнь показывает, что знание этих принципов слабо помогает хорошей организации кода.

Возьмем принцип SRP (принцип единственной ответственности, S из SOLID). Он говорит следующее:

Должна быть ровно одна причина для изменения класса. Роберт Мартин.

Есть и другие формулировки, но это самая лаконичная. Что не так с этим принципом? Он очень общий. Звучит примерно как: нормально делай – нормально будет. Он не дает никаких формальных критериев, по которым можно понять, что в классе есть проблема. В статьях, посвященных этому принципу, всегда всё кажется логичным. Но только потому, что автор уже предложил разделение ответственностей. В реальной жизни всё было бы по-другому. Когда разных людей спрашиваешь об одних и тех же ситуациях, они дают совершенно разные, иногда противоположные ответы. По факту, всё сводится к некоторому внутреннему чутью конкретного программиста.

Возьмем для примера библиотеку выполнения HTTP запросов. С чего нужно начать ее проектирование?

Правильно начинать с вариантов использования. Представить себе как-будто библиотека уже написана и мы пробуем ей воспользоваться (TDD толкает именно к этому, поэтому оно так мощно работает). Перед тем, как я покажу код, попробуйте ответить на вопрос, так ли нужны классы и ООП для реализации этой библиотеки?

HTTP-сессия — это операция, у которой есть конец и начало. Нужны ли объекты для ее выражения? Нет, конечно. Для операций достаточно функций. Поэтому наша библиотека в самом простом случае может выглядеть так:

<?php

use function HTTP\get;
use function HTTP\post;

$response = get('https://ru.hexlet.io/blog');
echo $response['body'];

$response = post('https://ru.hexlet.io/users', ['name' => 'tolya', 'email' => 'tolya@example.com']);
echo $response['statusCode'];

Теперь, когда готов интерфейс библиотеки, можно приступать к её реализации. Насколько важно как она выполнена внутри? Откровенно говоря, не важно. Внутренности останутся внутренностями, и никто про них не узнает, а их размер никогда не станет слишком большим (это всего лишь http библиотека). Это значит, что мы в любой момент можем их переписать. И делать это лучше не до, а после, когда накопится опыт поддержки и опыт использования. Только в этом случае появится настоящее понимание того, как лучше структурировать библиотеку внутри.

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

Если бы мы работали в JavaScript, то пример выше и стал бы реальной HTTP-библиотекой, вы можете убедиться сами, что самая популярная http-библиотека axios — это, действительно, набор функций:

import axios from 'axios';

await axios.get('https://ru.hexlet.io/users');

await axios.post('https://ru.hexlet.io/users', {
  firstName: 'Fred',
  lastName: 'Flintstone',
});

Но в PHP принято создавать классы. Во многом из-за автозагрузки и принятой модели работы. Поэтому перепишем наш интерфейс выше на объектный.

<?php
use HTTP;

// http://docs.guzzlephp.org/en/stable/
$client = new HTTP\Client();
$response = $client->get('https://ru.hexlet.io/users');
echo $response->getBody();

$response = $client->post('https://ru.hexlet.io/users', [
    'firstName' => 'Fred',
    'lastName' => 'Flintstone',
]);
echo $response->getStatusCode();

Какими принципами нужно руководствоваться, чтобы понять внутреннюю архитектуру и количество классов? Для старта достаточно здравого смысла. У нас есть сам клиент, который представлен объектом (но его состояние – это конфигурация, а не запросы и ответы), и есть результат http-запроса. Результат представлен объектом, который возвращается после выполнения запроса. Внутри него хранится вся информация по взаимодействию с сервером, например, отправленные и принятые заголовки, код и тело ответа.

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

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

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

<?php

// Делать ли Reporter абстракцией данных (то есть объектом, описывающим конкретный отчет)
// или нет, это большой вопрос.
// По умолчанию так делать не стоит, иначе весь код превратится
// в бесполезное (new Reporter('path/to/file'))->generate()
$reporter = new Reporter();
$report = $reporter->generate('/path/to/report');

На что стоит обратить внимание в первую очередь? На то, что этот класс одновременно выполняет грязную работу (с побочными эффектами): читает файл с диска, так и чистую: обрабатывает данные для формирования отчета. Это не значит, что надо кидаться переписывать код, но это то, на что надо обращать внимание в первую очередь. Код выше, сложнее в тестировании и отладке, чем код с разделенными операциями по побочным эффектам. Кроме того, если вынести чтение файла наружу, то репортер станет значительно более универсальным. Он сможет работать с данными, которые лежат не только на диске, но и были загружены каким-то другим способом, например, по http через форму. После несложных манипуляций, получаем такой код:

<?php

$reporter = new Reporter();
$data = file_get_contents('/path/to/report');
$report = $reporter->generate($data);
$report = $reporter->generate(file_get_contents('https://ru.hexlet.io/reporters/3'));

Остальные принципы требуют знаний, которые приобретаются в следующем курсе: полиморфизм в php. Там они и рассматриваются.


Дополнительные материалы

  1. Снесите это немедленно (Андрей Аксенов). Доклад с конференции HighLoad.
  2. Архитектура и ООП

<span class="translation_missing" title="translation missing: ru.web.courses.lessons.mentors.mentor_avatars">Mentor Avatars</span>

Остались вопросы? Задайте их в разделе «Обсуждение»

Вам ответят команда поддержки Хекслета или другие студенты.

Ошибки, сложный материал, вопросы >
Нашли опечатку или неточность?

Выделите текст, нажмите ctrl + enter и отправьте его нам. В течение нескольких дней мы исправим ошибку или улучшим формулировку.

Что-то не получается или материал кажется сложным?

Загляните в раздел «Обсуждение»:

  • задайте вопрос. Вы быстрее справитесь с трудностями и прокачаете навык постановки правильных вопросов, что пригодится и в учёбе, и в работе программистом;
  • расскажите о своих впечатлениях. Если курс слишком сложный, подробный отзыв поможет нам сделать его лучше;
  • изучите вопросы других учеников и ответы на них. Это база знаний, которой можно и нужно пользоваться.
Об обучении на Хекслете

Для полного доступа к курсу нужна профессиональная подписка

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

Получить доступ
115
курсов
892
упражнения
2241
час теории
3196
тестов

Открыть доступ

Курсы программирования для новичков и опытных разработчиков. Начните обучение бесплатно.

  • 115 курсов, 2000+ часов теории
  • 800 практических заданий в браузере
  • 250 000 студентов

Отправляя форму, вы соглашаетесь c «Политикой конфиденциальности» и «Условиями оказания услуг».

Наши выпускники работают в компаниях:

Логотип компании Альфа Банк
Логотип компании Rambler
Логотип компании Bookmate
Логотип компании Botmother

Есть вопрос или хотите участвовать в обсуждении?

Зарегистрируйтесь или войдите в свой аккаунт

Отправляя форму, вы соглашаетесь c «Политикой конфиденциальности» и «Условиями оказания услуг».