Clean Code на JavaScript: принципы и примеры на практике

Clean Code на JavaScript: принципы и примеры на практике

Чистый код — это не просто модный термин, а профессиональная необходимость. В мире JavaScript и Node.js, где проекты быстро растут и меняются, умение писать понятный и поддерживаемый код отличает опытного разработчика от новичка. В этой статье мы разберем ключевые принципы Clean Code на конкретных примерах из реальной практики.

Почему чистый код важен для JavaScript-разработчика?

JavaScript — язык с динамической типизацией, что делает его гибким, но и более подверженным ошибкам. Плохо написанный код на Node.js может превратить поддержку проекта в кошмар. Clean Code помогает:

• Сократить время на отладку и рефакторинг
• Упростить введение новых разработчиков в проект
• Уменьшить количество багов в production
• Повысить производительность команды

Давайте перейдем к конкретным принципам и примерам.

Принцип 1: Осмысленные имена переменных и функций

Самое простое и одновременно самое нарушаемое правило. Имя переменной должно отвечать на вопрос "что это?" или "зачем это?".

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

// Плохо: что такое d? что делает fn?
const d = new Date();
const fn = (a, b) => a + b;
const arr = [1, 2, 3, 4];
const x = arr.filter(i => i > 2);

Хороший пример:

// Хорошо: понятно без комментариев
const currentDate = new Date();
const sum = (firstNumber, secondNumber) => firstNumber + secondNumber;
const numbers = [1, 2, 3, 4];
const filteredNumbers = numbers.filter(number => number > 2);

Правило для Node.js: если вы работаете с асинхронными операциями, добавляйте суффиксы, указывающие на тип возвращаемого значения: getUserDataAsync, fetchPosts.

Принцип 2: Функции должны быть маленькими и делать одну вещь (KISS)

Принцип KISS (Keep It Simple, Stupid) в JavaScript критически важен. Функция не должна быть "швейцарским ножом".

Плохой пример — функция-монстр:

// Плохо: одна функция делает всё
function processUserData(user) {
    // Валидация
    if (!user.email || !user.name) {
        throw new Error('Invalid user data');
    }
    
    // Форматирование
    const formattedName = user.name.trim().toLowerCase();
    const formattedEmail = user.email.trim().toLowerCase();
    
    // Сохранение в БД
    db.save({ name: formattedName, email: formattedEmail });
    
    // Отправка email
    emailService.sendWelcome(formattedEmail);
    
    // Логирование
    logger.info(`User ${formattedName} processed`);
}

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

// Хорошо: каждая функция отвечает за одну задачу
function validateUserData(user) {
    if (!user.email || !user.name) {
        throw new Error('Invalid user data');
    }
}

function formatUserData(user) {
    return {
        name: user.name.trim().toLowerCase(),
        email: user.email.trim().toLowerCase()
    };
}

async function processUserRegistration(userData) {
    validateUserData(userData);
    const formattedUser = formatUserData(userData);
    
    await db.save(formattedUser);
    await emailService.sendWelcome(formattedUser.email);
    logger.info(`User ${formattedUser.name} processed`);
    
    return formattedUser;
}

Такой код легче тестировать, отлаживать и расширять.

Принцип 3: Избегайте магических чисел и строк (DRY)

"Магические числа" — это литералы, смысл которых неочевиден. Выносите их в константы с понятными именами.

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

// Плохо: что за 1000? почему 60?
setTimeout(() => {
    if (user.age > 65) {
        applyDiscount(30);
    }
}, 1000);

Хороший пример:

// Хорошо: константы с именами
const MILLISECONDS_IN_SECOND = 1000;
const PENSION_AGE = 65;
const SENIOR_DISCOUNT_PERCENT = 30;

const DELAY_BEFORE_CHECK = 1 * MILLISECONDS_IN_SECOND;

setTimeout(() => {
    if (user.age > PENSION_AGE) {
        applyDiscount(SENIOR_DISCOUNT_PERCENT);
    }
}, DELAY_BEFORE_CHECK);

В Node.js это особенно актуально для конфигураций, таймаутов и лимитов.

Принцип 4: Обработка ошибок — не скрывайте проблемы

Пустые блоки catch — зло. Ошибки нужно либо обрабатывать, либо пробрасывать выше.

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

// Плохо: ошибка "проглочена"
try {
    const data = await fetchDataFromAPI();
    processData(data);
} catch (error) {
    // Ничего не делаем — ошибка скрыта
}

Хороший пример:

// Хорошо: ошибка обработана или проброшена
try {
    const data = await fetchDataFromAPI();
    processData(data);
} catch (error) {
    logger.error('Failed to fetch data from API', {
        error: error.message,
        timestamp: new Date().toISOString()
    });
    
    // Пробрасываем, если не можем обработать
    throw new Error(`Data fetch failed: ${error.message}`);
}

Используйте пользовательские классы ошибок для лучшей читаемости:

class ValidationError extends Error {
    constructor(message) {
        super(message);
        this.name = 'ValidationError';
    }
}

class DatabaseError extends Error {
    constructor(message, originalError) {
        super(message);
        this.name = 'DatabaseError';
        this.originalError = originalError;
    }
}

Принцип 5: Комментарии — "почему", а не "что"

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

Плохой комментарий:

// Плохо: комментарий повторяет код
// Увеличиваем счетчик на 1
counter = counter + 1;

// Получаем email пользователя
const email = user.email;

Хороший комментарий:

// Хорошо