如何正确理解并合理使用 Node.js 中的模块（Module）和包（Package）？

最新推荐文章于 2024-08-26 12:08:18 发布

御弟謌謌

最新推荐文章于 2024-08-26 12:08:18 发布

阅读量578

点赞数 1

分类专栏： Node.js 文章标签： node.js

本文链接：https://blog.csdn.net/abraham_ly/article/details/112095404

版权

Node.js 专栏收录该内容

12 篇文章 2 订阅

订阅专栏

如何正确理解并合理使用 Node.js 中的模块（Module）和包（Package）？

模块（Module）和包（Package）是Node.js最重要的支柱。开发一个一定规模的程序不可能只用一个文件，通常需要把各个功能拆分、分装、然后组合起来。模块正是为了实现这种方式而诞生的，在浏览器中，脚本模块的拆分和组装通常使用HTML的<script></script>来实现。而在Node.js中，提供了require()方法来加载或者调用其他模块，并且模块都是基于文件的，机制非常简单。

一、模块

1、模块与模块化

1.1 什么是模块（Module）？

模块是Node.js应用程序的基本组成部分，文件和模块是一一对应的关系。换言之，一个Node.js文件就是一个模块，这个文件可能是JavaScript代码、JSON或者编译过的C/C++的扩展。

1.2 什么是模块化

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

在生活中，比如我们使用的计算机系统，它分为硬件模块和软件模块。硬件模块下又分为主机（CPU、内存系统、主板）和IO设备（键盘、鼠标、显示器）。而软件模块又分为系统软件（Windows、IOS、Android）和应用软件（聊天娱乐），那么将一个大的问题详细化分解、组装，那么是不是就使得我们比较好解决，并且思路清晰、别人看的时候一下子也能够接受。

而在编程领域中，模块化就是遵循某种固定的规则，把一个大的文件拆分成独立并互相依赖的多个模块。

1.3 模块化的好处

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

1.4 模块化规范

1.4.1 什么是模块化规范？

模块化规范就是对代码进行模块化拆分与组装时，需要遵守的一些规则，或者说约定。

例如：

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

1.4.2 模块化规范的好处

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

2、Node.js中的模块

Node.js中根据模块来源不同，可将模块分为三大类：

内置模块（核心模块）
- 随着Node.js的安装包，被一同安装到本地的模块，叫做内置模块或者核心模块
- 例如：fs、path、http模块，都是由Node.js官方提供的核心模块
- 简言之，只要大家在计算机中安装了Node环境，那么，我们的计算机中就已经安装了所以的核心模块/内置模块
用户自定义模块
- 开发者在自己项目中编写的 JavaScript 文件，就叫做用户自定义模块
第三方模块
- 由第三方开发出来的模块
- 并非官方提供的内置模块
- 也不是用户创建的自定义模块
- 使用前需要先下载

3、加载模块

在Node.js中，使用强大的require(string)方法可以加载需要的模块，包括内置核心模块、用户自定义模块和第三方模块。虽然都使用这样的方式加载，但是呢，还是有一定的区别，比如标识符。

加载内置核心模块
- Node.js提供的内置核心模块有：fs、path、http……等，加载模块的方式：const fs = require('fs');，当然，你也可以使用其他的关键字（var、let）去声明。
加载用户自定义模块
- 用户自定义模块即开发者本人使用js代码书写的模块，那么加载的时候，其实就是一个引入路径的过程，那么也就是说要使用./或者../开头。比如：const date = require("./../lib/03-格式化日期模块");。
加载第三方模块
- 加载第三方模块，首先得现有这个模块，否则加载无从谈起。那么使用第三方的模块，则首先需要在npm中下载自己所需要的模块。其加载第三方模块的方式与加载内置模块是一样的，比如：const moment = require('moment');。

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

4、模块作用域

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

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

5、模块作用域中的成员

module 对象

