Node.js模块化学习

• 模块化的基本概念
• Node.js 中模块化
• npm与包
• 模块的加载机制

模块化的基本概念

什么是模块化

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

把代码进行模块化拆分的好处：
① 提高了代码的复用性
② 提高了代码的可维护性
③ 可以实现按需加载

模块化规范

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

• 使用什么样的语法格式来引用模块
• 在模块中使用什么样的语法格式向外暴露成员
  模块化规范的好处：大家都遵守同样的模块化规范写代码，降低了沟通的成本，极大方便了各个模块之间的相互调用，利人利己。

Node.js中的模块化

Node.js 中模块的分类

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

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

加载模块

使用强大的 require() 方法，可以加载需要的内置模块、用户自定义模块、第三方模块进行使用。例如：

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

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

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

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

Node.js 中的模块作用域

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

模块作用域

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

module 对象

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

module对象

module.exports 对象

在自定义模块中，可以使用 module.exports 对象，将模块内的成员共享出去，供外界使用。
外界用 require() 方法导入自定义模块时，得到的就是 module.exports 所指向的对象。

共享成员时的注意点

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

// 向module.exports对象上挂载属性username
module.exports.username = 'zs'
    // 向module.exports对象上挂载方法sayHello
module.exports.sayHello = () => {
        console.log('hello');
    }
    // 让module.exports指向一个全新的对象
module.exports = {
    nickname: 'xh',
    sayHi() {
        console.log('Hi');
    }
}

--------------------------------------------------------------
// 导入模块
const m = require('./file/index')

// 输出{nickname:'xh',sayHi:[function: Hi]}
console.log(m);

exports 对象

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

exports 和 module.exports 的使用误区

时刻谨记，require() 模块时，得到的永远是 module.exports 指向的对象：

exports.usename = 'zs'
module.exports = {
    gender: '男',
    age: 22
}
// 输出{gender:'男',age:22}


/* --------------------------- */


module.exports.usename = 'zs'
exports = {
    gender: '男',
    age: 22
}
// 输出{username:'zs'}


/* --------------------------- */


exports.usename = 'zs'
module.exports.gender = '男'
// 输出{usename:'zs',gender:'男'}


/* --------------------------- */


exports = {
    usename: 'zs',
    gender: '男'
}
module.exports = exports
module.exports.age = '22'
// 输出{usename:'zs',gender:'男',age:22}

注意：为了防止混乱，建议大家不要在同一个模块中同时使用 exports 和 module.exports

Node.js 中的模块化规范

Node.js 遵循了 CommonJS 模块化规范，CommonJS 规定了模块的特性和各模块之间如何相互依赖。
CommonJS 规定：
① 每个模块内部，module 变量代表当前模块。
② module 变量是一个对象，它的 exports 属性（即 module.exports）是对外的接口。
③ 加载某个模块，其实是加载该模块的 module.exports 属性。require() 方法用于加载模块。

npm与包

什么是包

Node.js中的第三方模块叫做包

包的来源

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

为什么需要包

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

从哪里下载包

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

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

如何下载包

npm, Inc. 公司提供了一个包管理工具，我们可以使用这个包管理工具，从 https://registry.npmjs.org/ 服务器把需要的包下载到本地使用。
这个包管理工具的名字叫做 Node Package Manager（简称 npm 包管理工具），这个包管理工具随着 Node.js 的安装包一起被安装到了用户的电脑上。

npm -v查看版本号

体验npm

使用npm下载moment.js格式化时间：

快速格式化时间案例

在项目中安装包的命令

安装包：

npm install 包的完整名

简写：

npm i 包的完整名

安装指定版本的包：

npm i [email protected]

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

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

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

包的语义化版本规范

包的版本号是以“点分十进制”形式进行定义的，总共有三位数字，例如 2.24.0
其中每一位数字所代表的的含义如下：
第1位数字：大版本
第2位数字：功能版本
第3位数字：Bug修复版本

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

包管理配置文件

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

• 项目的名称、版本号、描述等
• 项目中都用到了哪些包
• 哪些包只在开发期间会用到
• 那些包在开发和部署时都需要用到
  在多人协作开发时，由于第三方包的体积过大，一般我们不会同步node_module这个文件，在上传git时一般通过添加.gitignore忽略文件，一般只会保留package.json文件。

package.json使用

快速创建：

//  作用在执行命令所处的文件目录中，快速创建package.json文件
npm init -y

