Ha újonc a JavaScript-ben, akkor az olyan szakzsargon, mint a „modulcsomagolók és a modultöltők”, a „Webpack kontra böngésző” és az „AMD kontra CommonJS” gyorsan elsöprővé válhat.
Lehet, hogy a JavaScript modulrendszer félelmetes, de ennek megértése létfontosságú a webfejlesztők számára.
Ebben a bejegyzésben kibontom neked ezeket a hívószavakat egyszerű angol nyelven (és néhány kódmintával). Remélem hasznosnak találja!
Megjegyzés: az egyszerűség kedvéért ezt két részre osztjuk: Az 1. rész elmagyarázza, hogy mi a modul, és miért használjuk őket. A (jövő héten közzétett) 2. részben áttekintjük, hogy mit jelent a modulok összekapcsolása és ennek különféle módjai.
1. rész: Meg tudná valaki magyarázni, hogy mik is a modulok?
A jó szerzők fejezetekre és szakaszokra tagolják könyveiket; a jó programozók modulokra bontják programjaikat.
A könyvfejezethez hasonlóan a modulok is csak szavak (vagy adott esetben kód) halmazai.
A jó modulok azonban nagyon önállóak, különálló funkcionalitással, lehetővé téve számukra a szükséges keverést, eltávolítást vagy hozzáadást anélkül, hogy a rendszer egészét megzavarnák.
Miért érdemes modulokat használni?
Nagyon sok előnye van a modulok használatának a kiterjedt, egymással függő kódbázis javára. A legfontosabbak véleményem szerint a következők:
1) Fenntarthatóság: Definíció szerint egy modul önálló. Egy jól megtervezett modul célja a kódbázis egyes részeitől való függőségek lehető legnagyobb mértékű csökkentése, hogy ez önállóan növekedhessen és javuljon. Egy modul frissítése sokkal könnyebb, ha a modult leválasztják a többi kódrészről.
Visszatérve a könyvpéldánkra, ha frissíteni szeretnél egy fejezetet a könyvedben, akkor rémálom lenne, ha az egyik fejezet apró változtatásához minden más fejezetet is be kellene csípned. Ehelyett az egyes fejezeteket úgy szeretné megírni, hogy a fejlesztések más fejezetek befolyásolása nélkül is elvégezhetők legyenek.
2) Névtér: A JavaScript-ben a felső szintű függvény hatókörén kívül eső változók globálisak (vagyis mindenki hozzájuk férhet). Emiatt gyakori a „névtér szennyezése”, ahol a teljesen független kód megosztja a globális változókat.
A globális változók megosztása független kódok között nagy nem-nem fejlesztés.
Amint ezt a bejegyzés később látni fogjuk, a modulok lehetővé teszik számunkra, hogy elkerüljük a névtér szennyezését azzal, hogy privát helyet hozunk létre a változók számára.
3) Újrafelhasználhatóság: Legyünk itt őszinték: mindannyian másoltunk egy kódot, amelyet korábban írtunk az új projektekbe egy-egy ponton. Tegyük fel például, hogy az előző projektből írt néhány hasznos módszert átmásolt a jelenlegi projektjébe.
Ez minden jó és jó, de ha talál egy jobb módszert a kód egy részének megírására, akkor vissza kell térnie, és ne felejtse el frissíteni mindenhol, ahol írta.
Ez nyilvánvalóan hatalmas időpazarlás. Nem lenne sokkal könnyebb, ha lenne - várjon rá - modul, amelyet újra és újra felhasználhatunk?
Hogyan építhet be modulokat?
Számos módon lehet modulokat beépíteni a programjaiba. Menjünk át néhány közülük:
Modul minta
A Modul mintát az osztályok fogalmának utánzására használják (mivel a JavaScript nem támogatja natívan az osztályokat), így mind nyilvános, mind privát módszereket és változókat egyetlen objektumon belül tárolhatunk - hasonlóan ahhoz, ahogy az osztályokat más programozási nyelvekben, például a Java-ban használják vagy Python. Ez lehetővé teszi számunkra, hogy hozzunk létre egy nyilvános API-t azokhoz a módszerekhez, amelyeket ki akarunk terjeszteni a világ számára, miközben a magánváltozókat és módszereket mégis bezáró körbe foglaljuk.
A modulminta megvalósításának számos módja van. Ebben az első példában egy névtelen bezárást fogok használni. Ez segít elérni a célunkat azáltal, hogy az összes kódunkat egy névtelen funkcióba helyezi. (Ne feledje: a JavaScript-ben a funkciók az egyetlen módja az új hatókör létrehozásának.)
1. példa: Névtelen bezárás
(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.’Ezzel a konstrukcióval anonim funkciónknak megvan a maga értékelési környezete vagy „bezárása”, majd ezt azonnal értékeljük. Ez elrejtheti a változókat a szülő (globális) névtér elől.
Az a szép ebben a megközelítésben, hogy a helyi változókat használhatja ebben a függvényben anélkül, hogy véletlenül felülírná a meglévő globális változókat, de mégis hozzáfér a globális változókhoz, így:
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 :)'Ne feledje, hogy az anonim függvény körül zárójelre van szükség, mert a kulcsszóval kezdődő utasításokat mindig függvénydeklarációknak tekintik (ne feledje, hogy a JavaScriptben nem lehet meg nem nevezett függvénydeklaráció.) Következésképpen a környező zárójelek létrehoznak egy függvény kifejezést helyette. Ha kíváncsi vagy, itt olvashatsz többet.
2. példa: Globális import
A könyvtárak, például a jQuery, által használt másik népszerű megközelítés a globális import. Hasonló az imént látott névtelen bezáráshoz, kivéve, hogy most paraméterként átadjuk a globálist:
(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)); Ebben a példában a globalVariable az egyetlen változó, amely globális. Ennek a megközelítésnek az anonim bezárásokkal szembeni előnye, hogy előre deklarálja a globális változókat, ez kristálytisztavá teszi a kódot olvasó emberek számára.
3. példa: Objektum interfész
Egy másik megközelítés a modulok létrehozása egy önálló objektum interfész használatával, így:
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.'Amint láthatja, ez a megközelítés lehetővé teszi, hogy eldöntsük, milyen változókat / módszereket akarunk titokban tartani (pl. MyGrades ), és milyen változókat / módszereket szeretnénk kitenni azáltal, hogy a return utasításba vesszük őket (pl. Átlag és sikertelen ).
4. példa: Modulminta feltárása
Ez nagyon hasonlít a fenti megközelítéshez, azzal a kivétellel, hogy biztosítja, hogy minden módszer és változó titokban maradjon, amíg kifejezetten ki nem fedik:
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.'Úgy tűnhet, hogy ez sok befogadandó, de ez csak a jéghegy csúcsa, amikor a modulmintákról van szó. Íme néhány forrás, amelyet hasznosnak találtam a saját felfedezéseim során:
- Addy Osmani megtanulja a JavaScript tervezési mintáit: a részletek kincse lenyűgözően tömören olvasható
- Megfelelően jó: Ben Cherry: hasznos áttekintés a modulminta haladó használatának példáival
- Carl Danley blogja: a modulminták áttekintése és más JavaScript minták forrásai.
CommonJS és AMD
A megközelítéseknek mindenekelőtt egy közös vonásuk van: egyetlen globális változó használata a kód kódolásához egy függvénybe, ezáltal saját névteret hozhat létre magának egy lezárási hatókör használatával.
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); // 1In 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); // 2On 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); // 2Cool 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!