JavaScripti moodulid: juhend algajatele

Kui olete JavaScripti uustulnuk, võib žargoon nagu „moodulite kogujad vs moodulilaadijad”, „Webpack vs. sirvija” ja „AMD vs CommonJS” kiiresti muutuda valdavaks.

JavaScripti moodulisüsteem võib küll hirmutada, kuid selle mõistmine on veebiarendajatele eluliselt vajalik.

Selles postituses pakin need moesõnad teie jaoks lahti inglise keeles (ja mõned koodinäidised). Loodan, et leiate sellest abi!

Märkus: lihtsuse huvides jagatakse see kahte ossa: 1. osas selgitatakse, mis moodulid on ja miks me neid kasutame. 2. osas (postitatakse järgmisel nädalal) käsitletakse, mida tähendab moodulite komplekteerimine ja erinevad viisid seda teha.

1. osa: Kas keegi saaks palun selgitada, mis moodulid jälle on?

Head autorid jagavad oma raamatud peatükkideks ja osadeks; head programmeerijad jagavad oma programmid mooduliteks.

Sarnaselt raamatupeatükiga on moodulid lihtsalt sõnarühmad (või vastavalt koodile).

Head moodulid on siiski väga iseseisvad, eristuva funktsionaalsusega, võimaldades neid vajadusel segada, eemaldada või lisada, ilma et see häiriks süsteemi tervikuna.

Miks kasutada mooduleid?

Moodulite kasutamisel on laialivalguva, üksteisest sõltuva koodibaasi kasuks palju eeliseid. Minu arvates on kõige olulisemad:

1) Hooldatavus: definitsiooni järgi on moodul iseseisev. Hästi läbimõeldud mooduli eesmärk on võimalikult palju vähendada sõltuvust koodibaasi osadest, et see saaks iseseisvalt kasvada ja areneda. Ühe mooduli värskendamine on palju lihtsam, kui moodul on teistest koodijuppidest lahti ühendatud.

Tulles tagasi meie raamatunäite juurde, siis kui soovite oma raamatus mõnda peatükki uuendada, oleks see õudusunenägu, kui ühe peatüki väike muudatus nõuaks ka kõigi teiste peatükkide näpistamist. Selle asemel soovite kirjutada iga peatüki nii, et saaksime teha parandusi, ilma et see mõjutaks teisi peatükke.

2) Nimeruum: JavaScripti muutujad, mis jäävad väljapoole tipptaseme funktsiooni, on globaalsed (see tähendab, et kõik saavad neile juurde pääseda). Seetõttu on tavaline nn nimeruumi saaste, kus täiesti mitteseotud kood jagab globaalseid muutujaid.

Globaalsete muutujate jagamine mitteseotud koodi vahel on arendamisel suur-ei-ei.

Nagu näeme sellest postitusest hiljem, võimaldavad moodulid meil nimeruumi reostust vältida, luues meie muutujate jaoks privaatruumi.

3) Korduvkasutus: olgem siin ausad: me kõik oleme varem kirjutatud koodi ühel või teisel hetkel uutesse projektidesse kopeerinud. Oletame näiteks, et kopeerisite mõned eelmisest projektist kirjutatud kasulikud meetodid praegusesse projekti.

See on kõik hästi ja hea, kuid kui leiate parema viisi selle koodi mõne osa kirjutamiseks, peaksite minema tagasi ja meeles pidama, et värskendaksite seda kõikjal mujal, kuhu kirjutasite.

See on ilmselgelt tohutu aja raiskamine. Kas poleks palju lihtsam, kui oleks olemas - oota seda - moodul, mida saaksime uuesti ja uuesti kasutada?

Kuidas saate mooduleid lisada?

Moodulite lisamiseks oma programmidesse on palju võimalusi. Käime läbi mõned neist:

Mooduli muster

Mooduli mustrit kasutatakse klasside kontseptsiooni jäljendamiseks (kuna JavaScript ei toeta klasse loomulikult), et saaksime nii avalikke kui ka eraviisilisi meetodeid ja muutujaid ühe objekti sisse salvestada - sarnaselt klasside kasutamisele teistes programmeerimiskeeltes, näiteks Java või Python. See võimaldab meil luua avalikkuse ees oleva API meetodite jaoks, mida soovime maailmale eksponeerida, kapseldades siiski privaatseid muutujaid ja meetodeid sulgemisulatusse.

