轉(zhuǎn)載原文https://www.cnblogs.com/libin-1/p/7127481.html
為什么有模塊概念
理想情況下,開發(fā)者只需要實現(xiàn)核心的業(yè)務(wù)邏輯阀趴,其他都可以加載別人已經(jīng)寫好的模塊昏翰。
但是,Javascript不是一種模塊化編程語言刘急,在es6以前棚菊,它是不支持”類”(class),所以也就沒有”模塊”(module)了叔汁。
require時代
Javascript社區(qū)做了很多努力统求,在現(xiàn)有的運行環(huán)境中检碗,實現(xiàn)”模塊”的效果。
原始寫法
模塊就是實現(xiàn)特定功能的一組方法码邻。
只要把不同的函數(shù)(以及記錄狀態(tài)的變量)簡單地放在一起折剃,就算是一個模塊。
function m1(){
//...
}
function m2(){
//...
}
上面的函數(shù)m1()和m2()像屋,組成一個模塊怕犁。使用的時候,直接調(diào)用就行了开睡。
這種做法的缺點很明顯:”污染”了全局變量因苹,無法保證不與其他模塊發(fā)生變量名沖突,而且模塊成員之間看不出直接關(guān)系篇恒。
對象寫法
為了解決上面的缺點扶檐,可以把模塊寫成一個對象,所有的模塊成員都放到這個對象里面
var module1 = new Object({
_count : 0,
m1 : function (){
//...
},
m2 : function (){
//...
}
});
上面的函數(shù)m1()和m2()胁艰,都封裝在module1對象里款筑。使用的時候,就是調(diào)用這個對象的屬性
module1.m1();
這樣的寫法會暴露所有模塊成員腾么,內(nèi)部狀態(tài)可以被外部改寫奈梳。比如,外部代碼可以直接改變內(nèi)部計數(shù)器的值解虱。
module._count = 1;
立即執(zhí)行函數(shù)寫法
使用”立即執(zhí)行函數(shù)”(Immediately-Invoked Function Expression攘须,IIFE),可以達到不暴露私有成員的目的
var module = (function() {
var _count = 0;
var m1 = function() {
alert(_count)
}
var m2 = function() {
alert(_count + 1)
}
return {
m1: m1,
m2: m2
}
})()
使用上面的寫法殴泰,外部代碼無法讀取內(nèi)部的_count變量于宙。
console.info(module._count); //undefined
module就是Javascript模塊的基本寫法。
主流模塊規(guī)范
在es6以前悍汛,還沒有提出一套官方的規(guī)范,從社區(qū)和框架推廣程度而言,目前通行的javascript模塊規(guī)范有兩種:CommonJS 和 AMD
CommonJS規(guī)范
2009年捞魁,美國程序員Ryan Dahl創(chuàng)造了node.js項目,將javascript語言用于服務(wù)器端編程离咐。
這標志”Javascript模塊化編程”正式誕生谱俭。前端的復(fù)雜程度有限,沒有模塊也是可以的宵蛀,但是在服務(wù)器端昆著,一定要有模塊,與操作系統(tǒng)和其他應(yīng)用程序互動糖埋,否則根本沒法編程宣吱。
node編程中最重要的思想之一就是模塊,而正是這個思想瞳别,讓JavaScript的大規(guī)模工程成為可能征候。模塊化編程在js界流行杭攻,也是基于此,隨后在瀏覽器端疤坝,requirejs和seajs之類的工具包也出現(xiàn)了兆解,可以說在對應(yīng)規(guī)范下,require統(tǒng)治了ES6之前的所有模塊化編程跑揉,即使現(xiàn)在锅睛,在ES6 module被完全實現(xiàn)之前,還是這樣历谍。
在CommonJS中,暴露模塊使用module.exports和exports现拒,很多人不明白暴露對象為什么會有兩個,后面會介紹區(qū)別
在CommonJS中,有一個全局性方法require()望侈,用于加載模塊印蔬。假定有一個數(shù)學(xué)模塊math.js分冈,就可以像下面這樣加載戚嗅。
var math = require('math');
然后,就可以調(diào)用模塊提供的方法:
var math = require('math');
math.add(2,3); // 5
正是由于CommonJS 使用的require方式的推動撩幽,才有了后面的AMD捐韩、CMD 也采用的require方式來引用模塊的風(fēng)格
AMD規(guī)范
有了服務(wù)器端模塊以后退唠,很自然地,大家就想要客戶端模塊荤胁。而且最好兩者能夠兼容瞧预,一個模塊不用修改,在服務(wù)器和瀏覽器都可以運行仅政。
但是松蒜,由于一個重大的局限,使得CommonJS規(guī)范不適用于瀏覽器環(huán)境已旧。還是上一節(jié)的代碼,如果在瀏覽器中運行召娜,會有一個很大的問題
var math = require('math');
math.add(2, 3);
第二行math.add(2, 3)运褪,在第一行require(‘math’)之后運行,因此必須等math.js加載完成玖瘸。也就是說秸讹,如果加載時間很長,整個應(yīng)用就會停在那里等雅倒。
這對服務(wù)器端不是一個問題璃诀,因為所有的模塊都存放在本地硬盤,可以同步加載完成蔑匣,等待時間就是硬盤的讀取時間劣欢。但是棕诵,對于瀏覽器,這卻是一個大問題凿将,因為模塊都放在服務(wù)器端校套,等待時間取決于網(wǎng)速的快慢,可能要等很長時間牧抵,瀏覽器處于”假死”狀態(tài)笛匙。
因此,瀏覽器端的模塊犀变,不能采用”同步加載”(synchronous)妹孙,只能采用”異步加載”(asynchronous)。這就是AMD規(guī)范誕生的背景获枝。
AMD是”Asynchronous Module Definition”的縮寫蠢正,意思就是”異步模塊定義”。它采用異步方式加載模塊映琳,模塊的加載不影響它后面語句的運行机隙。所有依賴這個模塊的語句,都定義在一個回調(diào)函數(shù)中萨西,等到加載完成之后有鹿,這個回調(diào)函數(shù)才會運行。
模塊必須采用特定的define()函數(shù)來定義谎脯。
define(id?, dependencies?, factory)
- id:字符串葱跋,模塊名稱(可選)
- dependencies: 是我們要載入的依賴模塊(可選),使用相對路徑源梭。,注意是數(shù)組格式
- factory: 工廠方法娱俺,返回一個模塊函數(shù)
如果一個模塊不依賴其他模塊,那么可以直接定義在define()函數(shù)之中废麻。
// math.js
define(function (){
var add = function (x,y){
return x+y;
};
return {
add: add
};
});
如果這個模塊還依賴其他模塊荠卷,那么define()函數(shù)的第一個參數(shù),必須是一個數(shù)組烛愧,指明該模塊的依賴性油宜。
define(['Lib'], function(Lib){
function foo(){
Lib.doSomething();
}
return {
foo : foo
};
});
當require()函數(shù)加載上面這個模塊的時候,就會先加載Lib.js文件怜姿。
AMD也采用require()語句加載模塊慎冤,但是不同于CommonJS,它要求兩個參數(shù):
require([module], callback);
第一個參數(shù)[module]沧卢,是一個數(shù)組蚁堤,里面的成員就是要加載的模塊;第二個參數(shù)callback但狭,則是加載成功之后的回調(diào)函數(shù)披诗。如果將前面的代碼改寫成AMD形式撬即,就是下面這樣:
require(['math'], function (math) {
math.add(2, 3);
});
math.add()與math模塊加載不是同步的,瀏覽器不會發(fā)生假死藤巢。所以很顯然搞莺,AMD比較適合瀏覽器環(huán)境。
目前掂咒,主要有兩個Javascript庫實現(xiàn)了AMD規(guī)范:require.js和curl.js才沧。
CMD規(guī)范
CMD (Common Module Definition), 是seajs推崇的規(guī)范,CMD則是依賴就近绍刮,用的時候再require温圆。它寫起來是這樣的:
define(function(require, exports, module) {
var clock = require('clock');
clock.start();
});
CMD與AMD一樣,也是采用特定的define()函數(shù)來定義,用require方式來引用模塊
define(id?, dependencies?, factory)
- id:字符串孩革,模塊名稱(可選)
- dependencies: 是我們要載入的依賴模塊(可選)岁歉,使用相對路徑。,注意是數(shù)組格式
- factory: 工廠方法膝蜈,返回一個模塊函數(shù)
define('hello', ['jquery'], function(require, exports, module) {
// 模塊代碼
});
如果一個模塊不依賴其他模塊锅移,那么可以直接定義在define()函數(shù)之中。
define(function(require, exports, module) {
// 模塊代碼
});
注意:帶 id 和 dependencies 參數(shù)的 define 用法不屬于 CMD 規(guī)范饱搏,而屬于 Modules/Transport 規(guī)范非剃。
CMD與AMD區(qū)別
AMD和CMD最大的區(qū)別是對依賴模塊的執(zhí)行時機處理不同,而不是加載的時機或者方式不同推沸,二者皆為異步加載模塊备绽。
AMD依賴前置,js可以方便知道依賴模塊是誰鬓催,立即加載肺素;
而CMD就近依賴,需要使用把模塊變?yōu)樽址馕鲆槐椴胖酪蕾嚵四切┠K宇驾,這也是很多人詬病CMD的一點倍靡,犧牲性能來帶來開發(fā)的便利性,實際上解析模塊用的時間短到可以忽略课舍。
現(xiàn)階段的標準
ES6標準發(fā)布后菌瘫,module成為標準,標準使用是以export指令導(dǎo)出接口布卡,以import引入模塊,但是在我們一貫的node模塊中雇盖,我們依然采用的是CommonJS規(guī)范忿等,使用require引入模塊,使用module.exports導(dǎo)出接口崔挖。
export導(dǎo)出模塊
export語法聲明用于導(dǎo)出函數(shù)贸街、對象庵寞、指定文件(或模塊)的原始值。
注意:在node中使用的是exports,不要混淆了
export有兩種模塊導(dǎo)出方式:命名式導(dǎo)出(名稱導(dǎo)出)和默認導(dǎo)出(定義式導(dǎo)出)薛匪,命名式導(dǎo)出每個模塊可以多個捐川,而默認導(dǎo)出每個模塊僅一個。
export { name1, name2, …, nameN };
export { variable1 as name1, variable2 as name2, …, nameN };
export let name1, name2, …, nameN; // also var
export let name1 = …, name2 = …, …, nameN; // also var, const
export default expression;
export default function (…) { … } // also class, function*
export default function name1(…) { … } // also class, function*
export { name1 as default, … };
export * from …;
export { name1, name2, …, nameN } from …;
export { import1 as name1, import2 as name2, …, nameN } from …;
- name1… nameN-導(dǎo)出的“標識符”逸尖。導(dǎo)出后古沥,可以通過這個“標識符”在另一個模塊中使用import引用
- default-設(shè)置模塊的默認導(dǎo)出。設(shè)置后import不通過“標識符”而直接引用默認導(dǎo)入
- -繼承模塊并導(dǎo)出繼承模塊所有的方法和屬性
- as-重命名導(dǎo)出“標識符”
- from-從已經(jīng)存在的模塊娇跟、腳本文件…導(dǎo)出
命名式導(dǎo)出
模塊可以通過export前綴關(guān)鍵詞聲明導(dǎo)出對象岩齿,導(dǎo)出對象可以是多個。這些導(dǎo)出對象用名稱進行區(qū)分苞俘,稱之為命名式導(dǎo)出盹沈。
export { myFunction }; // 導(dǎo)出一個已定義的函數(shù)
export const foo = Math.sqrt(2); // 導(dǎo)出一個常量
我們可以使用*和from關(guān)鍵字來實現(xiàn)的模塊的繼承:
export * from 'article';
模塊導(dǎo)出時,可以指定模塊的導(dǎo)出成員吃谣。導(dǎo)出成員可以認為是類中的公有對象乞封,而非導(dǎo)出成員可以認為是類中的私有對象:
var name = 'IT筆錄';
var domain = 'http://itbilu.com';
export {name, domain}; // 相當于導(dǎo)出
{name:name,domain:domain}
模塊導(dǎo)出時,我們可以使用as關(guān)鍵字對導(dǎo)出成員進行重命名:
var name = 'IT筆錄';
var domain = 'http://itbilu.com';
export {name as siteName, domain};
注意岗憋,下面的語法有嚴重錯誤的情況:
// 錯誤演示
export 1; // 絕對不可以
var a = 100;
export a;
export在導(dǎo)出接口的時候肃晚,必須與模塊內(nèi)部的變量具有一一對應(yīng)的關(guān)系。直接導(dǎo)出1沒有任何意義澜驮,也不可能在import的時候有一個變量與之對應(yīng)
export a
雖然看上去成立陷揪,但是a的值是一個數(shù)字,根本無法完成解構(gòu)杂穷,因此必須寫成export {a}
的形式悍缠。即使a被賦值為一個function,也是不允許的耐量。而且飞蚓,大部分風(fēng)格都建議,模塊中最好在末尾用一個export導(dǎo)出所有的接口廊蜒,例如:
export {fun as default,a,b,c};
默認導(dǎo)出
默認導(dǎo)出也被稱做定義式導(dǎo)出趴拧。命名式導(dǎo)出可以導(dǎo)出多個值,但在在import引用時山叮,也要使用相同的名稱來引用相應(yīng)的值著榴。而默認導(dǎo)出每個導(dǎo)出只有一個單一值,這個輸出可以是一個函數(shù)屁倔、類或其它類型的值脑又,這樣在模塊import導(dǎo)入時也會很容易引用。
export default function() {}; // 可以導(dǎo)出一個函數(shù)
export default class(){}; // 也可以出一個類
命名式導(dǎo)出與默認導(dǎo)出
默認導(dǎo)出可以理解為另一種形式的命名導(dǎo)出,默認導(dǎo)出可以認為是使用了default名稱的命名導(dǎo)出问麸。
下面兩種導(dǎo)出方式是等價的:
const D = 123;
export default D;
export { D as default };
export使用示例
使用名稱導(dǎo)出一個模塊時:
// "my-module.js" 模塊
export function cube(x) {
return x * x * x;
}
const foo = Math.PI + Math.SQRT2;
export { foo };
在另一個模塊(腳本文件)中往衷,我們可以像下面這樣引用:
import { cube, foo } from 'my-module';
console.log(cube(3)); // 27
console.log(foo); // 4.555806215962888
使用默認導(dǎo)出一個模塊時:
// "my-module.js"模塊
export default function (x) {
return x * x * x;
}
在另一個模塊(腳本文件)中,我們可以像下面這樣引用严卖,相對名稱導(dǎo)出來說使用更為簡單:
// 引用 "my-module.js"模塊
import cube from 'my-module';
console.log(cube(3)); // 27
import引入模塊
import語法聲明用于從已導(dǎo)出的模塊席舍、腳本中導(dǎo)入函數(shù)、對象哮笆、指定文件(或模塊)的原始值来颤。
import模塊導(dǎo)入與export模塊導(dǎo)出功能相對應(yīng),也存在兩種模塊導(dǎo)入方式:命名式導(dǎo)入(名稱導(dǎo)入)和默認導(dǎo)入(定義式導(dǎo)入)疟呐。
import的語法跟require不同脚曾,而且import必須放在文件的最開始,且前面不允許有其他邏輯代碼启具,這和其他所有編程語言風(fēng)格一致本讥。
import defaultMember from "module-name";
import * as name from "module-name";
import { member } from "module-name";
import { member as alias } from "module-name";
import { member1 , member2 } from "module-name";
import { member1 , member2 as alias2 , [...] } from "module-name";
import defaultMember, { member [ , [...] ] } from "module-name";
import defaultMember, * as name from "module-name";
import "module-name";
- name-從將要導(dǎo)入模塊中收到的導(dǎo)出值的名稱
- member, memberN-從導(dǎo)出模塊,導(dǎo)入指定名稱的多個成員
- defaultMember-從導(dǎo)出模塊鲁冯,導(dǎo)入默認導(dǎo)出成員
- alias, aliasN-別名拷沸,對指定導(dǎo)入成員進行的重命名
- module-name-要導(dǎo)入的模塊。是一個文件名
- as-重命名導(dǎo)入成員名稱(“標識符”)
- from-從已經(jīng)存在的模塊薯演、腳本文件等導(dǎo)入
命名式導(dǎo)入
我們可以通過指定名稱撞芍,就是將這些成員插入到當作用域中。導(dǎo)出時跨扮,可以導(dǎo)入單個成員或多個成員:
注意序无,花括號里面的變量與export后面的變量一一對應(yīng)
import {myMember} from "my-module";
import {foo, bar} from "my-module";
通過*符號,我們可以導(dǎo)入模塊中的全部屬性和方法衡创。當導(dǎo)入模塊全部導(dǎo)出內(nèi)容時帝嗡,就是將導(dǎo)出模塊(’my-module.js’)所有的導(dǎo)出綁定內(nèi)容,插入到當前模塊(’myModule’)的作用域中:
import * as myModule from "my-module";
導(dǎo)入模塊對象時璃氢,也可以使用as對導(dǎo)入成員重命名哟玷,以方便在當前模塊內(nèi)使用:
import {reallyReallyLongModuleMemberName as shortName} from "my-module";
導(dǎo)入多個成員時,同樣可以使用別名:
import {reallyReallyLongModuleMemberName as shortName, anotherLongModuleName as short} from "my-module";
導(dǎo)入一個模塊一也,但不進行任何綁定:
import "my-module";
默認導(dǎo)入
在模塊導(dǎo)出時巢寡,可能會存在默認導(dǎo)出。同樣的椰苟,在導(dǎo)入時可以使用import指令導(dǎo)出這些默認值抑月。
直接導(dǎo)入默認值:
import myDefault from "my-module";
也可以在命名空間導(dǎo)入和名稱導(dǎo)入中,同時使用默認導(dǎo)入:
import myDefault, * as myModule from "my-module"; // myModule 做為命名空間使用
或
import myDefault, {foo, bar} from "my-module"; // 指定成員導(dǎo)入
import使用示例
// --file.js--
function getJSON(url, callback) {
let xhr = new XMLHttpRequest();
xhr.onload = function () {
callback(this.responseText)
};
xhr.open("GET", url, true);
xhr.send();
}
export function getUsefulContents(url, callback) {
getJSON(url, data => callback(JSON.parse(data)));
}
// --main.js--
import { getUsefulContents } from "file";
getUsefulContents("http://itbilu.com", data => {
doSomethingUseful(data);
});
default關(guān)鍵字
// d.js
export default function() {}
// 等效于:
function a() {};
export {a as default};
在import的時候舆蝴,可以這樣用:
import a from './d';
// 等效于爪幻,或者說就是下面這種寫法的簡寫菱皆,是同一個意思
import {default as a} from './d';
這個語法糖的好處就是import的時候,可以省去花括號{}挨稿。
簡單的說,如果import的時候京痢,你發(fā)現(xiàn)某個變量沒有花括號括起來(沒有*號)奶甘,那么你在腦海中應(yīng)該把它還原成有花括號的as語法。
所以祭椰,下面這種寫法你也應(yīng)該理解了吧:
import $,{each,map} from 'jquery';
import后面第一個 $
是 { defalut as $}
的替代寫法臭家。
as關(guān)鍵字
as簡單的說就是取一個別名,export中可以用,import中其實可以用:
// a.js
var a = function() {};
export {a as fun};
// b.js
import {fun as a} from './a';
a();
上面這段代碼方淤,export的時候钉赁,對外提供的接口是fun,它是a.js內(nèi)部a這個函數(shù)的別名携茂,但是在模塊外面你踩,認不到a,只能認到fun讳苦。
import中的as就很簡單带膜,就是你在使用模塊里面的方法的時候,給這個方法取一個別名鸳谜,好在當前的文件里面使用膝藕。之所以是這樣,是因為有的時候不同的兩個模塊可能通過相同的接口咐扭,比如有一個c.js也通過了fun這個接口:
// c.js
export function fun() {};
如果在b.js中同時使用a和c這兩個模塊芭挽,就必須想辦法解決接口重名的問題,as就解決了蝗肪。
CommonJS中module.exports 與 exports的區(qū)別
Module.exports
The module.exports object is created by the Module system. Sometimes this is not acceptable; many want their module to be an instance of some class. To do this, assign the desired export object to module.exports. Note that assigning the desired object to exports will simply rebind the local exports variable, which is probably not what you want to do.
譯文:module.exports對象是由模塊系統(tǒng)創(chuàng)建的袜爪。 有時這是難以接受的;許多人希望他們的模塊成為某個類的實例穗慕。 為了實現(xiàn)這個饿敲,需要將期望導(dǎo)出的對象賦值給module.exports。 注意逛绵,將期望的對象賦值給exports會簡單地重新綁定到本地exports變量上怀各,這可能不是你想要的。
exports
The exports variable is available within a module’s file-level scope, and is assigned the value of module.exports before the module is evaluated. It allows a shortcut, so that module.exports.f = … can be written more succinctly as exports.f = …. However, be aware that like any variable, if a new value is assigned to exports, it is no longer bound to module.exports:
譯文:exports變量是在模塊的文件級別作用域內(nèi)有效的术浪,它在模塊被執(zhí)行前被賦于 module.exports 的值瓢对。它有一個快捷方式,以便 module.exports.f = … 可以被更簡潔地寫成exports.f = …胰苏。 注意硕蛹,就像任何變量,如果一個新的值被賦值給exports,它就不再綁定到module.exports(其實是exports.屬性會自動掛載到?jīng)]有命名沖突的module.exports.屬性)
從Api文檔上面的可以看出法焰,從require導(dǎo)入方式去理解秧荆,關(guān)鍵有兩個變量(全局變量module.exports,局部變量exports)埃仪、一個返回值(module.exports)
function require(...) {
var module = { exports: {} };
((module, exports) => {
// 你的被引入代碼 Start
// var exports = module.exports = {}; (默認都有的)
function some_func() {};
exports = some_func;
// 此時乙濒,exports不再掛載到module.exports,
// export將導(dǎo)出{}默認對象
module.exports = some_func;
// 此時卵蛉,這個模塊將導(dǎo)出some_func對象颁股,覆蓋exports上的some_func
// 你的被引入代碼 End
})(module, module.exports);
// 不管是exports還是module.exports,最后返回的還是module.exports
return module.exports;
}
demo.js:
console.log(exports); // {}
console.log(module.exports); // {}
console.log(exports === module.exports); // true
console.log(exports == module.exports); // true
console.log(module);
/**
Module {
id: '.',
exports: {},
parent: null,
filename: '/Users/larben/Desktop/demo.js',
loaded: false,
children: [],
paths:
[ '/Users/larben/Desktop/node_modules',
'/Users/larben/node_modules',
'/Users/node_modules',
'/node_modules' ] }
*/
注意
- 每個js文件一創(chuàng)建傻丝,都有一個var exports = module.exports = {},使exports和module.exports都指向一個空對象甘有。
- module.exports和exports所指向的內(nèi)存地址相同