前端技術探秘-Nodejs的CommonJS規範實現原理

来源:https://www.cnblogs.com/Jcloud/archive/2023/11/24/17853282.html
-Advertisement-
Play Games

Node.js是一個基於ChromeV8引擎的JavaScript運行環境,使用了一個事件驅動、非阻塞式I/O模型,讓JavaScript 運行在服務端的開發平臺,它讓JavaScript成為與PHP、Python、Perl、Ruby等服務端語言平起平坐的腳本語言。Node中增添了很多內置的模塊,提... ...


瞭解Node.js

Node.js是一個基於ChromeV8引擎的JavaScript運行環境,使用了一個事件驅動、非阻塞式I/O模型,讓JavaScript 運行在服務端的開發平臺,它讓JavaScript成為與PHP、Python、Perl、Ruby等服務端語言平起平坐的腳本語言。Node中增添了很多內置的模塊,提供各種各樣的功能,同時也提供許多第三方模塊。

模塊的問題

為什麼要有模塊

複雜的前端項目需要做分層處理,按照功能、業務、組件拆分成模塊, 模塊化的項目至少有以下優點:

  1. 便於單元測試
  2. 便於同事間協作
  3. 抽離公共方法, 開發快捷
  4. 按需載入, 性能優秀
  5. 高內聚低耦合
  6. 防止變數衝突
  7. 方便代碼項目維護

幾種模塊化規範

  • CMD(SeaJS 實現了 CMD)
  • AMD(RequireJS 實現了 AMD)
  • UMD(同時支持 AMD 和 CMD)
  • IIFE (自執行函數)
  • CommonJS (Node 採用了 CommonJS)
  • ES Module 規範 (JS 官方的模塊化方案)

Node中的模塊

Node中採用了 CommonJS 規範

實現原理:

Node中會讀取文件,拿到內容實現模塊化, Require方法 同步引用

tips:Node中任何js文件都是一個模塊,每一個文件都是模塊

Node中模塊類型

  1. 內置模塊,屬於核心模塊,無需安裝,在項目中不需要相對路徑引用, Node自身提供。
  2. 文件模塊,程式員自己書寫的js文件模塊。
  3. 第三方模塊, 需要安裝, 安裝之後不用加路徑。

Node中內置模塊

fs filesystem

操作文件都需要用到這個模塊

const path = require('path'); // 處理路徑
const fs = require('fs'); // file system
// // 同步讀取
let content = fs.readFileSync(path.resolve(__dirname, 'test.js'), 'utf8');
console.log(content);

let exists = fs.existsSync(path.resolve(__dirname, 'test1.js'));
console.log(exists);


path 路徑處理

const path = require('path'); // 處理路徑


// join / resolve 用的時候可以混用

console.log(path.join('a', 'b', 'c', '..', '/'))

// 根據已經有的路徑來解析絕對路徑, 可以用他來解析配置文件
console.log(path.resolve('a', 'b', '/')); // resolve 不支持/ 會解析成根路徑

console.log(path.join(__dirname, 'a'))
console.log(path.extname('1.js'))
console.log(path.dirname(__dirname)); // 解析父目錄


vm 運行代碼

字元串如何能變成 JS 執行呢?

1.eval

eval中的代碼執行時的作用域為當前作用域。它可以訪問到函數中的局部變數。

let test = 'global scope'
global.test1 = '123'
function b(){
  test = 'fn scope'
  eval('console.log(test)'); //local scope
  new Function('console.log(test1)')() // 123
  new Function('console.log(test)')() //global scope
}
b()


2.new Function

new Function()創建函數時,不是引用當前的詞法環境,而是引用全局環境,Function中的表達式使用的變數要麼是傳入的參數要麼是全局的值

Function可以獲取全局變數,所以它還是可能會有變數污染的情況出現

function getFn() {
  let value = "test"
  let fn = new Function('console.log(value)')
  return fn
}

getFn()()

global.a = 100 // 掛在到全局對象global上
new Function("console.log(a)")() // 100


3.vm

前面兩種方式,我們一直強調一個概念,那就是變數的污染

