Clean Code на PHP: принципы и примеры для начинающих

Что такое Clean Code и почему это важно для PHP-разработчика?

Clean Code (Чистый код) — это не просто модный термин, а философия программирования, которая помогает создавать понятный, легко поддерживаемый и расширяемый код. Для начинающих PHP-разработчиков освоение принципов чистого кода — это инвестиция в своё будущее. Чистый код уменьшает количество ошибок, ускоряет работу в команде и делает процесс разработки более приятным.

В этой статье мы разберём основные принципы Clean Code на PHP с конкретными примерами. Вы узнаете, как превратить хаотичный «спагетти-код» в структурированную и понятную программу.

Принцип 1: Говорящие имена переменных и функций

Первое правило чистого кода — имена должны отвечать на вопросы «Что это?» или «Что делает этот метод?». Избегайте однобуквенных переменных (кроме счётчиков циклов) и сокращений, которые понятны только вам.

Плохой пример:

<?php
$a = 5;
$b = 10;
$c = $a + $b;

function calc($x, $y) {
    return $x * $y;
}
?>

Хороший пример (Clean Code):

<?php
$productPrice = 5;
$taxRate = 10;
$totalPrice = $productPrice + $taxRate;

function calculateTotalWithTax(float $price, float $tax): float {
    return $price + ($price * $tax / 100);
}
?>

Правила именования:

• Переменные и свойства — существительные ($userName, $orderStatus)
• Функции и методы — глаголы (getUser(), saveOrder())
• Булевы переменные — префикс is, has, can ($isActive, $hasPermission)
• Избегайте сокращений: $usrAddr → $userAddress

Принцип 2: Маленькие функции с одной ответственностью

Каждая функция должна делать только одну вещь. Если функция выполняет несколько действий — разбейте её на более мелкие. Это улучшает читаемость и упрощает тестирование.

Плохой пример (функция делает слишком много):

<?php
function processUserData(array $user): void {
    // Валидация
    if (empty($user['email'])) {
        throw new Exception('Email обязателен');
    }
    // Сохранение в БД
    $db = new PDO('mysql:host=localhost;dbname=test', 'root', '');
    $stmt = $db->prepare('INSERT INTO users (name, email) VALUES (?, ?)');
    $stmt->execute([$user['name'], $user['email']]);
    // Отправка email
    mail($user['email'], 'Welcome', 'Thank you for registering!');
}
?>

Хороший пример (разделение ответственности):

<?php
class UserService
{
    private UserValidator $validator;
    private UserRepository $repository;
    private EmailService $emailService;

    public function __construct(
        UserValidator $validator,
        UserRepository $repository,
        EmailService $emailService
    ) {
        $this->validator = $validator;
        $this->repository = $repository;
        $this->emailService = $emailService;
    }

    public function registerUser(array $userData): User
    {
        $this->validator->validate($userData);
        $user = $this->repository->save($userData);
        $this->emailService->sendWelcomeEmail($user);
        return $user;
    }
}
?>

Признаки того, что функция делает слишком много:

• Вы не можете дать ей простое имя
• Функция содержит более 20-30 строк
• В теле функции есть комментарии, разделяющие блоки кода
• Функция имеет более 3-4 параметров

Принцип 3: Избегайте глубокой вложенности и «магических чисел»

Глубокая вложенность (if внутри if внутри if) — главный враг читаемости. Используйте ранний возврат (early return) и выносите сложные условия в отдельные функции.

Плохой пример (глубокая вложенность):

<?php
function processOrder(array $order): void
{
    if ($order['status'] === 'pending') {
        if ($order['amount'] > 0) {
            if ($order['user']['is_active']) {
                // 50 строк логики
                echo 'Processing...';
            }
        }
    }
}
?>

Хороший пример (early return и guard clauses):

<?php
function processOrder(array $order): void
{
    if ($order['status'] !== 'pending') {
        return;
    }
    if ($order['amount'] <= 0) {
        throw new InvalidArgumentException('Amount must be positive');
    }
    if (!$order['user']['is_active']) {
        throw new RuntimeException('User is not active');
    }
    // Основная логика без лишней вложенности
    echo 'Processing...';
}
?>

Избегайте магических чисел:

<?php
// Плохо
if ($user->getAge() >= 18) {
    echo 'Adult';
}

// Хорошо
const ADULT_AGE = 18;
if ($user->getAge() >= ADULT_AGE) {
    echo 'Adult';
}
?>

Принцип 4: Комментарии — это запах кода

Чистый код не требует комментариев для объяснения того, что он делает. Хороший код говорит сам за себя. Комментарии оправданы только для объяснения почему было принято то или иное решение, а не что делает код.

Плохой пример (комментарий объясняет очевидное):

<?php
// Увеличиваем счётчик на 1
$counter = $counter + 1;

// Получаем пользователя по ID
function getUserById(int $id) {
    // ...
}
?>

Хороший пример (комментарий объясняет бизнес-логику):

<?php
// Коэффициент 1.2 используется для учёта налога на роскошь
// в соответствии с законом № 458-ФЗ от 01.01.2023
const LUXURY_TAX_MULTIPLIER = 1.2;

// Не используем стандартный вали