โมดูล JavaScript: คู่มือสำหรับผู้เริ่มต้น

หากคุณเป็นมือใหม่ในการใช้งาน JavaScript ศัพท์แสงเช่น "โมดูลบันเดิลเลอร์เทียบกับตัวโหลดโมดูล" "Webpack vs. Browserify" และ "AMD เทียบกับ CommonJS" อาจทำให้เกิดปัญหาได้อย่างรวดเร็ว

ระบบโมดูล JavaScript อาจเป็นเรื่องที่น่ากลัว แต่การทำความเข้าใจเป็นสิ่งสำคัญสำหรับนักพัฒนาเว็บ

ในโพสต์นี้ฉันจะแกะคำศัพท์เหล่านี้ให้คุณเป็นภาษาอังกฤษธรรมดา (และตัวอย่างโค้ดเล็กน้อย) ฉันหวังว่าคุณจะพบว่ามีประโยชน์!

หมายเหตุ: เพื่อความเรียบง่ายสิ่งนี้จะแบ่งออกเป็นสองส่วน: ส่วนที่ 1 จะอธิบายว่าโมดูลคืออะไรและทำไมเราจึงใช้โมดูลเหล่านี้ ส่วนที่ 2 (โพสต์ในสัปดาห์หน้า) จะอธิบายถึงความหมายของการรวมโมดูลและวิธีต่างๆในการดำเนินการ

ตอนที่ 1: ใครช่วยอธิบายได้ไหมว่ามีโมดูลอะไรอีกบ้าง

ผู้เขียนที่ดีแบ่งหนังสือของพวกเขาออกเป็นบทและส่วนต่างๆ โปรแกรมเมอร์ที่ดีจะแบ่งโปรแกรมออกเป็นโมดูล

เช่นเดียวกับบทของหนังสือโมดูลเป็นเพียงกลุ่มของคำ (หรือรหัสแล้วแต่กรณี)

อย่างไรก็ตามโมดูลที่ดีนั้นมีอยู่ในตัวสูงและมีฟังก์ชันการทำงานที่แตกต่างกันทำให้สามารถสับถอดหรือเพิ่มได้ตามความจำเป็นโดยไม่รบกวนระบบโดยรวม

ทำไมต้องใช้โมดูล?

มีประโยชน์มากมายในการใช้โมดูลเพื่อสนับสนุนโค้ดเบสที่แผ่กิ่งก้านสาขาและพึ่งพาซึ่งกันและกัน สิ่งที่สำคัญที่สุดในความคิดของฉันคือ:

1) การบำรุงรักษา:ตามคำนิยามโมดูลมีอยู่ในตัว โมดูลที่ออกแบบมาอย่างดีมีจุดมุ่งหมายเพื่อลดการพึ่งพาส่วนต่างๆของ codebase ให้มากที่สุดเพื่อให้สามารถเติบโตและปรับปรุงได้อย่างอิสระ การอัปเดตโมดูลเดียวจะง่ายกว่ามากเมื่อโมดูลถูกแยกออกจากโค้ดส่วนอื่น ๆ

กลับไปที่ตัวอย่างหนังสือของเราหากคุณต้องการอัปเดตบทในหนังสือของคุณมันจะเป็นฝันร้ายหากการเปลี่ยนแปลงเล็กน้อยในบทหนึ่งทำให้คุณต้องปรับแต่งบทอื่น ๆ ด้วย แต่คุณต้องการเขียนแต่ละบทในลักษณะที่สามารถปรับปรุงได้โดยไม่ส่งผลกระทบต่อบทอื่น ๆ

2) Namespacing:ใน JavaScript ตัวแปรที่อยู่นอกขอบเขตของฟังก์ชันระดับบนสุดจะเป็นแบบโกลบอล (หมายความว่าทุกคนสามารถเข้าถึงได้) ด้วยเหตุนี้จึงเป็นเรื่องปกติที่จะมี "เนมสเปซมลพิษ" โดยที่โค้ดที่ไม่เกี่ยวข้องทั้งหมดแชร์ตัวแปรร่วมกัน

การแบ่งปันตัวแปรส่วนกลางระหว่างโค้ดที่ไม่เกี่ยวข้องถือเป็นสิ่งสำคัญในการพัฒนา

ดังที่เราจะเห็นในโพสต์นี้โมดูลช่วยให้เราสามารถหลีกเลี่ยงมลพิษเนมสเปซได้โดยการสร้างพื้นที่ส่วนตัวสำหรับตัวแปรของเรา

