„JavaScript“ moduliai: vadovas pradedantiesiems

Jei esate „JavaScript“ naujokas, žargonas, pvz., „Modulių paketai ir modulių krautuvai“, „„ Webpack “prieš naršyklę“ ir „AMD prieš„ CommonJS “, gali greitai tapti didžiulis.

„JavaScript“ modulio sistema gali būti bauginanti, tačiau suprasti ją yra labai svarbu interneto kūrėjams.

Šiame įraše išpakuosiu jums šiuos trumpuosius žodžius paprasta anglų kalba (ir keliais kodų pavyzdžiais). Tikiuosi, kad jums tai bus naudinga!

Pastaba: siekiant paprastumo, tai bus padalinta į du skyrius: 1 dalyje bus paaiškinta, kas yra moduliai ir kodėl mes juos naudojame. 2 dalyje (paskelbta kitą savaitę) bus aprašyta, ką reiškia susieti modulius ir įvairius būdus tai padaryti.

1 dalis: Ar kas nors gali paaiškinti, kokie moduliai vėl yra?

Geri autoriai savo knygas skirsto į skyrius ir skyrius; geri programuotojai skirsto savo programas į modulius.

Kaip ir knygos skyriuje, moduliai yra tik žodžių sankaupos (arba kodas, atsižvelgiant į aplinkybes).

Tačiau geri moduliai yra labai savarankiški ir turi aiškų funkcionalumą, leidžiantys juos maišyti, pašalinti ar pridėti prireikus, nesutrikdant visos sistemos.

Kodėl verta naudoti modulius?

Modulių naudojimas yra labai naudingas besiplečiančiai, tarpusavyje priklausomai kodų bazei. Svarbiausi, mano nuomone, yra šie:

1) Palaikomumas: pagal apibrėžimą modulis yra savarankiškas. Gerai suprojektuotu moduliu siekiama kuo labiau sumažinti priklausomybę nuo kodų bazės dalių, kad ji galėtų savarankiškai augti ir tobulėti. Vieną modulį atnaujinti yra daug lengviau, kai modulis yra atsietas nuo kitų kodo dalių.

Grįžtant prie mūsų knygos pavyzdžio, jei norėtumėte atnaujinti savo knygos skyrių, tai būtų košmaras, jei dėl nedidelio vieno skyriaus pakeitimo tektų pakoreguoti ir visus kitus skyrius. Vietoj to, jūs norėtumėte parašyti kiekvieną skyrių taip, kad būtų galima patobulinti, nepaveikiant kitų skyrių.

2) Vardų tarpai: „JavaScript“ kintamieji, nepatenkantys į aukščiausiojo lygio funkciją, yra visuotiniai (tai reiškia, kad visi prie jų gali prisijungti). Dėl šios priežasties įprasta turėti „vardų srities taršą“, kai visiškai nesusiję kodai turi bendrus kintamuosius.

Dalijimasis visuotiniais kintamaisiais tarp nesusijusių kodų yra didelis „ne“ ne.

Kaip pamatysime vėliau šiame įraše, moduliai leidžia mums išvengti vardų srities taršos, sukurdami privačią erdvę savo kintamiesiems.

3) Pakartotinis naudojimas: Būkime nuoširdūs čia: visi vienu ar kitu metu nukopijavome anksčiau parašytus kodus į naujus projektus. Pvz., Įsivaizduokime, kad nukopijavote keletą naudingų metodų, kuriuos parašėte iš ankstesnio projekto, į dabartinį.

Viskas gerai, bet jei rasite geresnį būdą parašyti tam tikrą kodo dalį, turėtumėte grįžti ir nepamiršti jį atnaujinti visur, kur parašėte.

Tai, aišku, yra didžiulis laiko švaistymas. Ar nebus daug paprasčiau, jei atsiras modulis, kurį galime vėl ir vėl naudoti?

Kaip galite įtraukti modulius?

Yra daug būdų, kaip modulius įtraukti į savo programas. Eikime per kelis iš jų:

Modulio modelis

Modulio modelis naudojamas imituoti klasių sampratą (nes „JavaScript“ natūraliai nepalaiko klasių), kad viename objekte galėtume saugoti tiek viešus, tiek privačius metodus ir kintamuosius - panašiai, kaip klasės naudojamos kitose programavimo kalbose, tokiose kaip „Java“ arba „Python“. Tai leidžia mums sukurti viešai pritaikytą API metodams, kuriuos norime pristatyti pasauliui, vis tiek uždarydami privačius kintamuosius ir metodus.