VM的特點就是不受環境的影響,也可以說他就是一個沙箱環境

在Node中全局變數是在多個模塊下共用的,所以儘量不要在global中定義屬性

所以,vm.runInThisContext可以訪問到global上的全局變數,但是訪問不到自定義的變數。而vm.runInNewContext訪問不到global,也訪問不到自定義變數,他存在於一個全新的執行上下文

const vm = require('vm')
global.a = 1
// vm.runInThisContext("console.log(a)")
vm.runInThisContext("a = 100") // 沙箱,獨立的環境
console.log(a) // 1
vm.runInNewContext('console.log(a)')
console.log(a) // a is not defined


Node模塊化的實現

node中是自帶模塊化機制的,每個文件就是一個單獨的模塊,並且它遵循的是CommonJS規範,也就是使用require的方式導入模塊,通過module.export的方式導出模塊。

node模塊的運行機制也很簡單,其實就是在每一個模塊外層包裹了一層函數,有了函數的包裹就可以實現代碼間的作用域隔離。

我們先在一個js文件中直接列印arguments,得到的結果如下圖所示,我們先記住這些參數。

console.log(arguments) // exports, require, module, __filename, __dirname

Node中通過modules.export 導出,require 引入。其中require依賴node中的fs模塊來載入模塊文件,通過fs.readFile讀取到的是一個字元串。

在javascrpt中可以通過eval或者new Function的方式來將一個字元串轉換成js代碼來運行。但是前面提到過,他們都有一個致命的問題,就是變數的污染

實現require模塊載入器

首先導入依賴的模塊path,fs,vm, 並且創建一個Require函數,這個函數接收一個modulePath參數,表示要導入的文件路徑

const path = require('path');
const fs = require('fs');
const vm = require('vm');
// 定義導入類,參數為模塊路徑
function Require(modulePath) {
   ...
}


在Require中獲取到模塊的絕對路徑,使用fs載入模塊,這裡讀取模塊內容使用new Module來抽象,使用tryModuleLoad來載入模塊內容,Module和tryModuleLoad稍後實現,Require的返回值應該是模塊的內容,也就是module.exports。

// 定義導入類,參數為模塊路徑
function Require(modulePath) {
    // 獲取當前要載入的絕對路徑
    let absPathname = path.resolve(__dirname, modulePath);
    // 創建模塊,新建Module實例
    const module = new Module(absPathname);
    // 載入當前模塊
    tryModuleLoad(module);
    // 返回exports對象
    return module.exports;
}


Module的實現就是給模塊創建一個exports對象,tryModuleLoad執行的時候將內容加入到exports中,id就是模塊的絕對路徑。

// 定義模塊, 添加文件id標識和exports屬性
function Module(id) {
    this.id = id;
    // 讀取到的文件內容會放在exports中
    this.exports = {};
}


node模塊是運行在一個函數中,這裡給Module掛載靜態屬性wrapper,裡面定義一下這個函數的字元串,wrapper是一個數組,數組的第一個元素就是函數的參數部分,其中有exports,module,Require,__dirname,__filename, 都是模塊中常用的全局變數.

第二個參數就是函數的結束部分。兩部分都是字元串,使用的時候將他們包裹在模塊的字元串外部就可以了。

// 定義包裹模塊內容的函數
Module.wrapper = [
    "(function(exports, module, Require, __dirname, __filename) {",
    "})"
]


_extensions用於針對不同的模塊擴展名使用不同的載入方式,比如JSON和javascript載入方式肯定是不同的。JSON使用JSON.parse來運行。

javascript使用vm.runInThisContext來運行,可以看到fs.readFileSync傳入的是module.id也就是Module定義時候id存儲的是模塊的絕對路徑,讀取到的content是一個字元串,使用Module.wrapper來包裹一下就相當於在這個模塊外部又包裹了一個函數,也就實現了私有作用域。

使用call來執行fn函數,第一個參數改變運行的this傳入module.exports,後面的參數就是函數外麵包裹參數exports, module, Require, __dirname, __filename。/