该方法为快速创建，如果在终端中只执行npm init，需要进一步确认创建项后依次敲回车，最后yes确认创建。
注意：
① 上述命令只能在英文的目录下成功运行！所以，项目文件夹的名称一定要使用英文命名，不要使用中文，不能出现空格。
② 运行 npm install 命令安装包的时候，npm 包管理工具会自动把包的名称和版本号，记录到 package.json 中。

包管理配置文件

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

一次性安装所有的包

如果拿到一个剔除了 node_modules 的项目之后，需要重新下载所有的包之后再把程序跑起来，不然就会出现以下错误：

//  由于项目运行依赖于moment这个包，如果没有提前安安装好这个包，就会报错
Error:Cannot find module 'moment'

可以运行 npm install 命令（或 npm i）一次性安装所有的依赖包

// 在执行npm install命令时，npm包管理工具会想读取package.json中的dependencies节点
npm i

卸载包

npm uninstall  包名

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

Dependencies节点& devDependencies节点

Dependencies节点：

• 开发和上线都要用到的放在这里

npm install 包名

devDependencies节点：
开发环境用到，上线后用不到放在这里

// 简写
npm i 包名 -D
// 完整写法
npm install 包名 --save-dev

解决下包速度慢的问题

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

• 切换npm的下载包镜像服务源

# 查看当前下载的包镜像源
npm config get registry
# 将下载包的镜像源切换为淘宝镜像源
npm config set registry=https://registry.npm.taobao.org/
#检查镜像源是否下载成功
npm config get registry

• nrm工具

# 通过nrm包管理工具，将nrm安装为全局可用工具
npm i nrm -g
# 查看所有可用镜像源
nrm ls
# 将下包的镜像源切换成taobao镜像
nrm use taobao 

包的分类

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

• 项目包
  安装到项目中的node_modules目录中的都是项目包
  又被分为开发依赖(devDependencies)和核心依赖(dependencies)

npm i 包名 -D    # 开发依赖包（会被记录到devDependencies节点下）
npm i 包名       #核心依赖包（会被记录到dependencies）

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

npm i 包名 -g           # 全局安装指定的包
npm uninstall 包名 -g   #写在全局安装的包

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

规范的包结构

在清楚了包的概念、以及如何下载和使用包之后，接下来，我们深入了解一下包的内部结构。
一个规范的包，它的组成结构，必须符合以下 3 点要求：
① 包必须以单独的目录而存在
② 包的顶级目录下要必须包含 package.json 这个包管理配置文件
③ package.json 中必须包含 name，version，main 这三个属性，分别代表包的名字、版本号、包的入口。
注意：以上 3 点要求是一个规范的包结构必须遵守的格式，关于更多的约束，可以参考如下网址：https://yarnpkg.com/zh-Hans/docs/package-json

模块的加载机制

优先从缓存中加载

模块在第一次加载后会被缓存。 这也意味着多次调用 require() 不会导致模块的代码被执行多次。
注意：不论是内置模块、用户自定义模块、还是第三方模块，它们都会优先从缓存中加载，从而提高模块的加载效率。

内置模块的加载机制

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

自定义模块的加载机制

使用 require() 加载自定义模块时，必须指定以 ./ 或 ../ 开头的路径标识符。在加载自定义模块时，如果没有指定 ./ 或 ../
这样的路径标识符，则 node 会把它当作内置模块或第三方模块进行加载。
同时，在使用 require() 导入自定义模块时，如果省略了文件的扩展名，则 Node.js 会按顺序分别尝试加载以下的文件：
① 按照确切的文件名进行加载
② 补全 .js 扩展名进行加载
③ 补全 .json 扩展名进行加载
④ 补全 .node 扩展名进行加载
⑤ 加载失败，终端报错

第三方模块的加载机制

如果传递给 require() 的模块标识符不是一个内置模块，也没有以 ‘./’ 或 ‘../’ 开头，则 Node.js 会从当前模块的父
目录开始，尝试从 /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

目录作为模块

当把目录作为模块标识符，传递给 require() 进行加载的时候，有三种加载方式：
① 在被加载的目录下查找一个叫做 package.json 的文件，并寻找 main 属性，作为 require() 加载的入口
② 如果目录里没有 package.json 文件，或者 main 入口不存在或无法解析，则 Node.js 将会试图加载目录下的 index.js 文件。
③ 如果以上两步都失败了，则 Node.js 会在终端打印错误消息，报告模块的缺失：Error: Cannot find module 'xxx'