在每个自定义模块中都默认存在一个module 对象，即模块对象，该对象里面存储了与当前模块有关的信息。
- parent：指当前模块的父级。例如：A模块在B模块中被引用，那么B模块就是A模块的父级。
- id：指当前执行模块的位置，如果执行的自己，那么就如同上图一样，就是一个.。

module.exports 对象

在自定义模块中，可以使用module.exporst对象将模块内的成员共享出去，来供外界使用。
那么我们可以理解为，在外界（另一个模块中）使用require()方法加载自定义模块时，实际上得到的是module.exporst所指向的对象。

// 修改module.exporst对象的指向，指向一个新的对象，来供外界使用
module.exports = {
    name: "张三",
    age: "18",
    sex: "男",
    speak: function() {
        console.log(`我叫${this.name}，性别${this.sex}，今年${this.age}岁了！`);
    }
}

exports 对象
1. 由于module.exports单词写起来比较繁琐，所以为了简化向外共享成员的代码量，Node.js提供了exports对象，默认情况下exports与module.exports对象指向同一个对象。
2. 共享成员注意点：
  - 使用require()方法加载模块时，导入的结果，永远以module.exports指向的对象为准
  - 为了防止混乱，建议大家不要在同一个模块中同时使用exports对象和module.exports对象，如果要使用，只能选择其一
4、Node.js 模块化规范

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

CommonJS 规定：
1. 每个模块内部，module对象总是代表当前模块
2. modeule是一个对象，它的exports属性（即modeule.exports）是对外开放的接口
3. 加载某个模块时，实际上加载的是该模块的modeule.exports属性，那么require()方法加载模块时，加载的就是另一个模块的modeule.exports属性

二、包

1、什么是包

说法一：包可以看作是 模块、代码和其他资源(各种文件或者目录)组合起来形成的独立作用域，一个包就是一个目录文件夹
说法二：Node.js中，第三方模块又叫包

这两种说法确立了不同的立场，但我个人觉得包是由内置模块封装出来的一个目录，而这个目录中不仅记录了模块，还有一些其他的资源文件。那么这个包就是一个文件夹，这个包肯定是有利于开发所以才不使用内置模块的。但是第三方的模块下载下来都是一个包，同时我们也可以自定义包。所以我觉得两种说法都对着呢，只不过太极端了。

2、为什么需要包

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

而包是基于内置模块封装出来的，提供了更高层、更方便的API接口，极大的提高了开发效率。包和内置模块的关系，类似于jQuery和浏览器内置API的关系。

3、如何下载包

npm提供了一个包管理工具，我们可以使用这个包管理工具，从 https://registry.npmjs.org/ 服务器把需要的包下载到本地使用。
这个包管理工具又叫Node Package Manager（简称npm包管理工具），这个包管理工具随着Node.js的安装包一起被安装到了用户的电脑上。
那么可以中终端中执行npm -v命令来查看自己的电脑上所安装的npm包管理工具的版本号
接下来我们可以使用npm install 包名称或者npm i 包名称在项目中去安装指定名称的包
或者我们可以通过npm i 包名称版本号(@1.1.1)来安装指定版本的包。默认情况下，使用npm i 包名称命令安装包的时候，会自动安装最新版本的包，如果需要安装指定版本的包，可以在包名之后，通过@符号指定具体的版本
通过require()加载第三方模块，根据npm文档说明来正确使用

4、案例：格式化时间

传统做法

创建格式化时间的自定义模块
定义格式化时间的方法
创建补零函数
从自定义模块中导出格式化时间的函数

function formatDateTime(date) {
    var M = addZero(date.getMonth() + 1); //月份
    var D = addZero(date.getDate()); //日
    var hh = addZero(date.getHours()); //小时
    var m = addZero(date.getMinutes()); //分
    var s = addZero(date.getSeconds()); //秒
    return `${date.getFullYear()}-${M}-${D} ${hh}:${m}:${s}`;
}
// 如果时间 < 10，则0
function addZero(num) {
    return num < 10 ? "0" + num : num;
}
module.exports = {
    formatDateTime
}

