目录
1. 模块化的基本概念
模块化
是指解决一个
复杂问题
时,自顶向下逐层
把系统划分成若干模块的过程
。对于整个系统来说,
模块是可组合、分解和更换的单元
。
编程领域中的模块化,就是
遵守固定的规则
,把一个
大文件
拆成
独立并互相依赖
的
多个小模块
。 把代码进行模块化拆分的好处:
① 提高了代码的
复用性
② 提高了代码的
可维护性
③ 可以实现
按需加载
2. Node.js 中的模块化
2.1 Node.js 中模块的分类
Node.js 中根据模块来源的不同,将模块分为了 3 大类,分别是:
- 内置模块(内置模块是由 Node.js 官方提供的,例如 fs、path、http 等)
- 自定义模块(用户创建的每个 .js 文件,都是自定义模块)
- 第三方模块(由第三方开发出来的模块,并非官方提供的内置模块,也不是用户创建的自定义模块,使用前需要先下载)
2.2 加载模块
使用强大的
require()
方法,可以加载需要的
内置模块
、
用户自定义模块
、
第三方模块
进行使用。例如:
注意 :使用 require() 方法加载其它模块时,会执行被加载模块中的代码。
2.3 Node.js 中的模块作用域
1. 什么是 模块作用域
和
函数作用域
类似,在自定义模块中定义的
变量
、
方法
等成员,
只能在当前模块内被访问
,这种
模块级别的访问限制
,叫做
模块
作用域
。
2. 模块作用域的 好处
防止了全局变量污染的问题
2.4 向外共享模块作用域中的成员
1. module 对象
在每个 .js 自定义模块中都有一个 module 对象,它里面
存储了和当前模块有关的信息
,打印如下:
2. module.exports 对象
在自定义模块中,可以使用 module.exports 对象,将模块内的成员共享出去,供外界使用。
外界用
require() 方法
导入自定义模块时,得到的就是 module.exports 所指向的对象。
3. 共享成员时的 注意点
使用 require() 方法导入模块时,导入的结果,
永远以 module.exports 指向的对象为准
。
4. exports 对象
由于 module.exports 单词写起来比较复杂,为了简化向外共享成员的代码,Node 提供了
exports
对象。
默认情况 下
,
exports 和 module.exports 指向同一个对象
。最终共享的结果,还是以module.exports 指向的对象为准。
4. exports 和 module.exports 的使用误区
时刻谨记,require() 模块时,得到的永远是
module.exports
指向的对象:
注意:为了防止混乱,建议大家不要在同一个模块中同时使用 exports 和 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/ 服务器上下载自己需要的包
5. 如何下载包
npm, Inc. 公司
提供了一个包管理工具,我们可以使用这个包管理工具,从
https://registry.npmjs.org/
服务器把需要 的包下载到本地使用。
这个包管理工具的名字叫做
Node Package Manager
(简称
npm 包管理工具
),这个包管理工具随着 Node.js 的安装包一起被安装到了用户的电脑上。
可以在终端中执行
npm -v
命令,来查看自己电脑上所安装的 npm 包管理工具的版本号:
3.2 npm 初体验
1. 格式化时间的传统做法
2. 格式化时间的高级做法
① 使用 npm 包管理工具,在项目中安装格式化时间的包 moment
② 使用 require() 导入格式化时间的包
③ 参考 moment 的官方 API 文档对时间进行格式化
3. 在项目中安装包的命令
如果想在项目中安装指定名称的包,需要运行如下的命令:
上述的装包命令,可以简写成如下格式:
4. 初次装包后
多了哪些文件
初次装包完成后,在项目文件夹下多一个叫做
node_modules
的文件夹和
package-lock.json
的配置文件。
其中:
node_modules 文件夹
用来
存放所有已安装到项目中的包
。require() 导入第三方包时,就是从这个目录中查找并加载包。
package-lock.json 配置文件
用来
记录 node_modules 目录下的每一个包的下载信息
,例如包的名字、版本号、下载地址等。
注意:程序员不要手动修改 node_modules 或 package-lock.json 文件中的任何代码,npm 包管理工具会自动维护它们。
5. 安装指定版本的包
默认情况下,使用 npm install 命令安装包的时候,
会自动安装最新版本的包
。如果需要安装指定版本的包,可以在包
名之后,通过
@ 符号
指定具体的版本,例如:
6. 包的
语义化版本规范
包的版本号是以“点分十进制”形式进行定义的,总共有三位数字,例如
2.24.0
其中每一位数字所代表的的含义如下:
第1位数字:
大版本
第2位数字:
功能版本
第3位数字:Bug修复版本
版本号提升的规则
:只要前面的版本号增长了,则后面的版本号
归零
。
3.3 包管理配置文件
npm 规定,在
项目根目录
中,
必须
提供一个叫做
package.json
的包管理配置文件。用来记录与项目有关的一些配置
信息。例如:
- 项目的名称、版本号、描述等
- 项目中都用到了哪些包
- 哪些包只在开发期间会用到
- 那些包在开发和部署时都需要用到
1. 多人协作的问题
2. 如何记录项目中安装了哪些包
在
项目根目录
中,创建一个叫做
package.json
的配置文件,即可用来记录项目中安装了哪些包。从而方便剔除
node_modules 目录之后,在团队成员之间共享项目的源代码。
注意 :今后在项目开发中,一定要把 node_modules 文件夹,添加到 .gitignore 忽略文件中。
3. 快速创建 package.json
npm 包管理工具提供了一个
快捷命令
,可以在
执行命令时所处的目录中
,快速创建 package.json 这个包管理
配置文件:
注意:① 上述命令 只能在英文的目录下成功运行 !所以,项目文件夹的名称一定要使用英文命名, 不要使用中文 , 不能出现空格 。② 运行 npm install 命令安装包的时候,npm 包管理工具会自动把 包的名称 和 版本号 ,记录到 package.json 中。
4.
dependencies
节点
5.
一次性
安装所有的包
当我们拿到一个
剔除了 node_modules
的项目之后,需要先把所有的包下载到项目中,才能将项目运行起来。
否则会报类似于下面的错误:
可以运行
npm install
命令(或
npm i
)一次性安装所有的依赖包:
6. 卸载包
可以运行
npm uninstall
命令,来卸载指定的包:
注意:npm uninstall 命令执行成功后,会把卸载的包,自动从 package.json 的 dependencies 中移除掉。
7.
devDependencies
节点
如果某些包
只在项目开发阶段
会用到,在
项目上线之后不会用到
,则建议把这些包记录到 devDependencies 节点中。
与之对应的,如果某些包在
开发
和
项目上线之后
都需要用到,则建议把这些包记录到 dependencies 节点中。
您可以使用如下的命令,将包记录到 devDependencies 节点中:
3.4 解决下包速度慢的问题
1. 为什么下包速度慢
在使用 npm 下包的时候,默认从国外的
https://registry.npmjs.org/
服务器进行下载,此时,网络数据的传输需要经
过漫长的海底光缆
,
因此下包速度会很慢。
扩展阅读 -
海底光缆
:
- https://baike.baidu.com/item/%E6%B5%B7%E5%BA%95%E5%85%89%E7%BC%86/4107830
- https://baike.baidu.com/item/%E4%B8%AD%E7%BE%8E%E6%B5%B7%E5%BA%95%E5%85%89%E7%BC%
- 86/10520363
- https://baike.baidu.com/item/APG/23647721?fr=aladdin
2. 淘宝 NPM 镜像服务器
3.
切换
npm 的下包镜像源
下包的镜像源,指的就是
下包的服务器地址
。
4. nrm
为了更方便的切换下包的镜像源,我们可以安装
nrm
这个小工具,利用 nrm 提供的终端命令,可以快速查看和切换下 包的镜像源。
3.5 包的分类
使用 npm 包管理工具下载的包,共分为两大类,分别是:
- 项目包
- 全局包
1. 项目包
那些被安装到
项目
的
node_modules 目录
中的包,都是项目包。
项目包又分为两类,分别是:
- 开发依赖包(被记录到 devDependencies 节点中的包,只在开发期间会用到)
- 核心依赖包(被记录到 dependencies 节点中的包,在开发期间和项目上线之后都会用到)
2. 全局包
在执行 npm install 命令时,如果提供了
-g
参数,则会把包安装为
全局包
。
全局包会被安装到
C:\Users\用户目录\AppData\Roaming\npm\node_modules
目录下。
注意:① 只有 工具性质的包 ,才有全局安装的必要性。因为它们提供了好用的终端命令。② 判断某个包是否需要全局安装后才能使用,可以 参考官方提供的使用说明 即可。
3. i5ting_toc
i5ting_toc 是一个可以把 md 文档转为 html 页面的小工具,使用步骤如下:
3.6 规范的包结构
在清楚了包的概念、以及如何下载和使用包之后,接下来,我们深入了解一下
包的内部结构
。
一个规范的包,它的组成结构,必须符合以下 3 点要求:
① 包必须以
单独的目录
而存在
② 包的顶级目录下要必须包含
package.json
这个包管理配置文件
③ package.json 中必须包含
name
,
version
,
main
这三个属性,分别代表
包的名字
、
版本号
、
包的入口
。
注意:以上 3 点要求是一个规范的包结构必须遵守的格式,关于更多的约束,可以参考如下网址:https://yarnpkg.com/zh-Hans/docs/package-json
4. 模块的加载机制
4.1 优先从缓存中加载
模块在第一次加载后会被缓存
。 这也意味着多次调用
require()
不会导致模块的代码被执行多次。
注意:不论是内置模块、用户自定义模块、还是第三方模块,它们都会优先从缓存中加载,从而 提高模块的加载效率 。
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 会按以下顺序查找:
①
C:\Users\itheima\project\
node_modules\
tools
②
C:\Users\itheima\
node_modules\
tools
③
C:\Users\
node_modules\
tools
④
C:\
node_modules\
tools
4.5 目录作为模块
当把目录作为模块标识符,传递给 require() 进行加载的时候,有三种加载方式:
① 在被加载的目录下查找一个叫做 package.json 的文件,并寻找 main 属性,作为 require() 加载的入口
② 如果目录里没有 package.json 文件,或者 main 入口不存在或无法解析,则 Node.js 将会试图加载目录下的
index.js 文件
。
③ 如果以上两步都失败了,则 Node.js 会在终端打印错误消息,报告模块的缺失:Error: Cannot find module 'xxx