Модулі JavaScript: Посібник для початківців

Якщо ви новачок у JavaScript, такі жаргони, як "модульні пакети проти завантажувачів модулів", "Webpack проти Browserify" та "AMD проти CommonJS", можуть швидко стати надзвичайними.

Система модулів JavaScript може залякувати, але розуміння її життєво важливо для веб-розробників.

У цій публікації я розпакую ці модні слова для вас простою англійською мовою (і декількома зразками коду). Сподіваюся, вам це буде корисно!

Примітка: для спрощення це буде розділено на два розділи: Частина 1 заглибиться в пояснення того, що таке модулі та чому ми їх використовуємо. Частина 2 (опублікована наступного тижня) розповість про те, що означає об’єднувати модулі та різні способи це зробити.

Частина 1: Чи може хтось пояснити, що це за модулі?

Хороші автори ділять свої книги на глави та розділи; хороші програмісти ділять свої програми на модулі.

Як і глава книги, модулі - це просто скупчення слів (або коду, залежно від обставин).

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

Навіщо використовувати модулі?

Використання модулів має багато переваг на користь розлогій, взаємозалежної кодової бази. Найважливішими, на мій погляд, є:

1) Ремонтопридатність: За визначенням модуль є автономним. Добре розроблений модуль має на меті максимально зменшити залежності від частин кодової бази, щоб він міг самостійно рости та вдосконалюватися. Оновлення одного модуля стає набагато простішим, коли модуль відокремлений від інших фрагментів коду.

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

2) Розміщення імен: у JavaScript змінні поза сферою дії функції верхнього рівня є загальними (тобто кожен може отримати до них доступ). Через це загальноприйнятим є “забруднення простору імен”, де абсолютно не пов’язаний код поділяє глобальні змінні.

Спільне використання глобальних змінних між непов’язаним кодом є великим ні-ні у розробці.

Як ми побачимо далі в цій публікації, модулі дозволяють нам уникнути забруднення простору імен, створюючи приватний простір для наших змінних.

3) Багаторазове використання: Давайте будемо чесними тут: ми всі скопіювали код, який ми раніше писали в нові проекти в той чи інший момент. Наприклад, уявімо, що ви скопіювали деякі утилітні методи, які ви написали з попереднього проекту, у свій поточний проект.

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

Очевидно, це величезна втрата часу. Чи не було б набагато простіше, якби існував - зачекайте - модуль, який ми можемо використовувати знову і знову?

Як ви можете включити модулі?

Є багато способів включити модулі у ваші програми. Давайте пройдемося до кількох з них:

Шаблон модуля

Шаблон Module використовується для імітації концепції класів (оскільки JavaScript власне не підтримує класи), щоб ми могли зберігати як загальнодоступні, так і приватні методи та змінні в одному об'єкті - подібно до того, як класи використовуються в інших мовах програмування, таких як Java або Python. Це дозволяє нам створити загальнодоступний API для методів, які ми хочемо представити світові, одночасно інкапсулюючи приватні змінні та методи в область закриття.

