node中的模块化与npm包｜青训营笔记这是我参与「第四届青训营」笔记创作活动的的第18天 1 Node.js 中

这是我参与「第四届青训营」笔记创作活动的的第19天

1 Node.js 中模块的分类

1.1 模块分类

Node.js 中根据模块来源的不同，将模块分为了 3 大类，分别是：

内置模块（内置模块是由 Node.js 官方提供的，例如 fs、path、http 等）
自定义模块（用户创建的每个 .js 文件，都是自定义模块）
第三方模块（由第三方开发出来的模块，并非官方提供的内置模块，使用前需要先下载）

1.2 require() 使用

只有加载自定义模块的时候才用路径，其他2种直接用模块名：

// 加载node内置的fs模块
const fs = require('fs')

// 加载用户自定义的fs模块
const custom = require('./custom.js')

// 加载第三方模块
const moment = require('moment')

注意：使用require()方法加载其他模块时，会执行被加载模块中的代码

1.3 Node.js 中的模块作用域

什么是模块作用域？

和函数作用域类似，在自定义模块中定义的变量、方法等成员，只能在当前模块内被访问

好处就是防止变量污染（覆盖）

▲1.4 向外共享模块作用域中的成员

1.4.1 module 对象

在每个 .js 自定义模块中都有一个 module 对象，它里面存储了和当前模块有关的信息

其中的exports 属性存放暴露的对象

1.4.2 module.exports 对象

在自定义模块中，可以使用 module.exports 对象，将模块内的成员共享出去，供外界使用。

