node.js 使用require加载第三方包时的查找规则
在使用 node.js 开发过程中经常会用到第三方包,在 const express = require('express')
这句脚本运行的时候,node.js 是怎样找到 express 这个模块的呢?
假如我们的项目目录是这样的:
- D:/workspace/node_test/ # 项目目录
main.js # 主程序
- node_modules/ # 存放第三方包
- express/ # 下载的第三方包
index.js # 第三方包的默认入口程序
package.json # 第三方包的package.json文件
...
...
package-lock.json # 元数据文件
README.md # 说明文件
步骤如下:
-
当主程序执行到 const express = require(‘express’) 这句的时候,会首先在主程序main.js 同级目录下查找node_modules 目录。
-
然后在node_modules 目录下查找express 包目录。
-
然后在express 包目录下的package.json 文件中找到main 属性,main 属性的值就是要加载的文件。
“main”: “./lib/xxx.js”
-
如果express包目录下没有package.json 文件,或者package.json 文件中没有main 属性,则会默认加载express 包目录下的index.js 文件。
-
如果以上方式没有找到,则会从上一级目录中开始查找node_modules 文件夹。
-
重复步骤 2 ~ 5。
-
如果一直当前盘符根目录下(比如 D://)都没有找到,则会报错:Error: Cannot find module ‘express’。