Node.js 模块化及npm概念介绍

模块化

1 模块化的基本概念

1.1 什么是模块化

模块化是指解决一个复杂问题时，自顶向下逐层把系统战划分成若干模块的过程。对于整个系统来说，模块是可组合、分解和更换的单元

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

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

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

1.2 模块化规范

模块化规范就是对代码进行模块化的拆分与组合时，需要遵守的那些规则。

模块化规范的好处：大家都遵守同样的模块化规范写代码，降低了沟通的成本，极大方便了各个模块之间的相互调用，利人利民。

例如：

• 使用什么样的语法格式来引用模块
• 在模块中使用什么样的语法格式向外暴露成员

2 Nodejs中的模块化

2.1 Nodejs中模块的分类

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

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

2.2 加载模块

使用require()方法，可以加载需要的各种模块

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

// 加载自定义模块（.js后缀名可以省略）
const custom = require('./common.js')

// 加载第三方模块（首先需要下载对应的模块）
const moment = require('moment')
1
2
3
4
5
6
7
8

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

2.3 模块的作用域

模块作用域：和函数作用域类似，在自定义模块中定义的变量、方法等成员，只能在当前模块内被访问，这种模块级别的访问限制，叫做模块作用域。

模块作用域的好处：可以防止全局变量污染的问题

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

2.4.1 module对象

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

2.4.2 module.export对象

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

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

测试：（二者在同一目录中）

testmodule.js

const e = require('./testExport.js')

console.log(e)
1
2
3

testExport.js

module.exports.username = 'huo'

module.exports.hello = () => {
    console.log('Hello World')
}
1
2
3
4
5

运行testmodule.js得到结果：

2.4.3 共享成员时的注意点

使用require()方法导入模块时，导入的结果永远以module.exports指向的对象为准

运行右边的文件，得到结果：

2.4.4 exports对象

由于module.exports单词写起来比较复杂，为了简化向外共享成员的代码，Node提供了exports对象。默认情况下，exports和module.exports指向同一个对象。最终共享的结果，还是以module.exports指向的对象为准。

2.4.5 exportshe module.exports的使用误区

使用require()导入模块的时候，得到的永远都是module.exports指向的对象

为了防止混乱，不要在同一个模块中同时使用exports和module.exports

2.5 Nodejs的模块化规范

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

CommonJS规定：

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

3 npm与包

3.1 包

3.1.1 什么是包

Nodejs中的第三方模块又叫做包

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

3.1.2 包的来源

不同于Nod.js中的内置模块与自定义模块，包是由第三方个人或团队开发出来的，免费供所有人使用。

注意：Node.js中的包都是免费且开源的，不需要付费即可免费下载使用。

3.1.3 为什么需要包

由于Node.js的内置模块仅提供了一些底层的API,导致在基于内置模块进行项目开发的时，效率很低。

包是基于内置模块封装出来的，提供了更高级、更方便的API,极大的提高了开发效率。

包和内置模块之间的关系，类似于jQuery和浏览器内置API之间的关系。

3.1.4 从哪里下载包

国外有一家IT公司，叫做npm,Inc.这家公司旗下有一个非常著名的网站：https:/www.npmis.coml,它是全球最大的包共享平台，你可以从这个网站上搜索到任何你需要的包，只要你有足够的耐心！

到目前为止，全球约1100多万的开发人员，通过这个包共享平台，开发并共享了超过120多万个包供我们使用。

npm,Inc.公司提供了一个地址为https:/registry.npmjs…orgl的服务器，来对外共享所有的包，我们可以从这个服务器上下载自己所需要的包。

注意：

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

可以自己配置淘宝镜像，下载速度更快

3.1.5 如何下载包

npm,Inc.公司提供了一个包管理工具，我们可以使用这个包管理工具，

从https://reqistry.npmis.org服务器把需要的包下载到本地使用。这个包管理工具的名字叫做Node Package Manager(简称npm包管理工具)，这个包管理工具随着Node.js的安装包一起被安装到了用户的电脑上。

可以在终端中执行npm -y命令，来查看自己电脑上所安装的npm包管理工具的版本号：

3.2 npm初体验

3.2.1 在项目中安装包的命令

如果想在项目中安装指定名称的包，需要运行如下的命令：

npm install 包的完整名称
1

可以简写为：

npm i 包的完整名称
1

安装多个包：

npm i 包名1 包名2 包名3
1

一次性安装package.json中所需的所有依赖包

npm install
1

看到红框中的东西说明就装好了

WARN可以无视

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
1

3.2.4 包的语义化版本规范

包的版本号是以“点分十进制”形式进行定义的，总共有三位数字，例如2.24.0

其中每一位数字所代表的的含义如下：

• 1位数字：大版本（架构更新）
• 第2位数字：功能版本（功能更新）
• 第3位数字：Bug修复版本

版本号提升的规则：只要前面的版本号增长了，则后面的版本号归零。

3.3 包管理配置文件

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

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