// 定義擴展名,不同的擴展名,載入方式不同,實現js和json
Module._extensions = {
    '.js'(module) {
        const content = fs.readFileSync(module.id, 'utf8');
        const fnStr = Module.wrapper[0] + content + Module.wrapper[1];
        const fn = vm.runInThisContext(fnStr);
        fn.call(module.exports, module.exports, module, Require,__filename,__dirname);
    },
    '.json'(module) {
        const json = fs.readFileSync(module.id, 'utf8');
        module.exports = JSON.parse(json); // 把文件的結果放在exports屬性上
    }
}


tryModuleLoad函數接收的是模塊對象,通過path.extname來獲取模塊的尾碼名,然後使用Module._extensions來載入模塊。

// 定義模塊載入方法
function tryModuleLoad(module) {
    // 獲取擴展名
    const extension = path.extname(module.id);
    // 通過尾碼載入當前模塊
    Module._extensions[extension](module); // 策略模式???
}


到此Require載入機制基本就寫完了。Require載入模塊的時候傳入模塊名稱,在Require方法中使用path.resolve(__dirname, modulePath)獲取到文件的絕對路徑。然後通過new Module實例化的方式創建module對象,將模塊的絕對路徑存儲在module的id屬性中,在module中創建exports屬性為一個json對象。

使用tryModuleLoad方法去載入模塊,tryModuleLoad中使用path.extname獲取到文件的擴展名,然後根據擴展名來執行對應的模塊載入機制。

最終將載入到的模塊掛載module.exports中。tryModuleLoad執行完畢之後module.exports已經存在了,直接返回就可以了。

接下來,我們給模塊添加緩存。就是文件載入的時候將文件放入緩存中,再去載入模塊時先看緩存中是否存在,如果存在直接使用,如果不存在再去重新載入,載入之後再放入緩存。

// 定義導入類,參數為模塊路徑
function Require(modulePath) {
  // 獲取當前要載入的絕對路徑
  let absPathname = path.resolve(__dirname, modulePath);
  // 從緩存中讀取,如果存在,直接返回結果
  if (Module._cache[absPathname]) {
      return Module._cache[absPathname].exports;
  }
  // 創建模塊,新建Module實例
  const module = new Module(absPathname);
  // 添加緩存
  Module._cache[absPathname] = module;
  // 載入當前模塊
  tryModuleLoad(module);
  // 返回exports對象
  return module.exports;
}


增加功能:省略模塊尾碼名。

自動給模塊添加尾碼名,實現省略尾碼名載入模塊,其實也就是如果文件沒有尾碼名的時候遍歷一下所有的尾碼名看一下文件是否存在。

// 定義導入類,參數為模塊路徑
function Require(modulePath) {
  // 獲取當前要載入的絕對路徑
  let absPathname = path.resolve(__dirname, modulePath);
  // 獲取所有尾碼名
  const extNames = Object.keys(Module._extensions);
  let index = 0;

  // 存儲原始文件路徑
  const oldPath = absPathname;
  function findExt(absPathname) {
      if (index === extNames.length) {
         return throw new Error('文件不存在');
      }
      try {
          fs.accessSync(absPathname);
          return absPathname;
      } catch(e) {
          const ext = extNames[index++];
          findExt(oldPath + ext);
      }
  }
  
  // 遞歸追加尾碼名,判斷文件是否存在
  absPathname = findExt(absPathname);
  // 從緩存中讀取,如果存在,直接返回結果
  if (Module._cache[absPathname]) {
      return Module._cache[absPathname].exports;
  }
  // 創建模塊,新建Module實例
  const module = new Module(absPathname);
  // 添加緩存
  Module._cache[absPathname] = module;
  // 載入當前模塊
  tryModuleLoad(module);
  // 返回exports對象
  return module.exports;
}


源代碼調試

我們可以通過VSCode 調試Node.js

步驟

創建文件a.js

module.exports = 'abc'


1.文件test.js

let r = require('./a')

console.log(r)


1.配置debug,本質是配置.vscode/launch.json文件,而這個文件的本質是能提供多個啟動命令入口選擇。

