JavaScript 模块化

模块化

目标：
能够说出模块化的好处
能够知道CommonJS规定了哪些内容
能够说出Node.js 中模块的三大分类各自是什么
能够使用npm 管理包
能够了解什么是规范的包结构
能够了解模块的加载机制

1 模块化的基本概念

1.1 什么是模块化

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

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

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

1.2 模块化规范

模块化规范就是，对代码进行模块化的拆分与组合时，需要遵守的那些规则。
例如:
使用什么样的语法格式来引用模块
在模块中使用什么样的语法格式向外暴露成员

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

2 Node.js 中模块化

2.1 Node.js 中模块的分类

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

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

2.2 加载模块

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

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

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

// 3.加载第三方模块(关于第三方模块的下载和使用，会在后面的课程中进行专门的讲解)
const moment = require('moment')

注意:

• 使用require()方法加载其它模块时，会执行被加载模块中的代码。
• 在使用require()加载用户自定义模块期间，可以省略.js 的后缀名，node 会自动补全。

2.3 node.js 中的模块作用域

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

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

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

代码：

console.log(module);

输出的结果如下：

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

在一个自定义模块中，默认情况下，module.exports 是个空对象。

// 向module. exports 对象上挂载 username属性module.exports. username = 'zs'

// 向module . exports 对象上挂载 sayHello方法module.exports.sayHello = function() {
	console.log( 'Hello! ')
}

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

// 1.向 module.exports 对象上挂载属username
exports.username = 'zs'
// 2.向 module. exports对象上挂载方法sayHello
exports.sayHello = function() {
	console.log( 'Hello!')
}

// 3.让 module.exports指向一个全新的对象
// 外界导入该模块时，module.exports指向的就是这个新的对象。
exports = (
	nickname: "小黑"，sayti() {
	console.log('Hi!')
	}
}

4.共享成员时的注意点
使用require()方法导入模块时，导入的结果，永远以module.exports指向的对象为准。

// 1.向 module.exports 对象上挂载属username
module.exports.username = 'zs'
// 2.向 module. exports对象上挂载方法sayHello
module.exports.sayHello = function() {
	console.log( 'Hello!')
}

// 3.让module.exports指向一个全新的对象
// 外界导入该模块时，module.exports指向的就是这个新的对象。
module.exports = (
	nickname: "小黑"，sayti() {
	console.log('Hi!')
	}
}

5.exports 和module.exports的使用误区
时刻谨记，require()模块时，得到的永远是module.exports指向的对象:

2.5 Node.js 中的模块化规范

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

CommonJS 规定:

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

3 npm 与包

3.1包

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

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

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

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

注意:

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

3.2 npm 初体验

1.格式化时间的传统做法

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

⒉格式化时间的高级做法

• 使用npm包管理工具，在项目中安装格式化时间的包moment
• 使用require(导入格式化时间的包
• 参考 moment的官方API文档对时间进行格式化

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

npm install 包的完整名称

上述的装包命令，可以简写成如下格式:

npm i 完整的包名称

4.初次装包后多了哪些文件
初次装包完成后，在项目文件夹下多一个叫做node_modules 的文件夹和package-lock.json 的配置文件。
node_modules文件夹用来存放所有已安装到项目中的包。require()导入第三方包时，就是从这个目录中查找并加载包。package-lockjson配置文件用来记录node_modules目录下的每一个包的下载信息，例如包的名字、版本号、下载地址等。
注意:程序员不要手动修改node modules 或package-lockjson文件中的任何代码，npm包管理工具会自动维护它们。

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

nmp i moment@2.22.2

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

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

3.3.3 包管理配置文件

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

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

1.多人协作的问题
遇到的问题:第三方包的体积过大，不方便团队成员之间共亨项目源代码。
解决方案:共享时剔除 node_modules

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

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

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

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

注意:

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

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

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

否则会报类似于下面的错误:

• Error: Cannot find module " moment"

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

//执行npm install 命令时，npm 包管理工具会先读取package.json 中的dependencies节点, 
//读取到记录的所有依赖包名称和版本号之后，npm包管理工具会把这些包一次性下载到项目中  
npm install

6.卸载包
可以运行npm uninstall命令，来卸载指定的包:

//使用npm uninstall具体的包名来卸载包
npm uninstall moment

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

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

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

// 安装指定的包，并记录到 devDependencies 节点中
npm i 包名 -D

// 注意:上述命令是简写形式，等价于下面完整的写法:
npm install 包名 --save-dev

☆ 判断是否放在devDependencies节点中，可以通过npm网站中的介绍，如下图，有红框标记部分的语句，则要放在devDependencies节点中。

3.3.4 解决下包速度慢的问题

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

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

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

3.切换npm的下包镜像源
下包的镜像源，指的就是下包的服务器地址

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

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

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

3.3.5 包的分类

1.项目包
那些被安装到项目的 node modules 目录中的包，都是项目包。
项目包又分为两类，分别是:

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

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

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

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

注意:

• 只有工具性质的包，才有全局安装的必要性。因为它们提供了好用的终端命令。
• 判断某个包是否需要全局安装后才能使用，可以参考官方提供的使用说明即可。
  
  3.i5ting_toc
  i5ting_toc是一个可以把 md文档转为 html 页面的小工具，使用步骤如下:

#将i5ting_ toc安装为全局包
npm install -g i5ting_toc
#调用i5ting_toc，轻松实现md转 html的功能
i5ting_toc -f 要转换的md文件路径+文件名 -o // -o代表转换完成后自动打开转换后的html页面

3.3.6 规范的包结构

在清楚了包的概念、以及如何下载和使用包之后，接下来，我们深入了解一下包的内部结构。
一个规范的包，它的组成结构，必须符合以下3点要求:

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

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

3.3.7 开发属于自己的包

439集待补

3.3.8 发布包

1.注册npm账号

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

4 模块的加载机制

4.1优先从缓存中加载

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

代码：
1.js:

console.log('OK')

2.js

require('./1.js')
require('./1.js')
require('./1.js')

执行结果：只会输出一遍OK

4.2 内置模块的加载机制

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

4.3 自定义模块的加载机制

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

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

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

4.4 第三方模块的加载机制

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

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

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

1. C:\Users\itheima\project\node_modules\tools
2. C:\Users\itheima\node_modules\itools
3. C:\Users\node_modules\itools
4. C:\node_modules\itools

4.5 目录作为模块

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

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