Yra keli būdai, kaip atlikti modulio modelį. Šiame pirmajame pavyzdyje naudosiu anoniminį uždarymą. Tai padės mums pasiekti savo tikslą, įtraukdami visą kodą į anoniminę funkciją. (Atminkite: „JavaScript“ funkcijos yra vienintelis būdas sukurti naują taikymo sritį.)

1 pavyzdys: anoniminis uždarymas

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

Naudojant šią konstrukciją, mūsų anoniminė funkcija turi savo vertinimo aplinką arba „uždarymą“, tada mes ją iškart įvertiname. Tai leidžia mums paslėpti kintamuosius nuo pagrindinės (visuotinės) vardų srities.

Malonu dėl šio požiūrio yra tai, kad šioje funkcijoje galite naudoti vietinius kintamuosius, netyčia neperrašydami esamų visuotinių kintamųjų, vis tiek pasiekdami visuotinius kintamuosius, pvz .:

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

Atkreipkite dėmesį, kad anoniminės funkcijos skliaustai yra būtini, nes teiginiai, prasidedantys raktinių žodžių funkcija , visada laikomi funkcijos deklaracijomis (atminkite, kad „JavaScript“ negali būti neįvardytų funkcijų deklaracijų.) Todėl aplinkinės skliaustai sukuria funkcijos išraišką vietoj to. Jei smalsu, galite daugiau sužinoti čia.

2 pavyzdys: visuotinis importas

Kitas populiarus požiūris, kurį naudoja tokios bibliotekos kaip „jQuery“, yra pasaulinis importas. Tai panašu į ką tik matytą anoniminį uždarymą, išskyrus tai, kad dabar mes pateikiame globalius parametrus:

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

Šiame pavyzdyje „ globalVariable“ yra vienintelis kintamasis, kuris yra globalus. Šio požiūrio pranašumas anoniminių uždarymų metu yra tas, kad jūs iš anksto paskelbiate pasaulinius kintamuosius, todėl tai labai aišku žmonėms, skaitantiems jūsų kodą.

3 pavyzdys: objekto sąsaja

Dar vienas būdas yra sukurti modulius naudojant savarankišką objekto sąsają, pavyzdžiui:

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

Kaip matote, šis metodas leidžia mums nuspręsti, kokius kintamuosius / metodus norime laikyti privačius (pvz., „ MyGrades“ ) ir kokius kintamuosius / metodus norime atskleisti įtraukdami juos į grąžos sakinį (pvz., Vidutinis ir nesėkmingi ).

4 pavyzdys: Modulio modelio atskleidimas

Tai labai panašu į pirmiau pateiktą metodą, išskyrus tai, kad jis užtikrina, kad visi metodai ir kintamieji bus privatūs, kol jie nebus aiškiai parodyti:

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

Tai gali atrodyti daug imtasi, tačiau kalbant apie modulių modelius, tai tik ledkalnio viršūnė. Čia yra keli šaltiniai, kurie man pasirodė naudingi mano pačių tyrinėjimuose:

  • „Addy Osmani“ mokosi „JavaScript“ dizaino modelių: detalių lobynas įspūdingai glaustai
  • Ben Cherry pakankamai gerai: naudinga apžvalga su pažangesnio modulio modelio naudojimo pavyzdžiais
  • Carl Danley tinklaraštis: modulio modelio apžvalga ir kitų „JavaScript“ modelių šaltiniai.

CommonJS ir AMD

Visų pirma požiūriai turi vieną bendrą bruožą: vieno visuotinio kintamojo naudojimas kodui suvynioti į funkciją, taip sukuriant privačią vardų sritį naudojant uždarymo sritį.

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.

Tada galite atsisukti ir vėl juos sujungti, jokių problemų. Tai tiesiog „veikia“.

Žvilgsnis į priekį: modulių sujungimas

Oho! Kur dingsta laikas? Tai buvo nepaprastas važiavimas, bet nuoširdžiai tikiuosi, kad tai leido geriau suprasti „JavaScript“ modulius.

Kitame skyriuje apžvelgsiu modulių grupavimą, apimančią pagrindines temas, įskaitant:

  • Kodėl mes sujungiame modulius
  • Skirtingi grupavimo metodai
  • „ECMAScript“ modulio įkėlimo API
  • …ir dar. :)

PASTABA: Kad viskas būtų paprasta, šiame pranešime praleidau kai kurias smulkmenas (pagalvokite: ciklinės priklausomybės). Jei aš praleidau ką nors svarbaus ir (arba) patrauklaus, praneškite apie tai komentaruose!