Moduli JavaScript: una guida per principianti

Se sei un nuovo arrivato in JavaScript, gergo come "bundler di moduli e caricatori di moduli", "Webpack e Browserify" e "AMD e CommonJS" possono diventare rapidamente travolgenti.

Il sistema del modulo JavaScript può intimidire, ma comprenderlo è vitale per gli sviluppatori web.

In questo post, decomprimerò queste parole d'ordine per te in un inglese semplice (e alcuni esempi di codice). Spero che lo trovi utile!

Nota: per semplicità, questo sarà diviso in due sezioni: La Parte 1 si immergerà nello spiegare cosa sono i moduli e perché li usiamo. La Parte 2 (pubblicata la prossima settimana) illustrerà cosa significa raggruppare i moduli e i diversi modi per farlo.

Parte 1: qualcuno può spiegare di nuovo quali sono i moduli?

I buoni autori dividono i loro libri in capitoli e sezioni; i bravi programmatori dividono i loro programmi in moduli.

Come il capitolo di un libro, i moduli sono solo gruppi di parole (o codice, a seconda dei casi).

I buoni moduli, tuttavia, sono altamente autonomi con funzionalità distinte, consentendo loro di essere mescolati, rimossi o aggiunti secondo necessità, senza interrompere il sistema nel suo complesso.

Perché utilizzare i moduli?

Ci sono molti vantaggi nell'usare i moduli a favore di una base di codice ampia e interdipendente. I più importanti, secondo me, sono:

1) Manutenibilità: per definizione, un modulo è autonomo. Un modulo ben progettato mira a ridurre il più possibile le dipendenze da parti del codice base, in modo che possa crescere e migliorare in modo indipendente. L'aggiornamento di un singolo modulo è molto più semplice quando il modulo è disaccoppiato da altri pezzi di codice.

Tornando all'esempio del nostro libro, se volessi aggiornare un capitolo del tuo libro, sarebbe un incubo se una piccola modifica a un capitolo richiedesse di modificare anche ogni altro capitolo. Invece, vorresti scrivere ogni capitolo in modo tale da poter apportare miglioramenti senza influire sugli altri capitoli.

2) Spaziatura dei nomi: in JavaScript, le variabili al di fuori dell'ambito di una funzione di primo livello sono globali (il che significa che tutti possono accedervi). Per questo motivo, è comune avere un "inquinamento dello spazio dei nomi", in cui il codice completamente non correlato condivide variabili globali.

La condivisione di variabili globali tra codice non correlato è un grande no-no nello sviluppo.

Come vedremo più avanti in questo post, i moduli ci consentono di evitare l'inquinamento dello spazio dei nomi creando uno spazio privato per le nostre variabili.

3) Riusabilità: siamo onesti qui: tutti noi abbiamo copiato il codice che abbiamo scritto in precedenza in nuovi progetti prima o poi. Ad esempio, immaginiamo di aver copiato alcuni metodi di utilità scritti da un progetto precedente nel progetto corrente.

Va tutto bene, ma se trovi un modo migliore per scrivere una parte di quel codice dovresti tornare indietro e ricordarti di aggiornarlo ovunque tu lo abbia scritto.

Questa è ovviamente un'enorme perdita di tempo. Non sarebbe molto più semplice se ci fosse - aspetta - un modulo che possiamo riutilizzare più e più volte?

Come puoi incorporare i moduli?

Ci sono molti modi per incorporare i moduli nei tuoi programmi. Vediamone alcuni:

Modello del modulo

Il pattern Module viene utilizzato per imitare il concetto di classi (poiché JavaScript non supporta nativamente le classi) in modo da poter memorizzare metodi e variabili sia pubblici che privati ​​all'interno di un singolo oggetto, in modo simile a come le classi vengono utilizzate in altri linguaggi di programmazione come Java o Python. Ciò ci consente di creare un'API rivolta al pubblico per i metodi che vogliamo esporre al mondo, incapsulando comunque variabili e metodi privati ​​in un ambito di chiusura.

Esistono diversi modi per realizzare il modello del modulo. In questo primo esempio, userò una chiusura anonima. Questo ci aiuterà a raggiungere il nostro obiettivo mettendo tutto il nostro codice in una funzione anonima. (Ricorda: in JavaScript, le funzioni sono l'unico modo per creare un nuovo ambito.)

Esempio 1: chiusura anonima

(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.’

Con questo costrutto, la nostra funzione anonima ha il proprio ambiente di valutazione o "chiusura", quindi lo valutiamo immediatamente. Questo ci consente di nascondere le variabili dallo spazio dei nomi principale (globale).

La cosa bella di questo approccio è che puoi usare le variabili locali all'interno di questa funzione senza sovrascrivere accidentalmente le variabili globali esistenti, ma accedere comunque alle variabili globali, in questo modo:

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 :)'

Nota che le parentesi attorno alla funzione anonima sono obbligatorie, perché le istruzioni che iniziano con la funzione parola chiave sono sempre considerate dichiarazioni di funzione (ricorda, non puoi avere dichiarazioni di funzione senza nome in JavaScript.) Di conseguenza, le parentesi circostanti creano un'espressione di funzione anziché. Se sei curioso, puoi leggere di più qui.

Esempio 2: importazione globale

Un altro approccio popolare utilizzato da librerie come jQuery è l'importazione globale. È simile alla chiusura anonima che abbiamo appena visto, tranne che ora passiamo le globali come parametri:

(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)); 

In questo esempio, globalVariable è l'unica variabile globale. Il vantaggio di questo approccio rispetto alle chiusure anonime è che dichiari le variabili globali in anticipo, rendendolo chiaro alle persone che leggono il tuo codice.

Esempio 3: interfaccia oggetto

Un altro approccio consiste nel creare moduli utilizzando un'interfaccia a oggetti autonoma, in questo modo:

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.'

Come puoi vedere, questo approccio ci permette di decidere quali variabili / metodi vogliamo mantenere privati ​​(es. MyGrades ) e quali variabili / metodi vogliamo esporre inserendoli nell'istruzione return (es. Average & failing ).

Example 4: Revealing module pattern

This is very similar to the above approach, except that it ensures all methods and variables are kept private until explicitly exposed:

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.'

That may seem like a lot to take in, but it’s just the tip of the iceberg when it comes to module patterns. Here are a few of the resources I found useful in my own explorations:

  • Learning JavaScript Design Patterns by Addy Osmani: a treasure trove of details in an impressively succinct read
  • Adequately Good by Ben Cherry: a useful overview with examples of advanced usage of the module pattern
  • Blog of Carl Danley: module pattern overview and resources for other JavaScript patterns.

CommonJS and AMD

The approaches above all have one thing in common: the use of a single global variable to wrap its code in a function, thereby creating a private namespace for itself using a closure scope.

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!