JavaScript-moduulit: Aloittelijan opas

Jos olet uusi JavaScript-tulokas, ammattikieltä, kuten "moduulipaketit vs. moduulilataimet", "Webpack vs. selainverifiointi" ja "AMD vs. CommonJS", voi tulla nopeasti ylivoimainen.

JavaScript-moduulijärjestelmä saattaa olla pelottava, mutta sen ymmärtäminen on elintärkeää web-kehittäjille.

Tässä viestissä puran nämä sanat sinulle tavallisella englanniksi (ja muutamalla koodinäytteellä). Toivottavasti löydät siitä hyödyllisen!

Huomaa: yksinkertaisuuden vuoksi tämä jaetaan kahteen osaan: Osa 1 selittää, mitkä moduulit ovat ja miksi käytämme niitä. Osa 2 (lähetetty ensi viikolla) käy läpi moduulien niputtamisen ja eri tapoja tehdä se.

Osa 1: Voisiko joku selittää, mitkä moduulit ovat jälleen?

Hyvät kirjoittajat jakavat kirjansa lukuihin ja jaksoihin; hyvät ohjelmoijat jakavat ohjelmansa moduuleiksi.

Kirjan luvun tavoin moduulit ovat vain sanaryhmittymiä (tai koodia tapauksesta riippuen).

Hyvät moduulit ovat kuitenkin erittäin itsenäisiä, ja niillä on erilliset toiminnot, joten ne voidaan sekoittaa, poistaa tai lisätä tarpeen mukaan häiritsemättä koko järjestelmää.

Miksi käyttää moduuleja?

Moduulien käytöstä on paljon etuja leviävän, toisistaan ​​riippuvan koodikannan hyväksi. Tärkeimmät mielestäni ovat:

1) Ylläpidettävyys: Määritelmän mukaan moduuli on itsenäinen. Hyvin suunnitellun moduulin tavoitteena on vähentää riippuvuutta koodikannan osista mahdollisimman paljon, jotta se voi kasvaa ja kehittyä itsenäisesti. Yksittäisen moduulin päivittäminen on paljon helpompaa, kun moduuli on irrotettu muista koodikappaleista.

Palataksemme takaisin kirjaesimerkkiin, jos haluat päivittää kirjan osan, se olisi painajainen, jos pieni muutos yhteen lukuun vaatisi sinua säätämään myös kaikkia muita lukuja. Sen sijaan haluat kirjoittaa jokaisen luvun siten, että parannuksia voidaan tehdä vaikuttamatta muihin lukuihin.

2) Nimiavaruus: JavaScriptissä muuttujat, jotka eivät kuulu ylätason toiminnon piiriin, ovat globaaleja (eli kaikki voivat käyttää niitä). Tämän vuoksi on yleistä, että "nimitila-saasteet" ovat täysin toisistaan ​​riippumattomia koodeja, jotka jakavat globaaleja muuttujia.

Globaalien muuttujien jakaminen etuyhteydettömien koodien välillä on iso ei-ei-kehitys.

Kuten näemme myöhemmin tässä viestissä, moduulien avulla voimme välttää nimitilan pilaantumisen luomalla yksityisen tilan muuttujillemme.

3) Uudelleenkäytettävyys: Olkaamme tässä rehellisiä: olemme kaikki kopioineet aiemmin kirjoittamamme koodin uusiin projekteihin jossain vaiheessa. Kuvitelkaamme esimerkiksi, että kopioit joitain edellisestä projektista kirjoittamiasi apuvälineitä nykyiseen projektiin.

Se on kaikki hyvin ja hyvä, mutta jos löydät paremman tavan kirjoittaa osan koodista, sinun on palattava takaisin ja muistettava päivittää se kaikkialle muualle, kun kirjoitit sen.

Tämä on tietysti valtava ajanhukka. Eikö olisikaan paljon helpompaa, jos olisi - odota sitä - moduuli, jota voimme käyttää uudestaan ​​ja uudestaan?

Kuinka voit sisällyttää moduuleja?

On monia tapoja sisällyttää moduuleja ohjelmiin. Käydään läpi muutama niistä:

Moduulin kuvio

Moduulimallia käytetään matkimaan luokkakäsitettä (koska JavaScript ei tue luokat luonnostaan), jotta voimme tallentaa sekä julkisia että yksityisiä menetelmiä ja muuttujia yhden objektin sisään - samalla tavalla kuin luokkia käytetään muilla ohjelmointikielillä, kuten Java tai Python. Tämän avulla voimme luoda julkisen API: n menetelmille, jotka haluamme paljastaa maailmalle, samalla kun kapseloidaan yksityiset muuttujat ja menetelmät sulkemisalueeseen.

