在Node.js模塊系統(tǒng)中,每個文件都被視為一個獨(dú)立的模塊
導(dǎo)出和引用模塊
比如沥曹,新建一個people.js
作為一個模塊:
編輯代碼:
exports.sayMyName = (name) => {return '我的名字是'+name};
這個js文件就是一個模塊匕争,這個模塊用exports.方法名
導(dǎo)出了sayMyname
這個函數(shù)葵擎。
在執(zhí)行代碼之前胳蛮,Node.js會先執(zhí)行一個步驟:
Node.js把模塊(每一個文件)封裝在一個函數(shù)中(模塊封裝器)
模塊封裝器
在執(zhí)行模塊(文件)代碼之前,Node.js會使用一個函數(shù)封裝器來封裝代碼
(function(exports, require, module, __filename, __dirname) { // 模塊的代碼實(shí)際上在這里 });
通過在每個模塊中添加了這樣一層的包裹慧脱,Node.js實(shí)現(xiàn)了兩>點(diǎn):
- 使模塊內(nèi)的本地變量私有化渺绒,作用在模塊范圍內(nèi),而不是>暴露為全局對象。
- 提供了一些模塊特定的變量:
- exports:對于
module.exports
的更簡短的引用形式- require:是一個函數(shù)宗兼,用于引入模塊躏鱼、
JSON
、或本地文件殷绍。- module:對當(dāng)前模塊的引用染苛,
module.exports
用于指定一個模塊所導(dǎo)出的內(nèi)容,即可以通過 require() 訪問的內(nèi)容- __filename:當(dāng)前模塊已解析的絕對路徑
- __dirname:當(dāng)前模塊的目錄名
exports是一個module.exports
的更簡短的引用形式主到,是一個對象茶行,通過在此對象上指定額外的屬性,可以將函數(shù)和對象添加到模塊的根部登钥。
在另一個模塊(文件)中引用people模塊畔师,使用require語句來引用模塊:
const people = require('./people.js')
console.log(`這位先生開始介紹自己,他說道:${people.sayMyName("Jack")}`)
注意:使用console時牧牢,使用${變量}來包裹變量茉唉,有變量時,使用``來作為輸出語句的引號结执。
運(yùn)行如下:
exports 和 module.exports
exports
和 module.exports
有什么不一樣呢?通過上述介紹艾凯,可以知道exports
其實(shí)是module.exports
的引用献幔,那么什么時候使用exports
,什么時候使用module.exports
呢?
exports
變量在模塊內(nèi)的作用域中是可用的趾诗,且在模塊執(zhí)行之前賦值給module.exports
故此蜡感,module.exports.f = ...
可以快捷地寫成exports.f = ...
,但是當(dāng)給它賦值之后恃泪,它將不再綁定到module.exports郑兴,即,當(dāng)你要使用賦值語句時贝乎,就不可再使用exports = ...
情连,而要使用module.exports = ...
module.exports.hello = true;//從模塊的引用中導(dǎo)出
exports.hello = true;//從模塊的引用中導(dǎo)出
module.exports = exports = function Contructor(){};//導(dǎo)出模塊
//module.exports被賦值時,也會重新賦值exports
exports = { hello: false }; // 不導(dǎo)出览效,僅在模塊中可用却舀。
//此時,exports 不與 module.exports綁定了锤灿。
通過require()的實(shí)現(xiàn)來說明他們之間的關(guān)系:
function require(/* ... */) {
const module = { exports: {} };
((module, exports) => {
// 模塊代碼在這挽拔。在這個例子中,定義了一個函數(shù)但校。
function someFunc() {}
exports = someFunc;
// exports被賦值了螃诅,此時,exports 不再是一個 module.exports 的快捷方式,
// 且這個模塊依然導(dǎo)出一個空的默認(rèn)對象术裸。
module.exports = someFunc;
// module.exports被賦值了倘是,此時,該模塊導(dǎo)出 someFunc穗椅,而不是默認(rèn)對象辨绊。
})(module, module.exports);
return module.exports;
}
綜上,可以知道使用exports
和module.exports
的場景:
- 當(dāng)希望模塊導(dǎo)出一個空的默認(rèn)對象匹表,以及暴露一些外部可以通過這個對象訪問的api或者變量時门坷,使用
exports
//模塊中導(dǎo)出
exports.func = ...
exports.a = ...
//外界訪問
const moduleName = require('module.js');//獲取默認(rèn)對象
moduleName.func();//訪問對象中掛載暴露的函數(shù)
console.log(moduleName.a);
- 當(dāng)希望模塊導(dǎo)出一個變量或函數(shù)時,外部直接訪問這個變量和函數(shù)袍镀,使用
module.exports
//模塊中導(dǎo)出
module.exports = function(){}
//外界訪問
const moduleName = require('module.js');//獲取默認(rèn)對象
moduleName()
想要傳參數(shù)到模塊中動態(tài)配置的方法:
使用module.exports
導(dǎo)出一個工廠函數(shù)默蚌,這個函數(shù)可以傳入?yún)?shù),在這個函數(shù)中苇羡,模塊內(nèi)就可以使用參數(shù)進(jìn)行邏輯操作绸吸,從而達(dá)到動態(tài)配置的效果,如
設(shè)置一個模塊设江,可以計算匯率,設(shè)置匯率會動態(tài)配置的參數(shù):
let rate;
function rmbToDollar(rmb){
return rmb/rate;
}
module.exports = function(r){
rate = r
return {rmbToDollar}
}
在外部動態(tài)配置匯率锦茁,結(jié)構(gòu)出我們要使用的函數(shù):
const {rmbToDollar} = require('./currency')(6)
console.log(rmbToDollar(10))
訪問主模塊
主模塊,即當(dāng)前模塊是不是直接運(yùn)行的模塊(文件)叉存。
當(dāng)Node.js直接運(yùn)行一個文件時码俩,require.main會被設(shè)置為其module,如果要判斷一個文件是不是被直接運(yùn)行歼捏,通過以下語句判斷:
require.main === module
如果是通過node xxx.js運(yùn)行稿存,為true;
如果是通過require運(yùn)行瞳秽,為false瓣履。
要獲取當(dāng)前程序的入口點(diǎn),可以通過以下代碼獲取:
require.main._filename
核心模塊
Node.js有一些模塊是核心模塊练俐,定義在lib/目錄下袖迎,require()會優(yōu)先加載核心模塊,即使有模塊與核心模塊重名痰洒,也會先加載內(nèi)置的模塊瓢棒。
require()查找目錄
require中傳入的參數(shù)有以下幾種情況
- 以 '/' 為前綴的模塊是文件的絕對路徑。 例如丘喻, require('/home/marco/foo.js') 會加載 /home/marco/foo.js 文件脯宿。
- 以 './' 為前綴的模塊是相對于調(diào)用 require() 的文件的。 也就是說泉粉, circle.js 必須和 foo.js 在同一目錄下以便于 require('./circle') 找到它连霉。
- 當(dāng)沒有以 '/'榴芳、 './' 或 '../' 開頭來表示文件時,這個模塊必須是一個核心模塊或加載自 node_modules 目錄跺撼。
*如果給定的路徑不存在窟感,則require()
會拋出一個code
屬性為'MODULE_NOT_FOUND'
的Error
。
在一個項(xiàng)目中設(shè)定入口文件時歉井,通常是在根目錄下創(chuàng)建一個package.json
文件柿祈,并定一個main
模塊,如:
{ "name" : "some-library",
"main" : "./lib/some-library.js" }
如果這是在 ./some-library 目錄中哩至,則 require('./some-library') 會試圖加載 ./some-library/lib/some-library.js躏嚎。
如果目錄中沒有package.json
文件,則Node.js會試圖加載目錄中的index.js或者index.node菩貌。
詳解module對象
每個模塊中都有一個module對象卢佣,表示當(dāng)前模塊的對象的引用。里面有一些關(guān)于本模塊(文件)的信息箭阶。module對象是每個模塊本地的虚茶。
在文件中輸出module:
console.log(module)
可以得到如下結(jié)果:
組成解析:
- id:<string>模塊的標(biāo)識符,通常是完全解析后的文件名
- exports:<Object>對象仇参,可用于導(dǎo)出變量或函數(shù)等
- parent:* <Object>模塊對象嘹叫,最先應(yīng)用該模塊的模塊
- filename:<string>完全解析后的文件名
- loaded:<boolean>模塊是否加載完成,或者正在加載中
- children:<Array>被該模塊引用的模塊對象數(shù)組
- paths:<string[]>模塊的搜索路徑诈乒,是一個數(shù)組
- require(id):返回已解析的模塊的module.exports
npm
npm是Node.js的包管理器待笑,通常在安裝Node.js的時候一起安裝了。
查看npm的版本
npm -v