Modules JavaScript: Guide du débutant

Si vous êtes un novice en JavaScript, le jargon comme «bundleurs de modules vs chargeurs de modules», «Webpack vs Browserify» et «AMD vs CommonJS» peut rapidement devenir écrasant.

Le système de modules JavaScript peut être intimidant, mais le comprendre est vital pour les développeurs Web.

Dans cet article, je décompresserai ces mots à la mode pour vous en anglais simple (et quelques exemples de code). J'espère que cela vous aidera!

Remarque: pour des raisons de simplicité, cela sera divisé en deux sections: La première partie expliquera ce que sont les modules et pourquoi nous les utilisons. La partie 2 (publiée la semaine prochaine) expliquera ce que signifie regrouper des modules et les différentes façons de le faire.

Partie 1: Quelqu'un peut-il expliquer quels sont les modules à nouveau?

Les bons auteurs divisent leurs livres en chapitres et sections; les bons programmeurs divisent leurs programmes en modules.

Comme un chapitre de livre, les modules ne sont que des groupes de mots (ou de code, selon le cas).

Les bons modules, cependant, sont hautement autonomes avec des fonctionnalités distinctes, ce qui leur permet d'être mélangés, supprimés ou ajoutés si nécessaire, sans perturber le système dans son ensemble.

Pourquoi utiliser des modules?

Il y a beaucoup d'avantages à utiliser des modules en faveur d'une base de code tentaculaire et interdépendante. Les plus importants, à mon avis, sont:

1) Maintenabilité: Par définition, un module est autonome. Un module bien conçu vise à réduire autant que possible les dépendances sur certaines parties de la base de code, afin qu'il puisse se développer et s'améliorer indépendamment. La mise à jour d'un seul module est beaucoup plus facile lorsque le module est découplé des autres morceaux de code.

Pour revenir à notre exemple de livre, si vous vouliez mettre à jour un chapitre de votre livre, ce serait un cauchemar si un petit changement dans un chapitre vous obligeait à modifier également tous les autres chapitres. Au lieu de cela, vous voudrez écrire chaque chapitre de telle manière que des améliorations puissent être apportées sans affecter les autres chapitres.

2) Espacement des noms: en JavaScript, les variables en dehors de la portée d'une fonction de niveau supérieur sont globales (ce qui signifie que tout le monde peut y accéder). Pour cette raison, il est courant d'avoir une «pollution de l'espace de noms», où du code totalement indépendant partage des variables globales.

Le partage de variables globales entre du code non lié est un grand non-non en développement.

Comme nous le verrons plus loin dans cet article, les modules nous permettent d'éviter la pollution de l'espace de noms en créant un espace privé pour nos variables.

3) Réutilisabilité: soyons honnêtes ici: nous avons tous copié du code que nous avions précédemment écrit dans de nouveaux projets à un moment ou à un autre. Par exemple, imaginons que vous ayez copié certaines méthodes utilitaires que vous avez écrites à partir d'un projet précédent vers votre projet actuel.

C'est bien beau, mais si vous trouvez un meilleur moyen d'écrire une partie de ce code, vous devrez revenir en arrière et vous rappeler de le mettre à jour partout où vous l'avez écrit.

C'est évidemment une énorme perte de temps. Ne serait-il pas beaucoup plus facile s'il y avait - attendez - un module que nous pourrions réutiliser encore et encore?

Comment pouvez-vous intégrer des modules?

Il existe de nombreuses façons d'incorporer des modules dans vos programmes. Passons en revue quelques-uns d'entre eux:

Modèle de module

Le modèle Module est utilisé pour imiter le concept de classes (puisque JavaScript ne prend pas en charge nativement les classes) afin que nous puissions stocker des méthodes et des variables publiques et privées dans un seul objet - de la même manière que les classes sont utilisées dans d'autres langages de programmation comme Java ou Python. Cela nous permet de créer une API publique pour les méthodes que nous voulons exposer au monde, tout en encapsulant des variables et des méthodes privées dans une portée de fermeture.

Il existe plusieurs façons de réaliser le modèle de module. Dans ce premier exemple, j'utiliserai une fermeture anonyme. Cela nous aidera à atteindre notre objectif en mettant tout notre code dans une fonction anonyme. (N'oubliez pas: en JavaScript, les fonctions sont le seul moyen de créer une nouvelle portée.)

Exemple 1: fermeture anonyme

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

Avec cette construction, notre fonction anonyme a son propre environnement d'évaluation ou «clôture», puis nous l'évaluons immédiatement. Cela nous permet de masquer les variables de l'espace de noms parent (global).

Ce qui est bien avec cette approche, c'est que vous pouvez utiliser des variables locales dans cette fonction sans écraser accidentellement les variables globales existantes, tout en accédant aux variables globales, comme ceci:

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

Notez que les parenthèses autour de la fonction anonyme sont obligatoires, car les instructions qui commencent par la fonction mot-clé sont toujours considérées comme des déclarations de fonction (rappelez-vous, vous ne pouvez pas avoir de déclarations de fonction sans nom en JavaScript.) Par conséquent, les parenthèses environnantes créent une expression de fonction au lieu. Si vous êtes curieux, vous pouvez en savoir plus ici.

Exemple 2: importation globale

L'importation globale est une autre approche populaire utilisée par les bibliothèques comme jQuery. C'est similaire à la fermeture anonyme que nous venons de voir, sauf que maintenant nous passons des globaux comme paramètres:

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

Dans cet exemple, globalVariable est la seule variable globale. L'avantage de cette approche par rapport aux fermetures anonymes est que vous déclarez les variables globales à l'avance, ce qui les rend parfaitement claires pour les personnes qui lisent votre code.

Exemple 3: interface objet

Une autre approche encore consiste à créer des modules en utilisant une interface objet autonome, comme ceci:

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

Comme vous pouvez le voir, cette approche nous permet de décider quelles variables / méthodes nous voulons garder privées (par exemple myGrades ) et quelles variables / méthodes nous voulons exposer en les mettant dans l'instruction de retour (par exemple moyenne et échec ).

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!