外界用 require(）方法导入自定义模块时，得到的就是 module.exports 所指向的对象。

使用 require() 方法导入模块时，导入的结果，永远以 module.exports 指向的对象为准（后面的代码会覆盖）

1.4.3 exports 对象

由于 module.exports 单词写起来比较复杂，为了简化向外共享成员的代码，Node 提供了 exports 对象。

默认情况下，exports 和 module.exports 指向同一个对象。

最终共享的结果，还是以 module.exports 指向的对象为准！【不嫌麻烦的话还是写 module.exports 吧】

1.4.4 Node.js 中的模块化规范

Node.js 遵循了 CommonJS 模块化规范，CommonJS 规定了模块的特性和各模块之间如何相互依赖。

CommonJS 规定：

每个模块内部，module 变量代表当前模块。
module 变量是一个对象，它的 exports 属性即 module.exports 是对外的接口。
加载某个模块，其实是加载该模块的 module.exports 属性。require() 方法用于导入模块。

2 模块化的基本概念

编程领域中的模块化，就是遵守固定的规则，把一个大文件拆成独立并且相互依赖的多个小模块。

把代码进行模块化拆分的好处:

提高了代码的复用性
提高了代码的可维护性
实现按需加载

2.1 优先从缓存中加载

模块在第一次加载后会被缓存。这也意味着多次调用 require() 只会执行一次。

注意：不论是内置模块、用户自定义模块、还是第三方模块，它们都会优先从缓存中加载，从而提高模块的加载效率。

2.2 内置模块的加载机制

内置模块是由 Node.js 官方提供的模块，内置模块的加载优先级最高。

例如，即使在 node_modules 目录下有名字相同的包也叫做 fs，require('fs') 始终返回 node 内置的 fs 模块。

2.3 自定义模块的加载机制

使用 require() 加载自定义模块时，必须指定以 ./ 或 ../ 开头的路径标识符。

在加载自定义模块时，如果没有指定 ./ 或 ../ 这样的路径标识符，则 node 会把它当作内置模块或第三方模块进行加载。

同时，在使用 require() 导入自定义模块时，如果省略了文件的扩展名，则 Node.js 会按顺序分别尝试加载以下的文件：

按照确切的文件名进行加载
补全 .js 扩展名进行加载
补全 .json 扩展名进行加载
补全 .node 扩展名进行加载
加载失败，终端报错

2.4 第三方模块的加载机制

如果传递给 require() 的模块标识符不是一个内置模块，也没有以 ‘./’ 或 ‘../’ 开头，则 Node.js 会从当前模块的父目录开始，尝试从 /node_modules 文件夹中加载第三方模块。

如果没有找到对应的第三方模块，则移动到再上一层父目录中，继续寻找/node_modules，直到文件系统的根目录。

例如，假设在 'C:\Users\itheima\project\foo.js' 文件里调用了 require('tools')，则 Node.js 会按以下顺序查找：

**C:\Users\itheima\project\node_modules\**tools
**C:\Users\itheima\node_modules\**tools
**C:\Users\node_modules\**tools
**C:\node_modules\**tools

2.5 目录作为模块

当把目录（文件夹）作为模块标识符，传递给 require() 进行加载的时候，有三种加载方式：

在被加载的目录（文件夹）下查找 package.json ，并寻找 main 属性，作为 require() 加载的入口
如果目录（文件夹）里没有 package.json 文件，或者 main 入口不存在或无法解析，则 Node.js 将会试图加载目录（文件夹）下的 index.js 文件。
如果以上两步都失败了，则 Node.js 会在终端打印错误消息，报告模块的缺失：Error: Cannot find module 'xxx'

3 npm 与包

3.1 包

3.1.1 什么是包

Node.js 中的第三方模块又叫做包。就像电脑和计算机指的是相同的东西，第三方模块和包指的是同一个概念，只不过叫法不同。

3.1.2 包的来源

同于 Node.js 中的内置模块与自定义模块，包是由第三方个人或团队开发出来的，免费供所有人使用。 注意：Node.js 中的包都是免费且开源的，不需要付费即可免费下载使用。

3.1.3 为什么需要包

由于 Node.js 的内置模块仅提供了一些底层的 API，导致在基于内置模块进行项目开发的时，效率很低。包是基于内置模块封装出来的，提供了更高级、更方便的 API，极大的提高了开发效率。包和内置模块之间的关系，类似于 jQuery 和浏览器内置 API 之间的关系。

3.1.4 从哪里搜索、下载包

国外有一家 IT 公司，叫做 npm, Inc. 这家公司旗下有一个非常著名的网站： www.npmjs.com/ ，它是全球最大的包共享平台，你可以从这个网站上搜索到任何你需要的包，只要你有足够的耐心！到目前位置，全球约 1100 多万的开发人员，通过这个包共享平台，开发并共享了超过 120 多万个包供我们使用。 npm, Inc. 公司提供了一个地址为 registry.npmjs.org/ 的服务器，来对外共享所有的包，我们可以从这个服务器上下载自己所需要的包。

注意：

从 www.npmjs.com/ 网站上搜索自己所需要的包
从 registry.npmjs.org/ 服务器上下载自己需要的包

3.1.5 如何下载包

npm, Inc. 公司提供了一个包管理工具，我们可以使用这个包管理工具，从 registry.npmjs.org/ 服务器把需要的包下载到本地使用。这个包管理工具的名字叫做 Node Package Manager（简称 npm 包管理工具），这个包管理工具随着 Node.js 的安装包一起被安装到了用户的电脑上。大家可以在终端中执行 npm -v 命令，来查看自己电脑上所安装的 npm 包管理工具的版本号

▲3.2 npm

3.2.1 安装包的命令【可缩写为 i 】

在终端中输入

npm install A包名 B包名
// 上述的装包命令，可以简写成如下格式：
npm i A包名 B包名

3.2.2 初次装包后多了哪些文件

初次装包完成后，在项目文件夹下多一个叫做 node_modules 的文件夹和 package-lock.json 的配置文件

其中：

node_modules 文件夹用来存放所有已安装到项目中的包。require() 导入第三方包时，就是从这个目录中查找并加载包。
package-lock.json配置文件用来记录 node_modules 目录下的每一个包的下载信息，例如包的名字、版本号、下载地址等。

注意：程序员不要手动修改 node_modules 或 package-lock.json 文件中的任何代码，npm 包管理工具会自动维护它们。

3.2.3 安装指定版本的包

默认情况下，使用 npm install 命令安装包的时候，会自动安装最新版本的包。如果需要安装指定版本的包，可以在包名之后，通过 @ 符号指定具体的版本，例如：

npm i moment@2.22.2

▲3.3 包管理配置文件 package.json

npm 规定，在项目根目录中，必须提供一个叫做 package.json 的包管理配置文件。用来记录与项目有关的一些配置信息【存放在"dependencies" 节点里】例如：

项目的名称、版本号、描述等
项目中都用到了哪些包
哪些包只在开发期间会用到
那些包在开发和部署时都需要用到

3.3.1 多人开发时注意

整个项目的体积是 30.4M 第三方包的体积是 28.8M 项目源代码的体积 1.6M

遇到的问题：第三方包的体积过大，不方便团队成员之间共享项目源代码。

解决方案：共享时剔除 node_modules ，利用 package.json 的配置文件，记录项目中安装了哪些包

注意：今后在项目开发中，一定要把 node_modules 文件夹，添加到 .gitignore 忽略文件中。

3.3.2 快速创建package.json 【不可缩写为 i 】

在项目新建的时候（开发之前），运行以下命令：

npm init -y  【注意是 init 不是 install ,且不可缩写为 i】

注意：

上述命令只能在英文目录下成功运行！所以，项目文件夹的名称一定要使用英文命名，不要使用中文，不能出现空格（用下划线代替）
运行 npm install 命令安装包的时候，npm 包管理工具会自动把包的名称和版本号，记录到 package.json 中

3.3.3 一次性安装所有的包

当我们拿到一个剔除了 node_modules 的项目之后，需要先把所有的包下载到项目中，才能将项目运行起来。

一次性安装所有的依赖包：

npm install 或 npm i

3.3.4 卸载包

npm uninstall (不能用uni) 命令执行成功后，会把卸载的包，自动从 package.json 的 dependencies 中移除

npm uninstall 包名

3.3.5 devDependencies 节点

如果某些包只在项目开发阶段会用到，在项目上线之后不会用到，这些包会记录到 devDependencies 节点中。

与之对应的，如果某些包在开发和项目上线之后都需要用到，则建议把这些包记录到 dependencies 节点中。

您可以使用如下的命令，将包记录到 devDependencies 节点中：

npm i 包名 -D

3.4 解决下包速度慢的问题

3.4.1 为什么下包速度慢

在使用 npm 下包的时候，默认从国外的 registry.npmjs.org/ 服务器进行下载，此时，网络数据的传输需要经过漫长的海底光缆，因此下包速度会很慢。

扩展阅读 - 海底光缆： baike.baidu.com/item/%E6%B5… baike.baidu.com/item/%E4%B8… baike.baidu.com/item/APG/23…

3.4.2 淘宝 NPM 镜像服务器

淘宝在国内搭建了一个服务器，专门把国外官方服务器上的包同步到国内的服务器，然后在国内提供下包的服务。从而极大的提高了下包的速度。

扩展：

镜像（Mirroring）是一种文件存储形式，一个磁盘上的数据在另一个磁盘上存在一个完全相同的副本即为镜像。

3.4.3 切换镜像源

法一：

npm config get registry  查看当前下包的镜像源
npm config set registry=http://registry.npm.taobao.org/  切换为淘宝镜像源

法二：

为了更方便的切换下包的镜像源，我们可以安装 nrm 这个包，利用 nrm 提供的终端命令，可以快速查看和切换下包的镜像源。

npm i nrm -g
nrm ls   查看所有可用的镜像源
nrm use taobao  切换为淘宝镜像

3.5 包的分类

3.5.1 项目包

那些被安装到项目的 node_modules 目录中的包，都是项目包。

项目包又分为两类，分别是：

开发依赖包（被记录到 devDependencies 节点中的包，只在开发期间会用到）
核心依赖包（被记录到 dependencies 节点中的包，在开发期间和项目上线之后都会用到）

3.5.2 全局包

在执行 npm install 命令时，如果提供了 -g 参数，则会把包安装为全局包。全局包会被安装到 C:\Users\用户目录\AppData\Roaming\npm\node_modules 目录下。

npm i 包名 -g				全局安装
npm uninstall 包名 -g		卸载全局安装的包