3) ความสามารถในการนำกลับมาใช้ใหม่: พูดตามตรง: เราได้คัดลอกโค้ดทั้งหมดที่เราเคยเขียนไว้ในโครงการใหม่ในช่วงเวลาหนึ่ง ตัวอย่างเช่นสมมติว่าคุณคัดลอกวิธียูทิลิตี้บางอย่างที่คุณเขียนจากโครงการก่อนหน้าไปยังโครงการปัจจุบันของคุณ

นั่นคือทั้งหมดที่ดีและดี แต่ถ้าคุณพบวิธีที่ดีกว่าในการเขียนบางส่วนของโค้ดนั้นคุณจะต้องกลับไปและอย่าลืมอัปเดตทุกที่ที่คุณเขียน

เห็นได้ชัดว่าเป็นการเสียเวลาอย่างมาก มันจะง่ายกว่านี้ไหมถ้ามี - รอมัน - โมดูลที่เราสามารถนำกลับมาใช้ซ้ำแล้วซ้ำเล่า?

คุณจะรวมโมดูลได้อย่างไร?

มีหลายวิธีในการรวมโมดูลเข้ากับโปรแกรมของคุณ เรามาดูบางส่วนของพวกเขา:

รูปแบบโมดูล

รูปแบบโมดูลใช้เพื่อเลียนแบบแนวคิดของคลาส (เนื่องจาก JavaScript ไม่สนับสนุนคลาสโดยกำเนิด) เพื่อให้เราสามารถจัดเก็บวิธีการและตัวแปรทั้งแบบสาธารณะและแบบส่วนตัวไว้ในอ็อบเจ็กต์เดียวซึ่งเหมือนกับการใช้คลาสในภาษาโปรแกรมอื่น ๆ เช่น Java หรือ Python ซึ่งช่วยให้เราสามารถสร้าง API ที่เปิดเผยต่อสาธารณะสำหรับวิธีการที่เราต้องการเปิดเผยต่อโลกในขณะที่ยังห่อหุ้มตัวแปรและวิธีการส่วนตัวไว้ในขอบเขตการปิด

มีหลายวิธีในการทำให้รูปแบบโมดูลสำเร็จ ในตัวอย่างแรกนี้ฉันจะใช้การปิดแบบไม่ระบุตัวตน ซึ่งจะช่วยให้เราบรรลุเป้าหมายโดยใส่รหัสทั้งหมดของเราในฟังก์ชันที่ไม่ระบุตัวตน (ข้อควรจำ: ใน JavaScript ฟังก์ชันเป็นวิธีเดียวในการสร้างขอบเขตใหม่)

ตัวอย่างที่ 1: การปิดโดยไม่ระบุชื่อ

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

ด้วยโครงสร้างนี้ฟังก์ชันที่ไม่ระบุตัวตนของเราจะมีสภาพแวดล้อมการประเมินหรือ "การปิด" ของตัวเองจากนั้นเราจะประเมินทันที สิ่งนี้ช่วยให้เราซ่อนตัวแปรจากเนมสเปซระดับบนสุด (ส่วนกลาง)

สิ่งที่ดีเกี่ยวกับแนวทางนี้คือคุณสามารถใช้ตัวแปรภายในภายในฟังก์ชันนี้ได้โดยไม่ต้องเขียนทับตัวแปรส่วนกลางที่มีอยู่โดยไม่ได้ตั้งใจ แต่ก็ยังเข้าถึงตัวแปรส่วนกลางได้เช่น

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

โปรดทราบว่าจำเป็นต้องมีวงเล็บรอบฟังก์ชันที่ไม่ระบุชื่อเนื่องจากคำสั่งที่ขึ้นต้นด้วยฟังก์ชันคำสำคัญจะถือว่าเป็นการประกาศฟังก์ชันเสมอ (โปรดจำไว้ว่าคุณไม่สามารถประกาศฟังก์ชันที่ไม่มีชื่อใน JavaScript ได้) ดังนั้นวงเล็บที่อยู่รอบ ๆ จึงสร้างนิพจน์ฟังก์ชัน แทน. หากคุณสงสัยคุณสามารถอ่านเพิ่มเติมได้ที่นี่

ตัวอย่างที่ 2: การนำเข้าทั่วโลก

อีกวิธีหนึ่งที่นิยมใช้โดยไลบรารีเช่น jQuery คือการนำเข้าทั่วโลก มันคล้ายกับการปิดแบบไม่ระบุตัวตนที่เราเพิ่งเห็นยกเว้นตอนนี้เราส่งผ่าน globals เป็นพารามิเตอร์:

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