Існує кілька способів виконати шаблон модуля. У цьому першому прикладі я використаю анонімне закриття. Це допоможе нам досягти нашої мети, помістивши весь наш код в анонімну функцію. (Пам'ятайте: у JavaScript функції - це єдиний спосіб створити нову область.)

Приклад 1: Анонімне закриття

(function () { // We keep these variables private inside this closure scope var myGrades = [93, 95, 88, 0, 55, 91]; var average = function() { var total = myGrades.reduce(function(accumulator, item) { return accumulator + item}, 0); return 'Your average grade is ' + total / myGrades.length + '.'; } var failing = function(){ var failingGrades = myGrades.filter(function(item) { return item < 70;}); return 'You failed ' + failingGrades.length + ' times.'; } console.log(failing()); }()); // ‘You failed 2 times.’

За допомогою цієї конструкції наша анонімна функція має власне середовище оцінки або “закриття”, і ми негайно оцінюємо її. Це дозволяє нам приховувати змінні з батьківського (глобального) простору імен.

Приємним у цьому підході є те, що ви можете використовувати локальні змінні всередині цієї функції, не випадково перезаписуючи існуючі глобальні змінні, але все одно отримуючи доступ до глобальних змінних, наприклад:

var global = 'Hello, I am a global variable :)'; (function () { // We keep these variables private inside this closure scope var myGrades = [93, 95, 88, 0, 55, 91]; var average = function() { var total = myGrades.reduce(function(accumulator, item) { return accumulator + item}, 0); return 'Your average grade is ' + total / myGrades.length + '.'; } var failing = function(){ var failingGrades = myGrades.filter(function(item) { return item < 70;}); return 'You failed ' + failingGrades.length + ' times.'; } console.log(failing()); console.log(global); }()); // 'You failed 2 times.' // 'Hello, I am a global variable :)'

Зверніть увагу, що дужки навколо анонімної функції є обов’язковими, оскільки оператори, які починаються з ключового слова function , завжди вважаються оголошеннями функцій (пам’ятайте, ви не можете мати безіменних оголошень функцій у JavaScript.) Отже, оточуючі дужки створюють вираз функції замість цього. Якщо вам цікаво, ви можете прочитати більше тут.

Приклад 2: Глобальний імпорт

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

(function (globalVariable) { // Keep this variables private inside this closure scope var privateFunction = function() { console.log('Shhhh, this is private!'); } // Expose the below methods via the globalVariable interface while // hiding the implementation of the method within the // function() block globalVariable.each = function(collection, iterator) { if (Array.isArray(collection)) { for (var i = 0; i < collection.length; i++) { iterator(collection[i], i, collection); } } else { for (var key in collection) { iterator(collection[key], key, collection); } } }; globalVariable.filter = function(collection, test) { var filtered = []; globalVariable.each(collection, function(item) { if (test(item)) { filtered.push(item); } }); return filtered; }; globalVariable.map = function(collection, iterator) { var mapped = []; globalUtils.each(collection, function(value, key, collection) { mapped.push(iterator(value)); }); return mapped; }; globalVariable.reduce = function(collection, iterator, accumulator) { var startingValueMissing = accumulator === undefined; globalVariable.each(collection, function(item) { if(startingValueMissing) { accumulator = item; startingValueMissing = false; } else { accumulator = iterator(accumulator, item); } }); return accumulator; }; }(globalVariable)); 

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

Приклад 3: Інтерфейс об’єкта

Ще один підхід полягає у створенні модулів з використанням автономного інтерфейсу об’єкта, наприклад:

var myGradesCalculate = (function () { // Keep this variable private inside this closure scope var myGrades = [93, 95, 88, 0, 55, 91]; // Expose these functions via an interface while hiding // the implementation of the module within the function() block return { average: function() { var total = myGrades.reduce(function(accumulator, item) { return accumulator + item; }, 0); return'Your average grade is ' + total / myGrades.length + '.'; }, failing: function() { var failingGrades = myGrades.filter(function(item) { return item < 70; }); return 'You failed ' + failingGrades.length + ' times.'; } } })(); myGradesCalculate.failing(); // 'You failed 2 times.' myGradesCalculate.average(); // 'Your average grade is 70.33333333333333.'

Як бачите, цей підхід дозволяє нам вирішити, які змінні / методи ми хочемо залишити приватними (наприклад, myGrades ), а які змінні / методи ми хочемо виставити, помістивши їх у оператор return (наприклад, середнє значення та невдача ).

Приклад 4: Розкриття шаблону модуля

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

var myGradesCalculate = (function () { // Keep this variable private inside this closure scope var myGrades = [93, 95, 88, 0, 55, 91]; var average = function() { var total = myGrades.reduce(function(accumulator, item) { return accumulator + item; }, 0); return'Your average grade is ' + total / myGrades.length + '.'; }; var failing = function() { var failingGrades = myGrades.filter(function(item) { return item < 70; }); return 'You failed ' + failingGrades.length + ' times.'; }; // Explicitly reveal public pointers to the private functions // that we want to reveal publicly return { average: average, failing: failing } })(); myGradesCalculate.failing(); // 'You failed 2 times.' myGradesCalculate.average(); // 'Your average grade is 70.33333333333333.'

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

  • Вивчення шаблонів дизайну JavaScript Адді Османі: скарбниця деталей у вражаюче стислому прочитанні
  • Адекватно добре від Бена Черрі: корисний огляд із прикладами вдосконаленого використання шаблону модуля
  • Блог Карла Денлі: огляд шаблонів модулів та ресурси для інших шаблонів JavaScript.

CommonJS та AMD

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

While each approach is effective in its own way, they have their downsides.

For one, as a developer, you need to know the right dependency order to load your files in. For instance, let’s say you’re using Backbone in your project, so you include the script tag for Backbone’s source code in your file.

However, since Backbone has a hard dependency on Underscore.js, the script tag for the Backbone file can’t be placed before the Underscore.js file.

As a developer, managing dependencies and getting these things right can sometimes be a headache.

Another downside is that they can still lead to namespace collisions. For example, what if two of your modules have the same name? Or what if you have two versions of a module, and you need both?

So you’re probably wondering: can we design a way to ask for a module’s interface without going through the global scope?

Fortunately, the answer is yes.

There are two popular and well-implemented approaches: CommonJS and AMD.

CommonJS

CommonJS is a volunteer working group that designs and implements JavaScript APIs for declaring modules.

A CommonJS module is essentially a reusable piece of JavaScript which exports specific objects, making them available for other modules to require in their programs. If you’ve programmed in Node.js, you’ll be very familiar with this format.

With CommonJS, each JavaScript file stores modules in its own unique module context (just like wrapping it in a closure). In this scope, we use the module.exports object to expose modules, and require to import them.

When you’re defining a CommonJS module, it might look something like this:

function myModule() { this.hello = function() { return 'hello!'; } this.goodbye = function() { return 'goodbye!'; } } module.exports = myModule;

We use the special object module and place a reference of our function into module.exports. This lets the CommonJS module system know what we want to expose so that other files can consume it.

Then when someone wants to use myModule, they can require it in their file, like so:

var myModule = require('myModule'); var myModuleInstance = new myModule(); myModuleInstance.hello(); // 'hello!' myModuleInstance.goodbye(); // 'goodbye!'

There are two obvious benefits to this approach over the module patterns we discussed before:

1. Avoiding global namespace pollution

2. Making our dependencies explicit

Moreover, the syntax is very compact, which I personally love.

Another thing to note is that CommonJS takes a server-first approach and synchronously loads modules. This matters because if we have three other modules we need to require, it’ll load them one by one.

Now, that works great on the server but, unfortunately, makes it harder to use when writing JavaScript for the browser. Suffice it to say that reading a module from the web takes a lot longer than reading from disk. For as long as the script to load a module is running, it blocks the browser from running anything else until it finishes loading. It behaves this way because the JavaScript thread stops until the code has been loaded. (I’ll cover how we can work around this issue in Part 2 when we discuss module bundling. For now, that’s all we need to know).

AMD

CommonJS is all well and good, but what if we want to load modules asynchronously? The answer is called Asynchronous Module Definition, or AMD for short.

Loading modules using AMD looks something like this:

define(['myModule', 'myOtherModule'], function(myModule, myOtherModule) { console.log(myModule.hello()); });

What’s happening here is that the define function takes as its first argument an array of each of the module’s dependencies. These dependencies are loaded in the background (in a non-blocking manner), and once loaded define calls the callback function it was given.

Next, the callback function takes, as arguments, the dependencies that were loaded — in our case, myModule and myOtherModule — allowing the function to use these dependencies. Finally, the dependencies themselves must also be defined using the define keyword.

For example, myModule might look like this:

define([], function() { return { hello: function() { console.log('hello'); }, goodbye: function() { console.log('goodbye'); } }; });

So again, unlike CommonJS, AMD takes a browser-first approach alongside asynchronous behavior to get the job done. (Note, there are a lot of people who strongly believe that dynamically loading files piecemeal as you start to run code isn’t favorable, which we’ll explore more when in the next section on module-building).

Aside from asynchronicity, another benefit of AMD is that your modules can be objects, functions, constructors, strings, JSON and many other types, while CommonJS only supports objects as modules.

That being said, AMD isn’t compatible with io, filesystem, and other server-oriented features available via CommonJS, and the function wrapping syntax is a bit more verbose compared to a simple require statement.

UMD

For projects that require you to support both AMD and CommonJS features, there’s yet another format: Universal Module Definition (UMD).

UMD essentially creates a way to use either of the two, while also supporting the global variable definition. As a result, UMD modules are capable of working on both client and server.

Here’s a quick taste of how UMD goes about its business:

(function (root, factory) { if (typeof define === 'function' && define.amd) { // AMD define(['myModule', 'myOtherModule'], factory); } else if (typeof exports === 'object') { // CommonJS module.exports = factory(require('myModule'), require('myOtherModule')); } else { // Browser globals (Note: root is window) root.returnExports = factory(root.myModule, root.myOtherModule); } }(this, function (myModule, myOtherModule) { // Methods function notHelloOrGoodbye(){}; // A private method function hello(){}; // A public method because it's returned (see below) function goodbye(){}; // A public method because it's returned (see below) // Exposed public methods return { hello: hello, goodbye: goodbye } }));

For more examples of UMD formats, check out this enlightening repo on GitHub.

Native JS

Phew! Are you still around? I haven’t lost you in the woods here? Good! Because we have *one more* type of module to define before we’re done.

As you probably noticed, none of the modules above were native to JavaScript. Instead, we’ve created ways to emulate a modules system by using either the module pattern, CommonJS or AMD.

Fortunately, the smart folks at TC39 (the standards body that defines the syntax and semantics of ECMAScript) have introduced built-in modules with ECMAScript 6 (ES6).

ES6 offers up a variety of possibilities for importing and exporting modules which others have done a great job explaining — here are a few of those resources:

  • jsmodules.io
  • exploringjs.com

What’s great about ES6 modules relative to CommonJS or AMD is how it manages to offer the best of both worlds: compact and declarative syntax and asynchronous loading, plus added benefits like better support for cyclic dependencies.

Probably my favorite feature of ES6 modules is that imports are live read-only views of the exports. (Compare this to CommonJS, where imports are copies of exports and consequently not alive).

Here’s an example of how that works:

// lib/counter.js var counter = 1; function increment() { counter++; } function decrement() { counter--; } module.exports = { counter: counter, increment: increment, decrement: decrement }; // src/main.js var counter = require('../../lib/counter'); counter.increment(); console.log(counter.counter); // 1

In this example, we basically make two copies of the module: one when we export it, and one when we require it.

Moreover, the copy in main.js is now disconnected from the original module. That’s why even when we increment our counter it still returns 1 — because the counter variable that we imported is a disconnected copy of the counter variable from the module.

So, incrementing the counter will increment it in the module, but won’t increment your copied version. The only way to modify the copied version of the counter variable is to do so manually:

counter.counter++; console.log(counter.counter); // 2

On the other hand, ES6 creates a live read-only view of the modules we import:

// lib/counter.js export let counter = 1; export function increment() { counter++; } export function decrement() { counter--; } // src/main.js import * as counter from '../../counter'; console.log(counter.counter); // 1 counter.increment(); console.log(counter.counter); // 2

Cool stuff, huh? What I find really compelling about live read-only views is how they allow you to split your modules into smaller pieces without losing functionality.

Then you can turn around and merge them again, no problem. It just “works.”

Looking forward: bundling modules

Wow! Where does the time go? That was a wild ride, but I sincerely hope it gave you a better understanding of modules in JavaScript.

In the next section I’ll walk through module bundling, covering core topics including:

  • Why we bundle modules
  • Different approaches to bundling
  • ECMAScript’s module loader API
  • …and more. :)

NOTE: To keep things simple, I skipped over some of the nitty-gritty details (think: cyclic dependencies) in this post. If I left out anything important and/or fascinating, please let me know in the comments!