Перейти до вмісту
Leonidov.DEV

Хуки властивостей у PHP: 5 правил із прикладами

Інженерія
Хуки властивостей у PHP: 5 правил із прикладами

Хуки властивостей легко показати й легко зіпсувати. У рев’ю я бачу п’ять тих самих помилок, тому показую командам п’ять правил, кожне з кодом, який пояснює, навіщо воно. Приклади з мікрофреймворку на 728 тестів, і в будь-якому іншому проєкті вони поводяться так само.

Код: ATOM, ліцензія GPL-3.0.

Правило 1: хуки властивостей у PHP виконуються на кожне читання

Хук виглядає як властивість, а коштує як метод, і ціна методу до нього застосовується повністю. Ось хук, який робить арифметику і тому добрий:

public string $method {
    get => strtoupper($this->raw['REQUEST_METHOD'] ?? 'GET');
}

А ось хук, який поганий, і річ не в стилі:

public array $headers {
    get => $this->parseHeaders($this->raw);
}

Кожне читання заново розбирає рядок заголовків. Цикл по дванадцяти заголовках викличе його дванадцять разів, і в коді, що викликає, про це нічого не сказано. Перш ніж писати хук, порахуйте читання. Якщо хук робить справжню роботу, запам’ятовуйте результат усередині, щоб властивість поводилася як поле, яке він замінив.

Правило 2: нормалізація в сетері, один раз

Валідація й чищення, розмазані по місцях виклику, це спосіб отримати той самий email у трьох виглядах в одній таблиці. Правило ставиться там, де значення входить в об’єкт:

public string $email {
    set (string $value) {
        $this->email = strtolower(trim($value));
    }
}

Тепер нормалізується кожне присвоєння, включно з тим, яке написав розробник, що жодного разу не відкривав модель. У цьому й перевага типізованої властивості над домовленістю: правило їде разом із типом.

Правило 3: виберіть один шлях доступу

Суміш $user->name і $user->getName() в одному класі вчить наступного розробника вгадувати. Якщо властивість публічна і з хуком, гетеру роботи не лишилося, видаляйте. Якщо гетер потрібен інтерфейсу чи контракту фреймворку, лишайте гетер і не додавайте хук, що його дублює.

Одне правило, одні двері. Двоє дверей до одного значення це половина зробленого рефакторингу, що лишилася в коді.

Правило 4: жодних побічних ефектів у хуку

Гетер-хук, який пише рядок у лог, збільшує лічильник або ліниво вантажить зв’язок, перетворює читання на подію. Далі рендер сторінки надсилає лист, а трейс починається в шаблоні.

Читання мають бути дешевими й повторюваними. Запис живе в методі, ім’я якого каже, що він пише. Компілятор цього не перевірить, і саме тому перевіряє рев’ю.

Правило 5: хуки не замінюють валідацію на межі

Сетер-хук спрацьовує на присвоєння, і це не те саме, що перевірка недовіреного вводу. DTO, зібраний із $_POST, усе одно потребує валідації з повідомленням, яке людина прочитає, а колонка в базі все одно потребує обмеження.

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

Де хукам не місце

Сутності, відображені на широку таблицю. Хуки на двадцяти колонках додають шум і ховають поведінку самої ORM.

Усе, що ходить у мережу або на диск, усе, де важливий порядок читань, і все, що налагоджувач не покаже. Наберіть три імені властивостей у налагоджувачі й подивіться, які спрацювали: це і є перевірка.

Як вводити їх у наявний код

Почніть із класу, у якого вже є чотири однорядкові гетери над одним полем. Замініть це поле, прогнавши тести, і зупиніться. Хуки поширюються прикладом, а код, де половина властивостей із хуками, читається гірше за будь-який із двох однорідних варіантів.

Той самий інстинкт працює й поза межами властивостей: тримайте один механізм і робіть його читабельним. Тому роутер у тому самому фреймворку компілює таблицю маршрутів в один шаблон PCRE замість перебору списку, і тому ж правила іменування в мене достатньо строгі, щоб ім’я класу відповідало на перше питання рев’ю.

Якщо потрібне обґрунтування таких рішень, шість архітектурних патернів розбирають компроміси, а нотатка про правильні імена в коді про те, що рев’юер помічає першим.

Що почитати: нотатки про випуск PHP 8.5 і ATOM на GitHub, ліцензія GPL-3.0.