Nodejs中的require函式

吳宇楓發表於2019-03-30
NodeJSUI函式

說明

本文參考Node官網文件版本為v11.12.0。
本文主要分析了Nodejs中require匯入JSON和js檔案時得到的結果，同時簡單涉及到了Nodejs中模組匯出module.exports和exports的用法。

引言

在閱讀webpack原始碼的過程當中，見到如下一行程式碼：

const version = require("../package.json").version
複製程式碼

故引申出對Nodejs中require的學習。

require介紹

在Node.js的文件中，require的相關文件是在Modules目錄下，屬於Nodejs模組化系統的一部分。
require是一個函式。通過typeof或者Object.prototype.toString.call()可以驗證這個結論：

console.log(require) // 輸出：Function
console.log(Object.prototype.toString.call(require) // 輸出：[object Function]
複製程式碼

通過直接列印require，可以發現在require函式下還掛載著若干個靜態屬性，這些靜態屬性也可以在Nodejs的官方文件中直接找到相關的說明：

{ [Function: require]
  resolve: { [Function: resolve] paths: [Function: paths] },
  main:
   Module {
     id: '.',
     exports: {},
     parent: null,
     filename: '/Users/bjhl/Documents/webpackSource/index.js',
     loaded: false,
     children: [],
     paths:
      [ '/Users/bjhl/Documents/webpackSource/node_modules',
        '/Users/bjhl/Documents/node_modules',
        '/Users/bjhl/node_modules',
        '/Users/node_modules',
        '/node_modules' ] },
  extensions:
   [Object: null prototype] { '.js': [Function], '.json': [Function], '.node': [Function] },
  cache:
   [Object: null prototype] {
     '/Users/bjhl/Documents/webpackSource/index.js':
      Module {
        id: '.',
        exports: {},
        parent: null,
        filename: '/Users/bjhl/Documents/webpackSource/index.js',
        loaded: false,
        children: [],
        paths: [Array] } } }
複製程式碼

require函式靜態屬性

這裡之後再詳細補充。

require使用

在官網文件中可以看到如下關於require的說明：

require(id)#
Added in: v0.1.13
id module name or path
Returns: exported module content
Used to import modules, JSON, and local files. Modules can be imported from node_modules. Local modules and JSON files can be imported using a relative path (e.g. ./, ./foo, ./bar/baz, ../foo) that will be resolved against the directory named by __dirname (if defined) or the current working directory.

同時還給出了三種require的使用方法：

// Importing a local module:
const myLocalModule = require('./path/myLocalModule');

// Importing a JSON file:
const jsonData = require('./path/filename.json');

// Importing a module from node_modules or Node.js built-in module:
const crypto = require('crypto');
複製程式碼

從以上文件中可以得出以下資訊：

  1. require接受一個引數，形參名為id，型別是String。
  2. require函式return的是模組到處的內容，型別是任意。
  3. require函式可以匯入模組、JSON檔案、本地檔案。模組可以通過一個相對路徑從node_modules、本地模組、JSON檔案中匯出，該路徑將針對__dirname變數（如果已定義）或者當前工作目錄。

require實踐

在這裡將分類討論require的實踐結論。

require匯入JSON

JSON 是一種語法，用來序列化物件、陣列、數值、字串、布林值和 null 。
在文章的開頭就提到了通過require("./package.json")檔案來讀取package.json檔案中的version屬性。這裡將嘗試匯入info.json檔案並檢視相關資訊。
檔案結構目錄如下：

.
├── index.js
└── info.json
複製程式碼

將info.json檔案的內容修改為:

{
    "name": "myInfo",
    "hasFriend": true,
    "salary": null,
    "version": "v1.0.0",
    "author": {
        "nickname": "Hello Kitty",
        "age": 20,
        "friends": [
            {
                "nickname": "snowy",
                "age": 999
            }
        ]
    }
}
複製程式碼

在info.json當中，包含了字串、布林值、null、數字、物件和陣列。
將index.js的內容修改如下並在當前terminal執行命令node index.js，得到如下結果：

const info = require("./info.json")
console.log(Object.prototype.toString.call(info)) // [object Object]
console.log(info.version) // v1.0.0
console.log(info.hasFriend) // true
console.log(info.salary) // null
console.log(info.author.nickname) // Hello Kitty
console.log(info.author.friends) // [ { nickname: 'snowy', age: 999 } ]
複製程式碼

可以看到，require匯入一個JSON檔案的時候，返回了一個物件，Nodejs可以直接訪問這個物件裡的所有屬性，包括String、Boolean、Number、Null、Object、Array。個人猜測這裡可能用到了類似於JSON.parse()的方法。
通過這個結論也得出了一種思路，即通過require方法傳入JSON檔案來讀取某些值，如在文章開頭中，webpack通過讀取package.json檔案獲取到了version值。

require匯入本地js檔案

檔案結構目錄如下：

.
├── index.js
├── module_a.js
└── module_b.js
複製程式碼

index.js檔案中，分別按順序匯入了module_a和module_b並賦值，然後將這兩個變數列印，內容如下：

console.log("*** index.js開始執行 ***")
const module_a = require("./module_a")
const module_b = require("./module_b")
console.log(module_a, "*** 列印module_a ***")
console.log(module_b, "*** 列印module_b ***")
console.log("*** index.js結束執行 ***")
複製程式碼

module_a檔案中，未指定module.exports或者exports，但是新增了一個非同步執行語句setTimeout，內容如下：

console.log("** module_a開始執行 **")
let name = "I'm module_a"
setTimeout(() => {
    console.log(name, "** setTimeout列印a的名字 **")
}, 0)
console.log("** module_a結束執行 **")
複製程式碼

module_b檔案中，指定了module.exports（也可以換成exports.name，但是不能直接使用exports等於某個物件，因為exports和module.exports其實是指向了一個地址，引用了相同的物件，如果使用exports等於其他的引用型別，則不再指向module.exports，無法改變module.exports裡的內容），內容如下：

console.log("** module_b開始執行 **")
let name = "I'm module_b"
console.log(name, "** 列印b的名字 **")
module.exports = {
    name
}
console.log("** module_b結束執行 **")
複製程式碼

在當前目錄terminal下執行node index.js執行得到如下輸出：

*** index.js開始執行 ***
** module_a開始執行 **
** module_a結束執行 **
** module_b開始執行 **
I am module_b ** 列印b的名字 **
** module_b結束執行 **
{} '*** 列印module_a ***'
{ name: 'I am module_b' } '*** 列印module_b ***'
*** index.js結束執行 ***
I am module_a ** setTimeout列印a的名字 **
複製程式碼

通過以上執行結果可以得出結論：

  1. require某個js檔案時，如果未通過exports或者module.exports指定匯出內容，則require返回的結果是一個空物件；反之可以通過module.export或者給exports屬性賦值來匯出指定內容。
  2. require某個js檔案時，該檔案會立即sync執行。

require匯入模組

我們先選擇一個npm包——cors。 進入資料夾，執行一下命令：

npm init -y // 初始化
echo -e "let cors = require(\"cors\")\nconsole.log(cors)" > index.js // 生成index.js檔案
npm install cors --save // 安裝cors包
複製程式碼

檔案結構如下(...處省略了其他的模組):

.
├── index.js
├── node_modules
│   ├── cors
│   │   ├── CONTRIBUTING.md
│   │   ├── HISTORY.md
│   │   ├── LICENSE
│   │   ├── README.md
│   │   ├── lib
│   │   │   └── index.js
│   │   └── package.json
│   │   ...
├── package-lock.json
└── package.json
複製程式碼

index.js中的內容如下：

let cors = require("cors")
console.log(cors)
複製程式碼

執行node index.js，得出以下結果：

[Function: middlewareWrapper]
複製程式碼

找到node_modules下的cors模組資料夾，觀察cros模組中的package.json檔案，找到main欄位："main": "./lib/index.js"，找到main欄位指向的檔案，發現這是一個IIFE，在IIFE中的程式碼中新增，console.log("hello cors")，模擬程式碼結構如下：

(function () {
    'use strict';
    console.log("hello cors"); // 這是手動新增的程式碼
    ...
    function middlewareWrapper(o) {
        ...
    }
    module.exports = middlewareWrapper;
})()
複製程式碼

再次執行node index.js，得出以下結果：

hello cors
[Function: middlewareWrapper]
複製程式碼

為什麼會列印出hello cors呢？因為require模組的時候，引入的是該模組package.json檔案中main欄位指向的檔案。而這個js檔案會自動執行，跟require引用本地js檔案是相同的。

packjson文件

在npm的官方網站中可以找到關於package.json中的main欄位定義。

main
The main field is a module ID that is the primary entry point to your program. That is, if your package is named foo, and a user installs it, and then does require("foo"), then your main module’s exports object will be returned.
This should be a module ID relative to the root of your package folder
For most modules, it makes the most sense to have a main script and often not much else.

在以上說明中可以得出以下結論：

  1. main欄位是一個模組ID，是程式的主入口。
  2. 當使用require("xxx")的時候，匯入的是main欄位對應的js檔案裡的module.exports。

所以require匯入模組的時候，是執行的對應模組package.json中main欄位指定的檔案。

--- end ---

相關文章