ในตัวอย่างนี้globalVariableเป็นตัวแปรเดียวที่เป็น global ข้อดีของวิธีนี้ในการปิดแบบไม่ระบุตัวตนคือการที่คุณประกาศตัวแปรทั่วโลกล่วงหน้าทำให้คนอ่านรหัสของคุณชัดเจน

ตัวอย่างที่ 3: ส่วนต่อประสานของวัตถุ

อีกวิธีหนึ่งคือการสร้างโมดูลโดยใช้อินเทอร์เฟซอ็อบเจ็กต์ในตัวเช่น:

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

อย่างที่คุณเห็นวิธีนี้ช่วยให้เราสามารถตัดสินใจได้ว่าตัวแปร / วิธีการใดที่เราต้องการให้เป็นส่วนตัว (เช่นmyGrades ) และตัวแปร / วิธีการใดที่เราต้องการเปิดเผยโดยใส่ไว้ในคำสั่ง return (เช่นค่าเฉลี่ย & ค่าล้มเหลว )

ตัวอย่างที่ 4: เปิดเผยรูปแบบโมดูล

สิ่งนี้คล้ายกับแนวทางข้างต้นมากยกเว้นว่าจะทำให้แน่ใจว่าวิธีการและตัวแปรทั้งหมดจะถูกเก็บไว้เป็นส่วนตัวจนกว่าจะเปิดเผยอย่างชัดเจน:

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

นั่นอาจดูเหมือนเป็นเรื่องที่ต้องทำ แต่มันเป็นเพียงส่วนเล็ก ๆ ของภูเขาน้ำแข็งเมื่อพูดถึงรูปแบบโมดูล นี่คือแหล่งข้อมูลบางส่วนที่ฉันพบว่ามีประโยชน์ในการสำรวจของฉันเอง:

  • การเรียนรู้รูปแบบการออกแบบ JavaScript โดย Addy Osmani: ขุมทรัพย์ของรายละเอียดในการอ่านที่รวบรัดอย่างน่าประทับใจ
  • ดีเพียงพอโดย Ben Cherry: ภาพรวมที่มีประโยชน์พร้อมตัวอย่างการใช้งานขั้นสูงของรูปแบบโมดูล
  • บล็อกของ Carl Danley: ภาพรวมรูปแบบโมดูลและแหล่งข้อมูลสำหรับรูปแบบ JavaScript อื่น ๆ

CommonJS และ AMD

แนวทางข้างต้นมีสิ่งหนึ่งที่เหมือนกันคือการใช้ตัวแปรส่วนกลางตัวเดียวเพื่อรวมโค้ดไว้ในฟังก์ชันดังนั้นการสร้างเนมสเปซส่วนตัวสำหรับตัวเองโดยใช้ขอบเขตการปิด

แม้ว่าแต่ละแนวทางจะได้ผลในแบบของตัวเอง แต่ก็มีข้อเสีย

ในฐานะนักพัฒนาคุณจำเป็นต้องทราบลำดับการอ้างอิงที่ถูกต้องในการโหลดไฟล์ของคุณตัวอย่างเช่นสมมติว่าคุณกำลังใช้ Backbone ในโปรเจ็กต์ของคุณดังนั้นคุณจึงรวมแท็กสคริปต์สำหรับซอร์สโค้ดของ Backbone ไว้ในไฟล์ของคุณ

อย่างไรก็ตามเนื่องจาก Backbone มีการพึ่งพา Underscore.js อย่างหนักจึงไม่สามารถวางแท็กสคริปต์สำหรับไฟล์ Backbone ไว้หน้าไฟล์ Underscore.js ได้

ในฐานะนักพัฒนาการจัดการการอ้างอิงและการทำให้สิ่งเหล่านี้ถูกต้องบางครั้งอาจเป็นเรื่องน่าปวดหัว

ข้อเสียอีกประการหนึ่งคือยังสามารถนำไปสู่การชนกันของเนมสเปซได้ ตัวอย่างเช่นจะเกิดอะไรขึ้นถ้าโมดูลสองโมดูลของคุณมีชื่อเดียวกัน? หรือจะเกิดอะไรขึ้นถ้าคุณมีโมดูลสองเวอร์ชันและคุณต้องการทั้งสองอย่าง?

คุณอาจสงสัยว่าเราสามารถออกแบบวิธีขออินเทอร์เฟซของโมดูลโดยไม่ต้องผ่านขอบเขตทั่วโลกได้หรือไม่?

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!