Понимание module.exports и экспорта в Node.js

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

В этой статье я рассмотрю, как работать с модулями в Node.js, сосредоточив внимание на том, как их экспортировать и использовать.

Различные форматы модулей

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

• Формат определения асинхронного модуля (AMD) используется в браузерах и использует функцию define
• Формат CommonJS (CJS) используется в Node.js и использует requiremodule.exports Экосистема npm построена на этом формате.
• Формат модуля ES (ESM) . Начиная с ES6 (ES2015), JavaScript поддерживает собственный формат модулей. Он использует ключевое слово export
• Формат System.register был разработан для поддержки модулей ES6 в ES5.
• Формат универсального определения модуля (UMD) можно использовать как в браузере, так и в Node.js. Это полезно, когда модуль должен быть импортирован несколькими различными загрузчиками модулей.

Обратите внимание, что эта статья посвящена исключительно формату CommonJS , стандарту Node.js. Если вы хотите ознакомиться с любым из других форматов, я рекомендую эту статью автора SitePoint Юргена Ван де Моера.

Требуется модуль

Node.js поставляется с набором встроенных модулей, которые мы можем использовать в нашем коде без необходимости их установки. Для этого нам потребуется модуль с ключевым словом import Затем его можно использовать для вызова любых методов, предоставляемых модулем.

Например, чтобы вывести список содержимого каталога, вы можете использовать модуль файловой системы и метод require

 readdir

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

Создание и экспорт модуля

Теперь давайте посмотрим, как создать наш собственный модуль и экспортировать его для использования в других местах нашей программы. Начните с создания файла const fs = require('fs');
const folderPath = '/home/jim/Desktop/';

fs.readdir(folderPath, (err, files) => {
files.forEach(file => {
console.log(file);
});
});

 user.js

Теперь создайте файл const getName = () => {
return 'Jim';
};

exports.getName = getName;

 index.js

Запустите программу, используя const user = require('./user');
console.log(`User: ${user.getName()}`);


 node index.js

Так что здесь произошло? Что ж, если вы посмотрите на файл User: Jim
user.jsgetName Затем в файле exports Также обратите внимание, что в операторе index.jsrequire Также обратите внимание, что нет необходимости добавлять расширение файла.

Экспорт нескольких методов и значений

Мы можем экспортировать несколько методов и значений одним и тем же способом:

 ./

И в const getName = () => {
return 'Jim';
};

const getLocation = () => {
return ‘Munich’;
};

const dateOfBirth = ‘12.01.1982’;

exports.getName = getName;
exports.getLocation = getLocation;
exports.dob = dateOfBirth;

 index.js

Код выше производит это:

 const user = require('./user');
console.log(
  `${user.getName()} lives in ${user.getLocation()} and was born on ${user.dob}.`
);

 dob

 exports.getName = () => {
  return 'Jim';
};

exports.getLocation = () => {
  return 'Munich';
};

exports.dob = '12.01.1982';

 const { getName, dob } = require('./user');
console.log(
  `${getName()} was born on ${dob}.`
);

 module.exports

 index.js

 const User = require('./user');
const jim = new User('Jim', 37, 'jim@example.com');

console.log(jim.getUserStats());

 exports

 module

 const { getName, dob } = require('./user');
console.log(
  `${getName()} was born on ${dob}.`
);

 console.log(module);

 Module {
  id: '.',
  exports: {},
  parent: null,
  filename: '/home/jim/Desktop/index.js',
  loaded: false,
  children: [],
  paths:
   [ '/home/jim/Desktop/node_modules',
     '/home/jim/node_modules',
     '/home/node_modules',
     '/node_modules' ] }

 // index.js
exports.foo = 'foo';
console.log(module);

 Module {
  id: '.',
  exports: { foo: 'foo' },
  ...

 exports.foo = 'foo';
module.exports.bar = 'bar';

 exports.foo = 'foo';
module.exports = () => { console.log('bar'); };