Moodulimustri saavutamiseks on mitu võimalust. Selles esimeses näites kasutan anonüümset sulgemist. See aitab meil oma eesmärki täita, pannes kogu koodi anonüümsesse funktsiooni. (Pidage meeles: JavaScripti funktsioonid on ainus viis uue ulatuse loomiseks.)

Näide 1: anonüümne sulgemine

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

Selle konstruktsiooniga on meie anonüümsel funktsioonil oma hindamiskeskkond ehk “sulgemine” ja siis me hindame seda kohe. See võimaldab meil varjata muutujaid vanema (globaalse) nimeruumi eest.

Selle lähenemisviisi tore on see, et saate selle funktsiooni sees kasutada kohalikke muutujaid, olemasolevaid globaalseid muutujaid kogemata üle kirjutamata, kuid pääsete siiski globaalsetele muutujatele juurde, näiteks:

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

Pange tähele, et sulgudes ümber anonüümne funktsioon on vajalik, sest avaldusi, mis algavad märksõna funktsioon on alati loetakse funktsiooni deklaratsioonid (mäletan, siis ei saa olla nimetu funktsiooni deklaratsioonid JavaScripti.) Järelikult ümbritseva sulgudes luua funktsioon väljendus selle asemel. Kui olete uudishimulik, saate rohkem lugeda siit.

Näide 2: ülemaailmne import

Teine populaarne lähenemine, mida raamatukogud nagu jQuery kasutavad, on ülemaailmne import. See sarnaneb äsja nähtud anonüümsele sulgemisele, välja arvatud see, et nüüd edastame parameetritena globaale:

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

Selles näites on globalVariable ainus muutuja, mis on globaalne. Selle lähenemise eelis anonüümsete sulgemiste ees on see, et deklareerite globaalsed muutujad algul, muutes selle teie koodi lugevatele inimestele kristallselgeks.

Näide 3: objekti liides

Veel üks lähenemisviis on moodulite loomine iseseisva objekti liidese abil, näiteks:

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

Nagu näete, võimaldab see lähenemine meil otsustada, milliseid muutujaid / meetodeid soovime privaatsena hoida (nt myGrades ) ja milliseid muutujaid / meetodeid me palume avaldada, sisestades need return-lausesse (nt keskmine ja ebaõnnestunud ).

Näide 4: mooduli mustri paljastamine

See sarnaneb ülaltoodud lähenemisviisiga, välja arvatud see, et see tagab kõigi meetodite ja muutujate privaatsuse hoidmise seni, kuni need on selgesõnaliselt kokku puutunud:

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

See võib tunduda palju ette võetav, kuid moodulimustrite osas on see vaid jäämäe tipp. Siin on mõned ressursid, mis minu enda jaoks kasulikud leidsid:

  • Addy Osmani JavaScripti kujundusmustrite õppimine: muljetavaldavalt napisõnaline detailide aare
  • Piisavalt hea Ben Cherry poolt: kasulik ülevaade koos moodulimustri täpsema kasutamise näidetega
  • Carl Danley ajaveeb: moodulimustri ülevaade ja ressursid teiste JavaScripti mustrite jaoks.

CommonJS ja AMD

Lähenemisviisidel on ennekõike üks ühine omadus: ühe globaalse muutuja kasutamine oma koodi funktsiooni mähkimiseks, luues seeläbi enda jaoks privaatne nimeruum, kasutades sulgemisulatus.

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.

Siis saate need ümber pöörata ja uuesti ühendada, pole probleemi. See lihtsalt "töötab".

Tulevikku vaadates: moodulite komplekteerimine

Vau! Kuhu aeg läheb? See oli metsik sõit, kuid loodan südamest, et see andis teile parema ülevaate JavaScripti moodulitest.

Järgmises jaotises tutvun moodulite komplektiga, hõlmates põhiteemasid, sealhulgas:

  • Miks pakume mooduleid
  • Erinevad lähenemisviisid komplekteerimisele
  • ECMAScripti moodulilaaduri API
  • …ja veel. :)

MÄRKUS. Asjade lihtsuse huvides jätsin selle postituse mõned detailid (mõelge: tsüklilised sõltuvused) üle. Kui midagi olulist ja / või põnevat välja jätsin, andke palun teada kommentaarides!