加载格式化时间的自定义模块
调用格式化时间的函数

// 加载自定义模块
let date = require("./lib/03-格式化日期模块");
// 调用模块中的函数
let time = date.formatDateTime(new Date());
// 打印函数
console.log(time);

高级做法
- 使用 npm 包管理工具，在项目中安装格式化时间的包：moment
- 使用require()导入格式化时间的包
- 参考 moment 官方API文档对时间进行格式化
```
let moment = require("moment");
console.log(moment().format("YYYY-MM-DD HH:mm:ss"));
```

5、初次安装包的改变

初次安装包完成后，在项目文件夹下多了一个叫node_modules的文件夹和package-lock.json的配置文件。
在这里插入图片描述

说明：

node_modules文件夹用来存放所有已经安装到项目中的包。require()方法导入第三方模块时，就是从这个目录中查看并加载模块的

在这里插入图片描述

package-lock.json配置文件用来记录node_modules目录下的每一个包的下载信息，例如包的名称、版本号、下载地址等。

在这里插入图片描述

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

6、包的语义化版本规范

包的版本号是以“点分十进制”形式定义的，总共有三位数组，例如：2.29.1，其中每一位数字所代表的含义如下：

第一位数字：大版本
第二位数字：功能版本
第三位数字：Bug修复版本

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

7、包管理配置文件

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

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

8、快速创建 `package.json`配置文件

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

npm init -y

注意：

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

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-7IOYGTcd-1609566012570)(E:\后端\node.js\笔记\json配置文件信息.png)]

8.1 dependencies 节点

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

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

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

npm install 包名称 --sava dep

8.2 devDependencies 节点

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

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

npm i 包名 -D
或者
npm install 包名 --save-dev

9、包的分类

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

项目包

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

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

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

全局包

只有工具性质的包，才有全局安装的必要性。因为它们提供了好用的终端命令，我们可以理解为全局包是一个小的工具
判断某个包是否需要全局安装后才能使用，可以参考官方提供的使用说明即可。
安装全局包：npm install -g 包名称，其中-g参数就证明这个包是全局包

案例：安装i5ting_toc工具

说明：i5ting_toc是一个可以把 md 文档转换为 html 页面的小工具，使用步骤如下

全局安装

npm install -g i5ting_toc

使用终端命令转换

i5ting_toc -f 要转换的md文件的路径（相对路径） -o

10、包的结构

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

包必须以单独的目录而存在
包的根目录下必须包含package.json这个包管理配置文件
package.json配置文件中必须包含name（包名称）、version（版本号）、main（包的入口）这三个属性

注意：

以上3 点要求是一个规范的包结构必须遵守的格式，关于更多的约束，可以参考如下网址：https://yarnpkg.com/zh-Hans/docs/package-json

11、开发属于自己的包

11.1 需要实现的功能

格式化日期时间
随机一个指定区域内的整数
求出一个指定的斐波那契数列位数

11.2 初始化包的基本结构

新建 ylt-tools文件夹，作为包的根目录
在ylt-tools文件夹中，新建如下三个文件：

package.json （包管理配置文件）

index.js （包的入口文件）

README.md（包的说明文档）
初始化 package.json
在 index.js 中实现上面的所有功能的方法
将不同的功能进行模块化拆分
1. 将格式化时间的功能，拆分到 src --> dateFormat.js 中
2. 将处理随机数和斐波那契数列的功能，拆分到 src --> mathNum.js 中
3. 在 index.js 中，导入两个模块，得到需要向外共享的方法
4. 在 index.js 中，使用 module.exports 把对应的方法共享出去
编写包的说明文档
1. 包根目录中的README.md 文件，是包的使用说明文档。通过它，我们可以事先把包的使用说明，以 markdown 的格式写出来，方便用户参考。
2. README文件中具体写什么内容，没有强制性的要求；只要能够清晰地把包的作用、用法、注意事项等描述清楚即可。
3. 我们所创建的这个包的README.md 文档中，会包含以下 6 项内容：
  
  安装方式、导入方式、格式化时间、随机一个指定区域内的整数、求出一个指定的斐波那契数列位数、开源协议