一些常見參數如下:

  • program控制啟動文件的路徑(即入口文件)
  • name下拉菜單中顯示的名稱(該命令對應的入口名稱)
  • request分為 launch(啟動)和 attach(附加)(進程已經啟動)
  • skipFiles指定單步調試跳過的代碼
  • runtimeExecutable設置運行時可執行文件,預設是 node,可以設置成 nodemon,ts-node,npm 等

修改launch.json,skipFiles指定單步調試跳過的代碼

  1. 將test.js 文件中的require方法所在行前面打斷點
  2. 執行調試,進入源碼相關入口方法

梳理代碼步驟

1.首先進入到進入到require方法:Module.prototype.require

2.調試到Module._load 方法中,該方法返回module.exports,Module._resolveFilename方法返回處理之後的文件地址,將文件改為絕對地址,同時如果文件沒有尾碼就加上文件尾碼。

3.這裡定義了Module類。id為文件名。此類中定義了exports屬性

4.接著調試到module.load 方法,該方法中使用了策略模式,Module._extensions[extension](this, filename)根據傳入的文件尾碼名不同調用不同的方法

5.進入到該方法中,看到了核心代碼,讀取傳入的文件地址參數,拿到該文件中的字元串內容,執行module._compile

6.此方法中執行wrapSafe方法。將字元串前後添加函數前尾碼,並用Node中的vm模塊中的runInthisContext方法執行字元串,便直接執行到了傳入文件中的console.log代碼行內容。

至此,整個Node中實現require方法的整個流程代碼已經調試完畢,通過對源代碼的調試,可以幫助我們學習其實現思路,代碼風格及規範,有助於幫助我們實現工具庫,提升我們的代碼思路,同時我們知道相關原理,也對我們解決日常開發工作中遇到的問題提供幫助。

作者:京東物流 喬盼盼