Moduulimallin toteuttamiseksi on useita tapoja. Tässä ensimmäisessä esimerkissä käytän anonyymia sulkemista. Se auttaa meitä saavuttamaan tavoitteemme asettamalla kaikki koodimme nimettömäksi toiminnoksi. (Muista: JavaScriptissä toiminnot ovat ainoa tapa luoda uusi laajuus.)

Esimerkki 1: Anonyymi sulkeminen

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

Tämän rakenteen avulla nimettömällä toiminnollamme on oma arviointiympäristö tai "sulkeminen", ja sitten arvioimme sen välittömästi. Tämän avulla voimme piilottaa muuttujat ylätason (globaalista) nimiavaruudesta.

Hienoa tässä lähestymistavassa on se, että voit käyttää paikallisia muuttujia tämän toiminnon sisällä korvaamatta vahingossa olemassa olevia globaaleja muuttujia, mutta silti käyttää globaaleja muuttujia, kuten näin:

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

Huomaa, että nimettömän funktion ympärillä olevat sulut ovat pakollisia, koska avainsanatoiminnolla alkavia lauseita pidetään aina funktiodeklarointina (muista, että Javascriptissa ei voi olla nimettömiä funktiodeklarointeja.) Tämän vuoksi ympäröivät sulut luovat funktiolausekkeen sen sijaan. Jos olet utelias, voit lukea lisää täältä.

Esimerkki 2: Maailmanlaajuinen tuonti

Toinen suosittu tapa käyttää kirjastoja, kuten jQuery, on globaali tuonti. Se on samanlainen kuin juuri näkemämme anonyymi sulkeminen, paitsi että nyt siirrämme globaaleina parametreina:

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

Tässä esimerkissä globalVariable on ainoa muuttuja, joka on globaali. Tämän lähestymistavan etuna nimettömistä sulkemisista on, että ilmoitat globaalit muuttujat etukäteen, mikä tekee siitä kristallinkirkkaan ihmisille, jotka lukevat koodiasi.

Esimerkki 3: Objektirajapinta

Vielä yksi lähestymistapa on luoda moduuleja käyttämällä itsenäistä objektiliittymää, kuten:

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

Kuten näette, tämän lähestymistavan avulla voimme päättää, mitkä muuttujat / menetelmät haluamme pitää yksityisinä (esim. MyGrades ) ja mitkä muuttujat / menetelmät haluamme paljastaa asettamalla ne palautuslausekkeeseen (esim. Keskiarvo ja epäonnistuminen ).

Esimerkki 4: Moduulimallin paljastaminen

Tämä on hyvin samanlainen kuin yllä oleva lähestymistapa, paitsi että se varmistaa, että kaikki menetelmät ja muuttujat pidetään yksityisinä, kunnes ne nimenomaisesti altistetaan:

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

Se saattaa tuntua paljon otettavalta, mutta se on vain jäävuoren huippu moduulimalleista. Tässä on muutamia resursseja, jotka pidin hyödyllisinä omissa tutkimuksissani:

  • Addy Osmanin oppiminen JavaScript-suunnittelumalleista: aarreaitta yksityiskohtia vaikuttavan ytimekkäästi
  • Riittävän hyvä Ben Cherry: hyödyllinen yleiskatsaus esimerkkejä moduulimallin edistyneestä käytöstä
  • Carl Danleyn blogi: moduulimallien yleiskatsaus ja resurssit muille JavaScript-malleille.

CommonJS ja AMD

Lähestymistavoilla on ennen kaikkea yksi yhteinen asia: yhden globaalin muuttujan käyttö koodinsa käärimiseksi funktioon, mikä luo itselleen yksityisen nimitilan käyttämällä sulkemisalaa.

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.

Sitten voit kääntyä ympäri ja yhdistää ne uudelleen, ei hätää. Se vain "toimii".

Katse eteenpäin: moduulien niputtaminen

Vau! Mihin aika kuluu? Se oli villi ratsastus, mutta toivon vilpittömästi, että se antoi sinulle paremman käsityksen JavaScript-moduuleista.

Seuraavassa osassa käyn läpi moduulipaketin, joka kattaa keskeiset aiheet, kuten:

  • Miksi niputamme moduulit
  • Erilaiset lähestymistavat niputtamiseen
  • ECMAScriptin moduulilataimen sovellusliittymä
  • …ja enemmän. :)

HUOMAUTUS: Jotta asiat olisivat yksinkertaisia, ohitin joitain tämän viestin hienoja yksityiskohtia (ajatella: syklisiä riippuvuuksia). Jos olen jättänyt pois jotain tärkeää ja / tai kiehtovaa, ilmoita siitä minulle kommenteissa!