在这里插入图片描述

12、发布包

1、注册 npm 账号

访问 https://www.npmjs.com/ 网站，点击 sign up 按钮，进入注册用户界面
填写账号相关的信息： Full Name 、 Public Email 、 Username 、 Password
点击 Create an Account 按钮，注册账号
登录邮箱，点击验证链接，进行账号的验证

2、登录 npm 账号

npm账号注册完成后，可以在终端中执行 npm login命令，依次输入用户名、密码、邮箱后，即可登录成功。

注意：在运行npm login命令之前，必须先把下包的服务器地址切换为 npm 的官方
服务器。否则会导致发布包失败！

3、包发布到npm上

将终端切换到包的根目录之后，运行npm publish命令，即可将包发布到 npm 上（注意：包名不能雷同）。

4、删除已发布的包

运行npm unpublish 包名 --force 命令，即可从 npm 删除已发布的包。

注意：

npm unpublish 命令只能删除 72 小时以内发布的包
npm unpublish 删除的包，在 24 小时内不允许重复发布
发布包的时候要慎重，尽量不要往 npm 上发布没有意义的包

三、模块的加载机制

1、优先从缓存中加载

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

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

2、内置模块的加载机制

内置模块是由Node.js 官方提供的模块，内置模块的加载优先级最高。例如，require(‘fs’) 始终返回内置的 fs 模块，即使在 node_modules 目录下有名字相同的包也叫做 fs 。

3、自定义模块的加载机制

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

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

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

4、第三方模块的加载机制

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

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

5、目录作为模块

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

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

四、下载速度慢的问题

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

在这里插入图片描述

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

在这里插入图片描述

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

切换npm的下包镜像源

下包的镜像源指下包的镜像地址

查看当前的下包镜像源
npm config get registry
将下包的镜像源切换为其他镜像源
npm config set registry=镜像源地址
检查镜像源是否下载成功
npm config get registry

nrm 工具

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

通过npm安装全局的nrm工具
npm i -g nrm 
查看所有可用的镜像源
nrm ls
切换下包镜像源
nrm use 镜像源名

御弟謌謌

关注

1
点赞
踩
3

收藏

觉得还不错? 一键收藏
打赏
0
评论
复制链接

分享到 QQ

分享到新浪微博

扫一扫

专栏目录

如何正确理解并合理使用 Node.js 中的模块（Module）和包（Package）？

如何正确理解并合理使用 Node.js 中的模块（Module）和包（Package）？

目录：

一、模块

1、模块与模块化

1.1 什么是模块（Module）？

1.2 什么是模块化

1.3 模块化的好处

1.4 模块化规范

1.4.1 什么是模块化规范？

1.4.2 模块化规范的好处

2、Node.js中的模块

3、加载模块

4、模块作用域

5、模块作用域中的成员

二、包

1、什么是包

2、为什么需要包

3、如何下载包

4、案例：格式化时间

5、初次安装包的改变

6、包的语义化版本规范

7、包管理配置文件

8、快速创建 package.json配置文件

8.1 dependencies 节点

8.2 devDependencies 节点

9、包的分类

10、包的结构

11、开发属于自己的包

11.1 需要实现的功能

11.2 初始化包的基本结构

12、发布包

1、注册 npm 账号

2、登录 npm 账号

3、包发布到npm上

4、删除已发布的包

三、模块的加载机制

1、优先从缓存中加载

2、内置模块的加载机制

3、自定义模块的加载机制

4、第三方模块的加载机制

5、目录作为模块

四、下载速度慢的问题

切换npm的下包镜像源

nrm 工具

8、快速创建 `package.json`配置文件