3.3.1 如何记录项目中安装了哪些包

在项目根目录中，创建一个叫做package.json的配置文件，即可用来记录项目中安装了哪些包。从而方便剔服node modules目录之后，在团队成员之间共享项目的源代码。

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

3.3.2 快速创建package.json

npm包管理工具提供了一个快捷命令，可以在执行命令时所处的目录中，快速创建package.json这个包管理配置文件：

在项目创建时候执行一次就行

# -y的作用是自动确认所有问题（全部采用默认配置）
npm init -y 
1
2

初始化创建的package.json文件如图：

项目名称为当前文件夹的名称

注意：

• 上述命令只能在英文的目录下成功运行！所以，项目文件夹的名称一定要使用英文命名，不要使用中文，不能出现空格。（路径有中文可以，但是最底层文件夹里面不能有中文）
• 运行npm install命令安装包的时候，npm包管理工具会自动把包的名称和版本号，记录到package.json中。

3.3.3 dependencies节点

package.json文件中，有一个dependencies节点，专门用来记录使用npm install命令安装了哪些包。

每次使用完npm i 包名后都会自动加入到Package.json中

3.3.4 devDependencies

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

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

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

npm i 包名 -D
# 或者
npm i 包名 --save-dev
1
2
3

3.3.5 卸载包

使用npm uninstall命令，来卸载指定的包

npm uninstall 包名
1

注意：npm uninstall命令执行成功后，会把卸载的包，自动从package.json的dependencies中移除掉。

3.4 npm配置淘宝镜像

3.4.1 为什么默认源下载很慢？

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

3.4.2 淘宝npm镜像服务器

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

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

3.4.3 切换npm的下包镜像源

下包的镜像源，指的就是下包的服务器地址

# 查看当前的下包镜像源
npm config get registry

# 将下包的镜像源切换为淘宝镜像源
npm config set registry=https://registry.npm.taobao.org/

# 检查镜像源是否下载成功
npm config get registry
1
2
3
4
5
6
7
8

配置成功后后续下载的源服务器就是淘宝的服务器了，速度会快很多

3.4.4 nrm

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

# 通过npm包管理器，将nrm安装为全局可用的工具
npm i nrm -g

# 查看所有可用的镜像源
nrm ls

# 将下包的镜像源切换为taobao镜像
nrm use taobao
1
2
3
4
5
6
7
8

3.5 包的分类

使用npm包管理工具下载的包，共分为两大类，分别是：

• 项目包：被安装到项目的node modules目录中的包，都是项目包。

  • 开发依赖包（被记录到devDependencies节点中的包，只在开发期间会用到）

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

    npm i 包名 -D # 开发依赖包，会被记录到devDependencies中
    npm i 包名	# 核心依赖包，dependencies
    1
    2

• 全局包

  • 在执行npm install命令时，如果提供了-g参数，则会把包安装为全局包。

  • 全局包会被安装到C:\Users\用户目录\AppData\Roaming\npm\node_modules目录下

  • npm i 包名 -g 		# 全局安装指定的包
    npm uninstall 包名 -g	# 卸载全局安装的包
    1
    2

  • 注意：

    • 只有工具性质的包，才有全局安装的必要性。因为它们提供了好用的终端命令。
    • 判断某个包是否需要全局安装后才能使用，可以参考官方提供的使用说明即可。

3.6 规范的包结构

在清楚了包的概念、以及如何下载和使用包之后，接下来，我们深入了解一下包的内部结构。

一个规范的包，它的组成结构，必须符合以下3点要求：

• 包必须以单独的目录而存在
• 包的顶级目录下要必须包含package.json这个包管理配置文件
• package.json中必须包含name,version,main这三个属性，分别代表包的名字、版本号、包的入口。

4 模块的加载机制

4.1 优先从缓存加载

模块在第一次加载后会被缓存。这也意味着多次调用require0不会导致模块的代码被执行多次。

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

4.2 内置模块的加载机制

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

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

4.3 自定义模块的家在机制

使用require()加载自定义模块时，必须指定以./或../开头的路径标识符。在加载自定义模块时，如果没有指定./或../这样的路径标识符，则node会把它当作内置模块或第三方模块进行茄载。

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

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

4.4 第三方模块的加载机制

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

如果没有找到对应的第三方模块，则移动到再上一层父目录中，进行加载，直到文件系统的根目录。

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

• C:\Users\Hydrion\project\node_modules\tools
• C:\Users\Hydrion\node_modules\tools
• C:\Users\Hydrion\tools
• C:\node_modules\tools

如果最后还找不到就报错

4.5 目录作为模块

当把目录作为模块标识符进行加载的时候，有三种加载方式：

• 在被加载的目录下查找 package.json 的文件，并寻找 main 属性，作为 require() 加载的入口
• 如果没有 package.json 文件，或者 main 入口不存在或无法解析，则 Node.js 将会试图加载目录下的 index.js 文件。
• 若失败则报错