Node-js中的第三方模块(包)的详解以及模块的加载机制
第三模块(包)
概念
Node.js 中的第三方模块又叫做包。不同于 Node.js 中的内置模块与自定义模块,包是由第三方个人或团队开发出来的,免费供所有人使用。
为什么需要包
由于 Node.js 的内置模块仅提供了一些底层的API
,导致在基于内置模块进行项目开发的时,效率很低。包是基于内置模块封装出来的,提供了更高级、更方便的API
,极大的提高了开发效率。
npm
的常见命令操作
npm-v
查看npm版本npm install xxx(包名)
安装包npm init
初始化包npm uninstall xxx(包名)
卸载包npm info xxx(包名)
查看包的详细信息npm view xxx(包名) versions
查看一个包存在的所有版本号npm view xxx(包名) versions
查看指定包当前的最新版本npm install xxx(包名)@2.6.11
下载指定版本的包npm list
查看项目安装了哪些包npm install xxx(包名) --save
或者-S
--save 下载生产依赖包npm install xxx(包名) --save-dev
或者-D
下载开发依赖包npm root -g
查看全局安装包的存放位置npm audit fix
包的修复,一般是 包的更新npm is xxx(包名)
查看当前包的版本npm config set registry https://registry.npm.taobao.org
更改npm的下载镜像为淘宝镜像
包管理配置文件
npm
规定,在项目根目录中,必须提供一个叫做·package.json
的包管理配置文件。用来记录与项目有关的一些配置信息。例如:项目的名称、版本号、描述等;项目中都用到了哪些包;哪些包只在开发期间会用;到那些包在开发和部署时都需要用到。
-
如何记录项目中安装了哪些包:
- 在项目根目录中,创建一个叫做
package.json
的配置文件,即可用来记录项目中安装了哪些包。从而方便剔除node_modules
目录之后,在团队成员之间共享项目的源代码。 - 注意:今后在项目开发中,一定要把
node_modules
文件夹,添加到.gitignore
忽略文件中。
- 在项目根目录中,创建一个叫做
-
快速创建
package.json
- 初始化,文件快速创建
package.json
文件
npm init -y
- 运行
npm install
命令安装包的时候,npm
包管理工具会自动把包的名称和版本号,记录到package.json
中。
- 初始化,文件快速创建
-
package.json
中的dependencies
节点:专门用来记录您使用npm install
命令安装了哪些包。 -
node_moudles
你安装的所有包
包的分类
-
项目包 :那些被安装到项目的
node_modules
目录中的包,都是项目包。- 开发依赖包
使用
npm i 包名 -D
安装的包,会被记录到devDependencies
节点下- 核心依赖包
使用
npm i 包名
安装的包,会被记录到dependencies
节点下 -
全局包 :在执行
npm install
命令时,如果提供了 -g 参数,则会把包安装为全局包。全局包会被安装到
C:\Users\用户目录\AppData\Roaming\npm\node_modules
目录下。- 全局包的安装
npm i 包名 -g
- 全局包的卸载
npm uninstall 包名 -g
- 判断是否需要安装到全局
只有工具性质的包,才有全局安装的必要性。因为它们提供了好用的终端命令。另外可以去
npm
官方去查询该包,在它的简介里会告诉你安装到全局还是局部。
规范的包结构
- 包必须以单独的目录而存在
- 包的顶级目录下要必须包含
package.json
这个包管理配置文件 package.json
中必须包含name
,version
,main
这三个属性,分别代表包的名字、版本号、包的入口。- 更多的规范请查看官方网站
模块的加载机制
模块在第一次加载后会被缓存。 这也意味着多次调用require()
不会导致模块的代码被执行多次。
**注意:**不论是内置模块、用户自定义模块、还是第三方模块,它们都会优先从缓存中加载,从而提高模块的加载效率。
内置模块是由 Node.js 官方提供的模块,内置模块的加载优先级最高。
使用require()
加载自定义模块时,必须指定以 ./ 或 …/ 开头的路径标识符。在加载自定义模块时,如果没有指定 ./ 或 …/ 这样的路径标识符,则 node 会把它当作内置模块或第三方模块进行加载。同时,在使用 require()
导入自定义模块时,如果省略了文件的扩展名,则 Node.js 会按顺序分别尝试加载以下的文件:
- 按照确切的文件名进行加载
- 补全
.js
扩展名进行加载 - 补全
.json
扩展名进行加载 - 补全
.node
扩展名进行加载 - 加载失败,终端报错
如果传递给require()
的模块标识符不是一个内置模块,也没有以 ‘./’ 或 ‘…/’ 开头,则 Node.js 会从当前模块的父目录开始,尝试从 /node_modules
文件夹中加载第三方模块。如果没有找到对应的第三方模块,则移动到再上一层父目录中,进行加载,直到文件系统的根目录。
当把目录作为模块标识符,传递给 require()
进行加载的时候,有三种加载方式:
- 在被加载的目录下查找一个叫做
package.json
的文件,并寻找main
属性,作为require()
加载的入口 - 如果目录里没有
package.json
文件,或者main
入口不存在或无法解析,则 Node.js 将会试图加载目录下的index.js
文件。 - 如果以上两步都失败了,则 Node.js 会在终端打印错误消息,报告模块的缺失:
Error: Cannot find module 'xxx'