詳細分析Node.js 模塊系統(tǒng)
為了讓Node.js的文件可以相互調(diào)用,Node.js提供了一個簡單的模塊系統(tǒng)。
模塊是Node.js 應(yīng)用程序的基本組成部分,文件和模塊是一一對應(yīng)的。換言之,一個 Node.js 文件就是一個模塊,這個文件可能是JavaScript 代碼、JSON 或者編譯過的C/C++ 擴展。
創(chuàng)建模塊
在 Node.js 中,創(chuàng)建一個模塊非常簡單,如下我們創(chuàng)建一個 main.js 文件,代碼如下:
var hello = require('./hello'); hello.world();
以上實例中,代碼 require('./hello') 引入了當(dāng)前目錄下的 hello.js 文件(./ 為當(dāng)前目錄,node.js 默認后綴為 js)。
Node.js 提供了 exports 和 require 兩個對象,其中 exports 是模塊公開的接口,require 用于從外部獲取一個模塊的接口,即所獲取模塊的 exports 對象。
接下來我們就來創(chuàng)建 hello.js 文件,代碼如下:
exports.world = function() { console.log('Hello World'); }
在以上示例中,hello.js 通過 exports 對象把 world 作為模塊的訪問接口,在 main.js 中通過 require('./hello') 加載這個模塊,然后就可以直接訪 問 hello.js 中 exports 對象的成員函數(shù)了。
有時候我們只是想把一個對象封裝到模塊中,格式如下:
module.exports = function() { // ... }
例如:
//hello.js function Hello() { var name; this.setName = function(thyName) { name = thyName; }; this.sayHello = function() { console.log('Hello ' + name); }; }; module.exports = Hello;
這樣就可以直接獲得這個對象了:
//main.js var Hello = require('./hello'); hello = new Hello(); hello.setName('BYVoid'); hello.sayHello();
模塊接口的唯一變化是使用 module.exports = Hello 代替了exports.world = function(){}。 在外部引用該模塊時,其接口對象就是要輸出的 Hello 對象本身,而不是原先的 exports。
服務(wù)端的模塊放在哪里
也許你已經(jīng)注意到,我們已經(jīng)在代碼中使用了模塊了。像這樣:
var http = require("http"); ... http.createServer(...);
Node.js 中自帶了一個叫做 http 的模塊,我們在我們的代碼中請求它并把返回值賦給一個本地變量。
這把我們的本地變量變成了一個擁有所有 http 模塊所提供的公共方法的對象。
Node.js 的 require 方法中的文件查找策略如下:
由于 Node.js 中存在 4 類模塊(原生模塊和3種文件模塊),盡管 require 方法極其簡單,但是內(nèi)部的加載卻是十分復(fù)雜的,其加載優(yōu)先級也各自不同。如下圖所示:
從文件模塊緩存中加載
盡管原生模塊與文件模塊的優(yōu)先級不同,但是都會優(yōu)先從文件模塊的緩存中加載已經(jīng)存在的模塊。
從原生模塊加載
原生模塊的優(yōu)先級僅次于文件模塊緩存的優(yōu)先級。require 方法在解析文件名之后,優(yōu)先檢查模塊是否在原生模塊列表中。以http模塊為例,盡管在目錄下存在一個 http/http.js/http.node/http.json 文件,require("http") 都不會從這些文件中加載,而是從原生模塊中加載。
原生模塊也有一個緩存區(qū),同樣也是優(yōu)先從緩存區(qū)加載。如果緩存區(qū)沒有被加載過,則調(diào)用原生模塊的加載方式進行加載和執(zhí)行。
從文件加載
當(dāng)文件模塊緩存中不存在,而且不是原生模塊的時候,Node.js 會解析 require 方法傳入的參數(shù),并從文件系統(tǒng)中加載實際的文件,加載過程中的包裝和編譯細節(jié)在前一節(jié)中已經(jīng)介紹過,這里我們將詳細描述查找文件模塊的過程,其中,也有一些細節(jié)值得知曉。
require方法接受以下幾種參數(shù)的傳遞:
- http、fs、path等,原生模塊。
- ./mod或../mod,相對路徑的文件模塊。
- /pathtomodule/mod,絕對路徑的文件模塊。
- mod,非原生模塊的文件模塊。
在路徑 Y 下執(zhí)行 require(X) 語句執(zhí)行順序:
1. 如果 X 是內(nèi)置模塊
a. 返回內(nèi)置模塊
b. 停止執(zhí)行
2. 如果 X 以 '/' 開頭
a. 設(shè)置 Y 為文件根路徑
3. 如果 X 以 './' 或 '/' or '../' 開頭
a. LOAD_AS_FILE(Y + X)
b. LOAD_AS_DIRECTORY(Y + X)
4. LOAD_NODE_MODULES(X, dirname(Y))
5. 拋出異常 "not found"
LOAD_AS_FILE(X)
1. 如果 X 是一個文件, 將 X 作為 JavaScript 文本載入并停止執(zhí)行。
2. 如果 X.js 是一個文件, 將 X.js 作為 JavaScript 文本載入并停止執(zhí)行。
3. 如果 X.json 是一個文件, 解析 X.json 為 JavaScript 對象并停止執(zhí)行。
4. 如果 X.node 是一個文件, 將 X.node 作為二進制插件載入并停止執(zhí)行。
LOAD_INDEX(X)
1. 如果 X/index.js 是一個文件, 將 X/index.js 作為 JavaScript 文本載入并停止執(zhí)行。
2. 如果 X/index.json 是一個文件, 解析 X/index.json 為 JavaScript 對象并停止執(zhí)行。
3. 如果 X/index.node 是一個文件, 將 X/index.node 作為二進制插件載入并停止執(zhí)行。
LOAD_AS_DIRECTORY(X)
1. 如果 X/package.json 是一個文件,
a. 解析 X/package.json, 并查找 "main" 字段。
b. let M = X + (json main 字段)
c. LOAD_AS_FILE(M)
d. LOAD_INDEX(M)
2. LOAD_INDEX(X)
LOAD_NODE_MODULES(X, START)
1. let DIRS=NODE_MODULES_PATHS(START)
2. for each DIR in DIRS:
a. LOAD_AS_FILE(DIR/X)
b. LOAD_AS_DIRECTORY(DIR/X)
NODE_MODULES_PATHS(START)
1. let PARTS = path split(START)
2. let I = count of PARTS - 1
3. let DIRS = []
4. while I >= 0,
a. if PARTS[I] = "node_modules" CONTINUE
b. DIR = path join(PARTS[0 .. I] + "node_modules")
c. DIRS = DIRS + DIR
d. let I = I - 1
5. return DIRS
以上就是詳細分析Node.js 模塊系統(tǒng)的詳細內(nèi)容,更多關(guān)于Node.js模塊系統(tǒng)的資料請關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
使用?Node-RED對?MQTT?數(shù)據(jù)流處理
本文將介紹使用 Node-RED 連接到 MQTT 服務(wù)器,并對 MQTT 數(shù)據(jù)進行過濾和處理后再將其發(fā)送至 MQTT 服務(wù)器的完整操作流程。讀者可以快速了解如何使用 Node-RED 對 MQTT 數(shù)據(jù)進行簡單的流處理2022-05-05Node.js創(chuàng)建子進程的幾種實現(xiàn)方式
這篇文章主要介紹了Node.js創(chuàng)建子進程的幾種實現(xiàn)方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2023-10-10快速搭建Node.js(Express)用戶注冊、登錄以及授權(quán)的方法
這篇文章主要介紹了快速搭建Node.js(Express)用戶注冊、登錄以及授權(quán),小編覺得挺不錯的,現(xiàn)在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2019-05-05node.js支持多用戶web終端實現(xiàn)及安全方案
這篇文章主要介紹了node.js支持多用戶web終端實現(xiàn)方案以及web終端安全性保證的解決方法,一起學(xué)習(xí)參考下。2017-11-11使用node.js半年來總結(jié)的 10 條經(jīng)驗
從3月初來到帝都某創(chuàng)業(yè)公司的服務(wù)器團隊實習(xí),到現(xiàn)在已接近半年的時間。PS: 已轉(zhuǎn)正,服務(wù)器端用的 Node。2014-08-08基于NodeJS的前后端分離的思考與實踐(三)輕量級的接口配置建??蚣?/a>
Node在整個環(huán)境中最重要的工作之一就是代理這些業(yè)務(wù)接口,以方便前端(Node端和瀏覽器端)整合數(shù)據(jù)做頁面渲染。如何做好代理工作,使得前后端開發(fā)分離之后,仍然可以在流程上無縫銜接,是我們需要考慮的問題。本文將就該問題做相關(guān)探討,并提出解決方案。2014-09-09Nodejs Post請求報socket hang up錯誤的解決辦法
這篇文章主要介紹了Nodejs Post請求報socket hang up錯誤的解決辦法,本文因少加了headers字段信息導(dǎo)致出現(xiàn)這個錯誤,本文給出了一個完整的實現(xiàn)代碼,需要的朋友可以參考下2014-09-09