1 Node.js模塊的實(shí)現(xiàn)
之前在網(wǎng)上查閱了許多介紹Node.js的文章,可惜對(duì)于Node.js的模塊機(jī)制大都著墨不多。在后續(xù)介紹模塊的使用之前,我認(rèn)為有必要深入一下Node.js的模塊機(jī)制。
1.1 CommonJS規(guī)范
早在Netscape誕生不久后,JavaScript就一直在探索本地編程的路,Rhino是其代表產(chǎn)物。無(wú)奈那時(shí)服務(wù)端JavaScript走的路均是參考眾多服務(wù)器端語(yǔ)言來(lái)實(shí)現(xiàn)的,在這樣的背景之下,一沒(méi)有特色,二沒(méi)有實(shí)用價(jià)值。但是隨著JavaScript在前端的應(yīng)用越來(lái)越廣泛,以及服務(wù)端JavaScript的推動(dòng),JavaScript現(xiàn)有的規(guī)范十分薄弱,不利于JavaScript大規(guī)模的應(yīng)用。那些以JavaScript為宿主語(yǔ)言的環(huán)境中,只有本身的基礎(chǔ)原生對(duì)象和類型,更多的對(duì)象和API都取決于宿主的提供,所以,我們可以看到JavaScript缺少這些功能:
JavaScript沒(méi)有模塊系統(tǒng)。沒(méi)有原生的支持密閉作用域或依賴管理。
JavaScript沒(méi)有標(biāo)準(zhǔn)庫(kù)。除了一些核心庫(kù)外,沒(méi)有文件系統(tǒng)的API,沒(méi)有IO流API等。
JavaScript沒(méi)有標(biāo)準(zhǔn)接口。沒(méi)有如Web Server或者數(shù)據(jù)庫(kù)的統(tǒng)一接口。
JavaScript沒(méi)有包管理系統(tǒng)。不能自動(dòng)加載和安裝依賴。
于是便有了CommonJS(http://www.commonjs.org)規(guī)范的出現(xiàn),其目標(biāo)是為了構(gòu)建JavaScript在包括Web服務(wù)器,桌面,命令行工具,及瀏覽器方面的生態(tài)系統(tǒng)。CommonJS其實(shí)不是一門新的語(yǔ)言，甚至都不能說(shuō)它是一個(gè)新的解釋器——實(shí)際上它只是一個(gè)概念或者是一個(gè)規(guī)范。
在這個(gè)規(guī)范中，它定義了很多 API ，講通俗點(diǎn)或者直截了當(dāng)點(diǎn)就是函數(shù)啊類啊什么的，而這些 API 是為那些普通應(yīng)用程序（Native App）而非瀏覽器應(yīng)用使用。它的終極目標(biāo)就是提供一個(gè)類似于 Python、Ruby 之類的腳本一樣的標(biāo)準(zhǔn)庫(kù)，開(kāi)發(fā)者可以用這樣的東西一樣來(lái)做到 Python、Ruby 能做到的事，而非僅僅局限于網(wǎng)頁(yè)中的效果或者功能實(shí)現(xiàn)，它也可以跑在本地。所以說(shuō)下面的事情對(duì)于 JavaScript 來(lái)說(shuō)不再是夢(mèng)：
服務(wù)端JavaScript應(yīng)用
命令行工具
圖形界面應(yīng)用
混合應(yīng)用（Titanium、Adobe AIR等）
那么，它具體彌補(bǔ)了前端JavaScript 的哪些空白呢？其實(shí)這也涉及了很多前端JavaScript 所沒(méi)有涉及的東西，如二進(jìn)制、編碼、IO、文件、系統(tǒng)、斷言測(cè)試、套接字、事件隊(duì)列、Worker、控制臺(tái)等等。
CommonJS制定了解決這些問(wèn)題的一些規(guī)范,而Node.js就是這些規(guī)范的一種實(shí)現(xiàn)。Node.js自身實(shí)現(xiàn)了require方法作為其引入模塊的方法,同時(shí)NPM也基于CommonJS定義的包規(guī)范,實(shí)現(xiàn)了依賴管理和模塊自動(dòng)安裝等功能。這里我們將深入一下Node.js的require機(jī)制和NPM基于包規(guī)范的應(yīng)用。
1.2 簡(jiǎn)單模塊定義和使用
在Node.js中,定義一個(gè)模塊十分方便。我們以計(jì)算圓形的面積和周長(zhǎng)兩個(gè)方法為例,來(lái)表現(xiàn)Node.js中模塊的定義方式。
var PI = Math.PI;
exports.area = function (r) {
return PI * r * r;
};
exports.circumference = function (r) {
return 2 * PI * r;
};
將這個(gè)文件存為circle.js,并新建一個(gè)app.js文件,并寫入以下代碼:
var circle = require('./circle.js');
console.log('The area of a circle of radius 4 is' + circle.area(4));
可以看到模塊調(diào)用也十分方便,只需要require需要調(diào)用的文件即可。
在require了這個(gè)文件之后,定義在exports對(duì)象上的方法便可以隨意調(diào)用。Node.js將模塊的定義和調(diào)用都封裝得極其簡(jiǎn)單方便,從API對(duì)用戶友好這一個(gè)角度來(lái)說(shuō),Node.js的模塊機(jī)制是非常優(yōu)秀的。
例如把我們的服務(wù)器腳本放到一個(gè)叫做 start 的函數(shù)里，然后我們會(huì)導(dǎo)出這個(gè)函數(shù)。代碼放在server.js文件：
var http = require("http");
function start() {
function onRequest(request, response) {
console.log("Request received.");
response.writeHead(200, {"Content-Type": "text/plain"});
response.write("Hello World");
response.end();
}
http.createServer(onRequest).listen(8888);
console.log("Server has started.");
}
exports.start = start;
這樣，我們現(xiàn)在就可以創(chuàng)建我們的主文件 index.js 并在其中啟動(dòng)我們的HTTP了，雖然服務(wù)器的代碼還在 server.js 中。創(chuàng)建 index.js 文件并寫入以下內(nèi)容：
var server = require("./server");
server.start();
1.3 exports與module.exports的區(qū)別
上一節(jié)已經(jīng)使用了用來(lái)創(chuàng)建函數(shù)的exports對(duì)象，來(lái)導(dǎo)出一個(gè)模塊（假設(shè)一個(gè)名為rocker.js的文件）：
exports.name = function() {
console.log('My name is Lemmy Kilmister');
};
然后你在另一個(gè)文件中調(diào)用：
var rocker = require('./rocker.js');
rocker.name(); // 'My name is Lemmy Kilmister'
但是module.exports到底是個(gè)什么玩意兒? 它合法嗎？
令人吃驚的是module.exports是真實(shí)存在的東西。exports只是module.exports的輔助方法。你的模塊最終返回module.exports給調(diào)用者，而不是exports。exports所做的事情是收集屬性，如果module.exports當(dāng)前沒(méi)有任何屬性的話，exports會(huì)把這些屬性賦予module.exports。如果module.exports已經(jīng)存在一些屬性的話，那么exports中所用的東西都會(huì)被忽略。
把下面的內(nèi)容放到rocker.js:
module.exports = 'ROCK IT!';
exports.name = function() {
console.log('My name is Lemmy Kilmister');
};
然后把下面的內(nèi)容放到另一個(gè)文件中，執(zhí)行它：
var rocker = require('./rocker.js');
rocker.name(); // TypeError: Object ROCK IT! has no method 'name'
rocker模塊完全忽略了exports.name，然后返回了一個(gè)字符串'ROCK IT!'。通過(guò)上面的例子，你可能認(rèn)識(shí)到你的模塊不一定非得是模塊實(shí)例（module instances）。你的模塊可以是任何合法的JavaScript對(duì)象 - boolean，number，date，JSON， string，function，array和其他。你的模塊可以是任何你賦予module.exports的值。如果你沒(méi)有明確的給module.exports設(shè)置任何值，那么exports中的屬性會(huì)被賦給module.exports中，然后并返回它。
在下面的情況下，你的模塊是一個(gè)類：
module.exports = function(name, age) {
this.name = name;
this.age = age;
this.about = function() {
console.log(this.name +' is '+ this.age +' years old');
};
};
然后你應(yīng)該這樣使用它：
var Rocker = require('./rocker.js');
var r = new Rocker('Ozzy', 62);
r.about(); // Ozzy is 62 years old
在下面的情況下，你的模塊是一個(gè)數(shù)組：
module.exports = ['Lemmy Kilmister', 'Ozzy Osbourne', 'Ronnie James Dio', 'Steven Tyler', 'Mick Jagger'];
然后你應(yīng)該這樣使用它：
var rocker = require('./rocker.js');
console.log('Rockin in heaven: ' + rocker[2]); //Rockin in heaven: Ronnie James Dio
現(xiàn)在你應(yīng)該找到要點(diǎn)了 - 如果你想要你的模塊成為一個(gè)特別的對(duì)象類型，那么使用module.exports；如果你希望你的模塊成為一個(gè)傳統(tǒng)的模塊實(shí)例（module instance），使用exports。
把屬性賦予module.exports的結(jié)果與把屬性賦予給exports是一樣的?？聪旅孢@個(gè)例子：
module.exports.name = function() {
console.log('My name is Lemmy Kilmister');
};
下面這個(gè)做的是一樣的事情：
exports.name = function() {
console.log('My name is Lemmy Kilmister');
};
但是請(qǐng)注意，它們并不是一樣的東西。就像我之前說(shuō)的module.exports是真實(shí)存在的東西，exports只是它的輔助方法。話雖如此，exports還是推薦的對(duì)象，除非你想把你模塊的對(duì)象類型從傳統(tǒng)的模塊實(shí)例（module instance）修改為其他的。
1.4 模塊載入策略
Node.js的模塊分為兩類,一類為原生(核心)模塊,一類為文件模塊。原生模塊在Node.js源代碼編譯的時(shí)候編譯進(jìn)了二進(jìn)制執(zhí)行文件,加載的速度最快。另一類文件模塊是動(dòng)態(tài)加載的,加載速度比原生模塊慢。但是Node.js對(duì)原生模塊和文件模塊都進(jìn)行了緩存,于是在第二次require時(shí),是不會(huì)有重復(fù)開(kāi)銷的。其中原生模塊都被定義在lib這個(gè)目錄下面,文件模塊則不定性。
node app.js
由于通過(guò)命令行加載啟動(dòng)的文件幾乎都為文件模塊。我們從Node.js如何加載文件模塊開(kāi)始談起。加載文件模塊的工作,主要由原生模塊module來(lái)實(shí)現(xiàn)和完成,該原生模塊在啟動(dòng)時(shí)已經(jīng)被加載,進(jìn)程直接調(diào)用到runMain靜態(tài)方法。
// bootstrap main module.
Module.runMain = function () {
// Load the main module--the command line arg
Module._load(process.argv[1], null, true);
};
_load靜態(tài)方法在分析文件名之后執(zhí)行：
var module = new Module(id, parent);
并根據(jù)文件路徑緩存當(dāng)前模塊對(duì)象,該模塊實(shí)例對(duì)象則根據(jù)文件名加載。
module.load(filename);
實(shí)際上在文件模塊中,又分為3類模塊。這三類文件模塊以后綴來(lái)區(qū)分,Node.js會(huì)根據(jù)后綴名來(lái)決定加載方法：
.js。通過(guò)fs模塊同步讀取js文件并編譯執(zhí)行。
.node。通過(guò)C/C++進(jìn)行編寫的Addon。通過(guò)dlopen方法進(jìn)行加載。
.json。讀取文件,調(diào)用JSON.parse解析加載。
這里我們將詳細(xì)描述js后綴的編譯過(guò)程。Node.js在編譯js文件的過(guò)程中實(shí)際完成的步驟有對(duì)js文件內(nèi)容進(jìn)行頭尾包裝。以app.js為例,包裝之后的app.js將會(huì)變成以下形式:
(function (exports, require, module, __filename, __dirname) {
var circle = require('./circle.js');
console.log('The area of a circle of radius 4 is ' + circle.area(4));
});
這段代碼會(huì)通過(guò)vm原生模塊的runInThisContext方法執(zhí)行(類似eval,只是具有明確上下文,不污染全局),返回為一個(gè)具體的function對(duì)象。最后傳入module對(duì)象的exports,require方法,module,文件名,目錄名作為實(shí)參并執(zhí)行。
這就是為什么require并沒(méi)有定義在app.js文件中,但是這個(gè)方法卻存在的原因。從Node.js的API文檔中可以看到還有__filename、__dirname、module、 exports幾個(gè)沒(méi)有定義但是卻存在的變量。其中__filename和__dirname在查找文件路徑的過(guò)程中分析得到后傳入的。module變量是這個(gè)模塊對(duì)象自身,exports是在module的構(gòu)造函數(shù)中初始化的一個(gè)空對(duì)象({},而不是 null)。
在這個(gè)主文件中,可以通過(guò)require方法去引入其余的模塊。而其實(shí)這個(gè)require方法實(shí)際調(diào)用的就是load方法。
load方法在載入、編譯、緩存了module后,返回module的exports對(duì)象。這就是circle.js文件中只有定義在exports對(duì)象上的方法才能被外部調(diào)用的原因。
以上所描述的模塊載入機(jī)制均定義在lib/module.js中。
1.5 require方法中的文件查找策略
由于Node.js中存在4類模塊(原生模塊和3種文件模塊),盡管require方法極其簡(jiǎn)單,但是內(nèi)部的加載卻是十分復(fù)雜的,其加載優(yōu)先級(jí)也各自不同。
-
從文件模塊緩存中加載
盡管原生模塊與文件模塊的優(yōu)先級(jí)不同,但是
都不會(huì)優(yōu)先于從文件模塊的緩存中加載已經(jīng)存在的模塊。 -
從原生模塊加載
原生模塊的優(yōu)先級(jí)僅次于文件模塊緩存的優(yōu)先級(jí)。require方法在解析文件名之后,優(yōu)先檢查模塊是否在原生模塊列表中。以http模塊為例,盡管在目錄下存在一個(gè)http/http.js/http.node/http.json文件,require(“http”)都不會(huì)從這些文件中加載,而是從原生模塊中加載。原生模塊也有一個(gè)緩存區(qū),同樣也是優(yōu)先從緩存區(qū)加載。如果緩存區(qū)沒(méi)有被加載過(guò),則調(diào)用原生模塊的加載方式進(jìn)行加載和執(zhí)行。 -
從文件加載
當(dāng)文件模塊緩存中不存在,而且不是原生模塊的時(shí)候,Node.js會(huì)解析require方法傳入的參數(shù),并從文件系統(tǒng)中加載實(shí)際的文件,加載過(guò)程中的包裝和編譯細(xì)節(jié)在前一節(jié)中已經(jīng)介紹過(guò),這里我們將詳細(xì)描述查找文件模塊的過(guò)程,其中, 也有一些細(xì)節(jié)值得知曉。
require方法接受以下幾種參數(shù)的傳遞:
http、fs、path等,原生模塊。
/mod或../mod,相對(duì)路徑的文件模塊。
/pathtomodule/mod,絕對(duì)路徑的文件模塊。
mod,非原生模塊的文件模塊。
在進(jìn)入路徑查找之前有必要描述一下modulepath這個(gè)Node.js中的概念。對(duì)于每一個(gè)被加載的文件模塊,創(chuàng)建這個(gè)模塊對(duì)象的時(shí)候,這個(gè)模塊便會(huì)有一個(gè)paths屬性,其值根據(jù)當(dāng)前文件的路徑計(jì)算得到。我們創(chuàng)建modulepath.js這樣一個(gè)文件,其內(nèi)容為:
console.log(module.paths);
我們將其放到任意一個(gè)目錄中執(zhí)行node modulepath.js命令,將得到以下的輸出結(jié)果：
[
'/home/jackson/research/node_modules',
'/home/jackson/node_modules',
'/home/node_modules',
'/node_modules'
]
可以看出module path的生成規(guī)則為：從當(dāng)前文件目錄開(kāi)始查找node_modules目錄;然后依次進(jìn)入父目錄,查找父目錄下的node_modules目錄;依次迭代, 直到根目錄下的node_modules目錄。
除此之外還有一個(gè)全局module path,是當(dāng)前node執(zhí)行文件的相對(duì)目錄 (../../lib/node)。如果在環(huán)境變量中設(shè)置了HOME目錄和NODE_PATH目錄的話,整個(gè)路徑還包含NODE_PATH和HOME目錄下的.node_libraries 與.node_modules。其最終值大致如下:
[
NODE_PATH,
HOME/.node_modules,
HOME/.node_libraries,
execPath/../../lib/node
]
下圖是筆者從源代碼中整理出來(lái)的整個(gè)文件查找流程：
簡(jiǎn)而言之,如果require絕對(duì)路徑的文件,查找時(shí)不會(huì)去遍歷每一個(gè)node_modules目錄,其速度最快。其余流程如下:
- 從modulepath數(shù)組中取出第一個(gè)目錄作為查找基準(zhǔn)。
- 直接從目錄中查找該文件,如果存在,則結(jié)束查找。如果不存在,則進(jìn)行下一條查找。
- 嘗試添加.js、.json、.node后綴后查找,如果存在文件,則結(jié)束查找。如果不存在,則進(jìn)行下一條。
- 嘗試將require的參數(shù)作為一個(gè)包來(lái)進(jìn)行查找,讀取目錄下的package.json文件,取得main參數(shù)指定的文件。
- 嘗試查找該文件,如果存在,則結(jié)束查找。如果不存在,則進(jìn)行第3條查找。
- 如果繼續(xù)失敗,則取出modulepath數(shù)組中的下一個(gè)目錄作為基準(zhǔn)查找,循環(huán)第1至5個(gè)步驟。
- 如果繼續(xù)失敗,循環(huán)第1至6個(gè)步驟,直到modulepath中的最后一個(gè)值。
- 如果仍然失敗,則拋出異常。
整個(gè)查找過(guò)程十分類似原型鏈的查找和作用域的查找。所幸Node.js對(duì)路徑查找實(shí)現(xiàn)了緩存機(jī)制,否則由于每次判斷路徑都是同步阻塞式進(jìn)行,會(huì)導(dǎo)致嚴(yán)重的性能消耗。
1.6 包結(jié)構(gòu)
前面提到JavaScript缺少包結(jié)構(gòu)。CommonJS致力于改變這種現(xiàn)狀,于是定義了包的結(jié)構(gòu)規(guī)范(http://wiki.commonjs.org/wiki/Packages/1.0)。而NPM的出現(xiàn)則是為了在CommonJS規(guī)范的基礎(chǔ)上,實(shí)現(xiàn)解決包的安裝卸載,依賴管理,版本管理等問(wèn)題。require的查找機(jī)制明了之后,我們來(lái)看一下包的細(xì)節(jié)。
一個(gè)符合CommonJS規(guī)范的包應(yīng)該是如下這種結(jié)構(gòu):
一個(gè)package.json文件應(yīng)該存在于包頂級(jí)目錄下。
二進(jìn)制文件應(yīng)該包含在bin目錄下。
JavaScript代碼應(yīng)該包含在lib目錄下。
文檔應(yīng)該在doc目錄下。
單元測(cè)試應(yīng)該在test目錄下。
由上文的require的查找過(guò)程可以知道,Node.js在沒(méi)有找到目標(biāo)文件時(shí),會(huì)將當(dāng)前目錄當(dāng)作一個(gè)包來(lái)嘗試加載,所以在package.json文件中最重要的一個(gè)字段就是main。而實(shí)際上,這一處是Node.js的擴(kuò)展,標(biāo)準(zhǔn)定義中并不包含此字段, 對(duì)于require,只需要main屬性即可。但是在除此之外包需要接受安裝、卸載、依賴管理,版本管理等流程,所以CommonJS為package.json文件定義了如下一些必須的字段:
name : 包名,需要在NPM上是唯一的。不能帶有空格。
description : 包簡(jiǎn)介。通常會(huì)顯示在一些列表中。
version : 版本號(hào)。一個(gè)語(yǔ)義化的版本號(hào)(http://semver.org/),通常為x.y.z。該版本號(hào)十分重要,常常用于一些版本控制的場(chǎng)合。
keywords : 關(guān)鍵字?jǐn)?shù)組。用于NPM中的分類搜索。
maintainers : 包維護(hù)者的數(shù)組。數(shù)組元素是一個(gè)包含name、email、web三個(gè)屬性的JSON對(duì)象。
contributors : 包貢獻(xiàn)者的數(shù)組。第一個(gè)就是包的作者本人。在開(kāi)源社區(qū),如果提交的patch被merge進(jìn)master分支的話,就應(yīng)當(dāng)加上這個(gè)貢獻(xiàn)patch的人。格式包含name和email。
"contributors": [{ "name": "Jackson Tian", "email": "mail @gmail.com" }, { "name": "fengmk2", "email": "mail2@gmail.com" }],bugs : 一個(gè)可以提交bug的URL地址?？梢允青]件地址 (mailto:mailxx@domain),也可以是網(wǎng)頁(yè)地址(http://url)。%E3%80%82)
licenses : 包所使用的許可證。例如:
"licenses": [{ "type": "GPLv2", "url": "http://www.example.com/licenses/gpl.html", }]repositories : 托管源代碼的地址數(shù)組。
dependencies : 當(dāng)前包需要的依賴。這個(gè)屬性十分重要,NPM會(huì)通過(guò)這個(gè)屬性,幫你自動(dòng)加載依賴的包。
以下是Express框架的package.json文件,值得參考：
{
"_args": [
[
"express@~4.13.1",
"/Users/TaoBangren/git@osc/king-node"
]
],
"_from": "express@>=4.13.1 <4.14.0",
"_id": "express@4.13.3",
"_inCache": true,
"_installable": true,
"_location": "/express",
"_npmUser": {
"email": "doug@somethingdoug.com",
"name": "dougwilson"
},
"_npmVersion": "1.4.28",
"_phantomChildren": {},
"_requested": {
"name": "express",
"raw": "express@~4.13.1",
"rawSpec": "~4.13.1",
"scope": null,
"spec": ">=4.13.1 <4.14.0",
"type": "range"
},
"_requiredBy": [
"/"
],
"_resolved": "https://registry.npmjs.org/express/-/express-4.13.3.tgz",
"_shasum": "ddb2f1fb4502bf33598d2b032b037960ca6c80a3",
"_shrinkwrap": null,
"_spec": "express@~4.13.1",
"_where": "/Users/TaoBangren/git@osc/king-node",
"author": {
"email": "tj@vision-media.ca",
"name": "TJ Holowaychuk"
},
"bugs": {
"url": "https://github.com/strongloop/express/issues"
},
"contributors": [
{
"name": "Aaron Heckmann",
"email": "aaron.heckmann+github@gmail.com"
},
{
"name": "Ciaran Jessup",
"email": "ciaranj@gmail.com"
},
{
"name": "Douglas Christopher Wilson",
"email": "doug@somethingdoug.com"
},
{
"name": "Guillermo Rauch",
"email": "rauchg@gmail.com"
},
{
"name": "Jonathan Ong",
"email": "me@jongleberry.com"
},
{
"name": "Roman Shtylman",
"email": "shtylman+expressjs@gmail.com"
},
{
"name": "Young Jae Sim",
"email": "hanul@hanul.me"
}
],
"dependencies": {
"accepts": "~1.2.12",
"array-flatten": "1.1.1",
"content-disposition": "0.5.0",
"content-type": "~1.0.1",
"cookie": "0.1.3",
"cookie-signature": "1.0.6",
"debug": "~2.2.0",
"depd": "~1.0.1",
"escape-html": "1.0.2",
"etag": "~1.7.0",
"finalhandler": "0.4.0",
"fresh": "0.3.0",
"merge-descriptors": "1.0.0",
"methods": "~1.1.1",
"on-finished": "~2.3.0",
"parseurl": "~1.3.0",
"path-to-regexp": "0.1.7",
"proxy-addr": "~1.0.8",
"qs": "4.0.0",
"range-parser": "~1.0.2",
"send": "0.13.0",
"serve-static": "~1.10.0",
"type-is": "~1.6.6",
"utils-merge": "1.0.0",
"vary": "~1.0.1"
},
"description": "Fast, unopinionated, minimalist web framework",
"devDependencies": {
"after": "0.8.1",
"body-parser": "~1.13.3",
"connect-redis": "~2.4.1",
"cookie-parser": "~1.3.5",
"cookie-session": "~1.2.0",
"ejs": "2.3.3",
"express-session": "~1.11.3",
"istanbul": "0.3.17",
"jade": "~1.11.0",
"marked": "0.3.5",
"method-override": "~2.3.5",
"mocha": "2.2.5",
"morgan": "~1.6.1",
"multiparty": "~4.1.2",
"should": "7.0.2",
"supertest": "1.0.1",
"vhost": "~3.0.1"
},
"directories": {},
"dist": {
"shasum": "ddb2f1fb4502bf33598d2b032b037960ca6c80a3",
"tarball": "http://registry.npmjs.org/express/-/express-4.13.3.tgz"
},
"engines": {
"node": ">= 0.10.0"
},
"files": [
"History.md",
"LICENSE",
"Readme.md",
"index.js",
"lib/"
],
"gitHead": "ef7ad681b245fba023843ce94f6bcb8e275bbb8e",
"homepage": "http://expressjs.com/",
"keywords": [
"api",
"app",
"express",
"framework",
"rest",
"restful",
"router",
"sinatra",
"web"
],
"license": "MIT",
"maintainers": [
{
"name": "tjholowaychuk",
"email": "tj@vision-media.ca"
},
{
"name": "jongleberry",
"email": "jonathanrichardong@gmail.com"
},
{
"name": "dougwilson",
"email": "doug@somethingdoug.com"
},
{
"name": "rfeng",
"email": "enjoyjava@gmail.com"
},
{
"name": "aredridel",
"email": "aredridel@dinhe.net"
},
{
"name": "strongloop",
"email": "callback@strongloop.com"
},
{
"name": "defunctzombie",
"email": "shtylman@gmail.com"
}
],
"name": "express",
"optionalDependencies": {},
"readme": "ERROR: No README data found!",
"repository": {
"type": "git",
"url": "git+https://github.com/strongloop/express.git"
},
"scripts": {
"test": "mocha --require test/support/env --reporter spec --bail --check-leaks test/ test/acceptance/",
"test-ci": "istanbul cover node_modules/mocha/bin/_mocha --report lcovonly -- --require test/support/env --reporter spec --check-leaks test/ test/acceptance/",
"test-cov": "istanbul cover node_modules/mocha/bin/_mocha -- --require test/support/env --reporter dot --check-leaks test/ test/acceptance/",
"test-tap": "mocha --require test/support/env --reporter tap --check-leaks test/ test/acceptance/"
},
"version": "4.13.3"
}
除了前面提到的幾個(gè)必選字段外,我們還發(fā)現(xiàn)了一些額外的字段,如bin、 scripts、engines、devDependencies、author。這里可以重點(diǎn)提及一下scripts字段。包管理器(NPM)在對(duì)包進(jìn)行安裝或者卸載的時(shí)候需要進(jìn)行一些編譯或者清除的工作,scripts字段的對(duì)象指明了在進(jìn)行操作時(shí)運(yùn)行哪個(gè)文件,或者執(zhí)行拿條命令。如下為一個(gè)較全面的scripts案例:
"scripts": {
"install": "install.js",
"uninstall": "uninstall.js",
"build": "build.js",
"doc": "make-doc.js",
"test": "test.js"
}
如果你完善了自己的JavaScript庫(kù),使之實(shí)現(xiàn)了CommonJS的包規(guī)范,那么你可以通過(guò)NPM來(lái)發(fā)布自己的包,為NPM上5000+的基礎(chǔ)上再加一個(gè)模塊。
npm publish <folder>
命令十分簡(jiǎn)單。但是在這之前你需要通過(guò)npm adduser命令在NPM上注冊(cè)一個(gè)帳戶,以便后續(xù)包的維護(hù)。NPM會(huì)分析該文件夾下的package.json文件,然后上傳目錄到NPM的站點(diǎn)上。用戶在使用你的包時(shí),也十分簡(jiǎn)明:
npm install <package>
甚至對(duì)于NPM無(wú)法安裝的包(因?yàn)槟承┢婀值木W(wǎng)絡(luò)原因),可以通過(guò)github手動(dòng)下載其穩(wěn)定版本,解壓之后通過(guò)以下命令進(jìn)行安裝:
npm install <package.json folder>
只需將路徑指向package.json存在的目錄即可。然后在代碼中require('package')即可使用。
Node.js中的require內(nèi)部流程之復(fù)雜,而方法調(diào)用之簡(jiǎn)單,實(shí)在值得嘆為觀止。更多NPM使用技巧可以參見(jiàn)http://www.infoq.com/cn/articles/msh-using-npm-manage-node.js-dependence。
2 Node.js模塊與前端模塊的異同
通常有一些模塊可以同時(shí)適用于前后端,但是在瀏覽器端通過(guò)script標(biāo)簽的載入JavaScript文件的方式與Node.js不同。
Node.js在載入到最終的執(zhí)行中,進(jìn)行了包裝,
使得每個(gè)文件中的變量天然的形成在一個(gè)閉包之中,不會(huì)污染全局變量。
瀏覽器端則通常是裸露的JavaScript代碼片段。
所以為了解決前后端一致性的問(wèn)題,類庫(kù)開(kāi)發(fā)者需要將類庫(kù)代碼包裝在一個(gè)閉包內(nèi)。以下代碼片段抽取自著名類庫(kù)underscore的定義方式。
(function () {
// Establish the root object, `window` in the browser, or `global` on the server.
var root = this;
var _ = function (obj) {
return new wrapper(obj);
};
if (typeof exports !== 'undefined') {
if (typeof module !== 'undefined' && module.exports) {
exports = module.exports = _;
}
exports._ = _;
} else if (typeof define === 'function' && define.amd) {
// Register as a named module with AMD.
define('underscore', function () {
return _;
});
} else {
root['_'] = _;
}
}).call(this);
首先,它通過(guò)function定義構(gòu)建了一個(gè)閉包,將this作為上下文對(duì)象直接call調(diào)用,以避免內(nèi)部變量污染到全局作用域。進(jìn)而通過(guò)判斷exports是否存在來(lái)決定將局部變量_綁定給exports,并且根據(jù)define變量是否存在,作為處理在實(shí)現(xiàn)了AMD規(guī)范環(huán)境(http://wiki.commonjs.org/wiki/Modules/AsynchronousDefinition)下的使用案例。僅只當(dāng)處于瀏覽器的環(huán)境中的時(shí)候,this指向的是全局對(duì)象(window對(duì)象),才將_變量賦在全局對(duì)象上,作為一個(gè)全局對(duì)象的方法導(dǎo)出,以供外部調(diào)用。
所以在設(shè)計(jì)前后端通用的JavaScript類庫(kù)時(shí),都有著以下類似的判斷:
if (typeof exports !== "undefined") {
exports.EventProxy = EventProxy;
} else {
this.EventProxy = EventProxy;
}
即,如果exports對(duì)象存在,則將局部變量掛載在exports對(duì)象上,如果不存在,則掛載在全局對(duì)象上。
轉(zhuǎn)自作者：陶邦仁
鏈接：http://www.itdecent.cn/p/3cfa31ae5631
來(lái)源：簡(jiǎn)書
著作權(quán)歸作者所有。商業(yè)轉(zhuǎn)載請(qǐng)聯(lián)系作者獲得授權(quán)，非商業(yè)轉(zhuǎn)載請(qǐng)注明出處。
