Что такое CommonJS-модуль

1️⃣ Как кратко ответить

CommonJS — это спецификация для модульной системы в JavaScript, которая позволяет организовывать код в отдельные файлы и управлять зависимостями между ними. CommonJS-модули используются в среде Node.js и экспортируют функциональность с помощью module.exports, а импортируют с помощью require().

2️⃣ Подробное объяснение темы

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

Зачем нужны модули?

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

Как работает CommonJS?

CommonJS определяет два основных метода для работы с модулями: require() и module.exports.

• require(): Это функция, которая используется для импорта функциональности из другого модуля. Она принимает путь к модулю и возвращает объект, который модуль экспортирует.

• module.exports: Это объект, который используется для экспорта функциональности из модуля. Все, что присваивается module.exports, становится доступным для других модулей, которые импортируют данный модуль.

Пример использования CommonJS

Рассмотрим простой пример, чтобы понять, как работают CommonJS-модули.

Файл math.js — модуль, который экспортирует функции

// math.js
​
// Функция для сложения двух чисел
function add(a, b) {
    return a + b;
}
​
// Функция для вычитания одного числа из другого
function subtract(a, b) {
    return a - b;
}
​
// Экспортируем функции, чтобы они были доступны в других модулях
module.exports = {
    add: add,
    subtract: subtract
};

В этом файле мы определяем две функции: add и subtract. Затем мы экспортируем их, присваивая объект с этими функциями module.exports. Это делает их доступными для других модулей.

Файл app.js — модуль, который импортирует и использует функции

// app.js
​
// Импортируем модуль math.js
const math = require('./math');
​
// Используем импортированные функции
const sum = math.add(5, 3); // Результат: 8
const difference = math.subtract(5, 3); // Результат: 2
​
// Выводим результаты
console.log('Sum:', sum);
console.log('Difference:', difference);

В этом файле мы используем require() для импорта модуля math.js. Функция require() возвращает объект, который был экспортирован из math.js. Мы можем использовать методы add и subtract, как если бы они были определены в этом файле.

Где применяется CommonJS?

CommonJS широко используется в Node.js, так как это стандартная модульная система для этой среды. Она позволяет разработчикам создавать серверные приложения, которые легко поддерживать и расширять. В браузерной среде CommonJS не поддерживается нативно, но может быть использован с помощью инструментов сборки, таких как Browserify или Webpack, которые преобразуют CommonJS-модули в формат, поддерживаемый браузерами.

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