來源:京東雲開發者社區 自猿其說Tech 轉載請註明來源


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 遇到的問題: 問題一:ERROR 1449 (HY000): The user specified as a definer ('mysql.infoschema'@'localhost') does not exist 異常原因:未知 解決辦法: 驗證指定的用戶('mysql.infoschema ...
  • 1. SSMS 方式 在資料庫中選擇“編輯前200行”選項,然後就可以手動直接輸入數據到表行中了。 手動輸入的數據是確定的,而且只能一點點輸入,遇到大量的數據的時候,操作會變得很繁重,而且它不滿足大多數業務的需求,而且不利於更新。 在對象資源管理器中,右鍵點擊你要打開的表,然後選擇 “Edit To ...
  • 企業業務一直依賴於其收集的數據,但這些數據集正在不斷增長。即使需要提取的數據存儲量非常龐大,Redis Enterprise 7.2也能使應用程式能以最快的速度檢索和處理數據。利用自動分層技術,可以識別冷數據和熱數據,並分別存儲在記憶體和固態硬碟上,顯著提升了系統響應速度,優化記憶體占用的同時降低硬體成... ...
  • 本文是對這篇文章MySQL InnoDB Cluster - Navigating the Cluster[1]的翻譯,翻譯如有不當的地方,敬請諒解,請尊重原創和翻譯勞動成果,轉載的時候請註明出處。謝謝! 當我們管理InnoDB Cluster時,一件非常重要的事情就是瞭解集群處於什麼樣的狀態,特別 ...
  • 副本集概述 副本集(Replica Set)是一組帶有故障轉移的 MongoDB 實例組成的集群,由一個主(Primary)伺服器和多個從(Secondary)伺服器構成。通過Replication,將數據的更新由Primary推送到其他實例上,在一定的延遲之後,每個MongoDB實例維護相同的數據 ...
  • 最近接觸到了一個問題:耳機插入事件的由來,走讀了下IMS輸入系統服務的源碼。同時,IMS輸入系統服務在Android的開發過程中,也經常出現,有必要瞭解下相關原理。 ...
  • 這裡給大家分享我在網上總結出來的一些知識,希望對大家有所幫助 最近喜歡研究起了手錶,對勞力士這款“百事圈”實在是心水的不行啊! 心癢難耐無奈錢包不支持,作為一個前端程式員,買不起的東西該怎麼辦? 當然是自己做一個啊! 說乾就乾,熬夜自己做了個“百事圈”出來!源碼在最後! 先看成品 還是有那麼六七成相 ...
  • 沒有什麼是不可能的,只是需要找到正確的方法。 1. 什麼是狀態? 狀態就是組件內部特有數據的載體(組件數據掛載方式),改變數據頁面就會刷新,由組件自己設置和更改,也就是說由組件自己產生、維護,使用狀態的目的就是為了在不同的狀態下使組件的顯示不同(自己管理),這在 React 中稱為:條件渲染。 為什 ...
一周排行
    -Advertisement-
    Play Games
  • 示例項目結構 在 Visual Studio 中創建一個 WinForms 應用程式後,項目結構如下所示: MyWinFormsApp/ │ ├───Properties/ │ └───Settings.settings │ ├───bin/ │ ├───Debug/ │ └───Release/ ...
  • [STAThread] 特性用於需要與 COM 組件交互的應用程式,尤其是依賴單線程模型(如 Windows Forms 應用程式)的組件。在 STA 模式下,線程擁有自己的消息迴圈,這對於處理用戶界面和某些 COM 組件是必要的。 [STAThread] static void Main(stri ...
  • 在WinForm中使用全局異常捕獲處理 在WinForm應用程式中,全局異常捕獲是確保程式穩定性的關鍵。通過在Program類的Main方法中設置全局異常處理,可以有效地捕獲並處理未預見的異常,從而避免程式崩潰。 註冊全局異常事件 [STAThread] static void Main() { / ...
  • 前言 給大家推薦一款開源的 Winform 控制項庫,可以幫助我們開發更加美觀、漂亮的 WinForm 界面。 項目介紹 SunnyUI.NET 是一個基於 .NET Framework 4.0+、.NET 6、.NET 7 和 .NET 8 的 WinForm 開源控制項庫,同時也提供了工具類庫、擴展 ...
  • 說明 該文章是屬於OverallAuth2.0系列文章,每周更新一篇該系列文章(從0到1完成系統開發)。 該系統文章,我會儘量說的非常詳細,做到不管新手、老手都能看懂。 說明:OverallAuth2.0 是一個簡單、易懂、功能強大的許可權+可視化流程管理系統。 有興趣的朋友,請關註我吧(*^▽^*) ...
  • 一、下載安裝 1.下載git 必須先下載並安裝git,再TortoiseGit下載安裝 git安裝參考教程:https://blog.csdn.net/mukes/article/details/115693833 2.TortoiseGit下載與安裝 TortoiseGit,Git客戶端,32/6 ...
  • 前言 在項目開發過程中,理解數據結構和演算法如同掌握蓋房子的秘訣。演算法不僅能幫助我們編寫高效、優質的代碼,還能解決項目中遇到的各種難題。 給大家推薦一個支持C#的開源免費、新手友好的數據結構與演算法入門教程:Hello演算法。 項目介紹 《Hello Algo》是一本開源免費、新手友好的數據結構與演算法入門 ...
  • 1.生成單個Proto.bat內容 @rem Copyright 2016, Google Inc. @rem All rights reserved. @rem @rem Redistribution and use in source and binary forms, with or with ...
  • 一:背景 1. 講故事 前段時間有位朋友找到我,說他的窗體程式在客戶這邊出現了卡死,讓我幫忙看下怎麼回事?dump也生成了,既然有dump了那就上 windbg 分析吧。 二:WinDbg 分析 1. 為什麼會卡死 窗體程式的卡死,入口門檻很低,後續往下分析就不一定了,不管怎麼說先用 !clrsta ...
  • 前言 人工智慧時代,人臉識別技術已成為安全驗證、身份識別和用戶交互的關鍵工具。 給大家推薦一款.NET 開源提供了強大的人臉識別 API,工具不僅易於集成,還具備高效處理能力。 本文將介紹一款如何利用這些API,為我們的項目添加智能識別的亮點。 項目介紹 GitHub 上擁有 1.2k 星標的 C# ...