学习目标
- 能够说出模块化的好处
- 能够知道CommonJS规定了哪些内容
- 能够说出Node.js 中模块的三大分类各自是什么
- 能够使用npm管理包
- 能够了解什么是规范的包结构 能够了解模块的加载机制
- 模块化的基本概念
- Node,js 中模块化
- npm与包
- 模块的加载机制
一、模块化的基本概念
1.模块化的基本概念
1.1什么是模块化
模块化是指解决一个复杂问题时,自顶向下逐层把系统划分成若干模块的过程。对于整个系统来说,模块是可组合、分解和更换的单元。
2.编程领域中的模块化
编程领域中的模块化,就是遵守固定的规则,把一个大文件拆成独立并互相依赖的多个小模块
把代码进行模块化拆分的好处:
① 提高了代码的复用性
② 提高了代码的可维护性
③ 可以实现按需加载
1.2 模块化规范
模块化规范就是对代码进行模块化的拆分与组合时,需要遵守的那些规则。
例如:
使用什么样的语法格式来引用模块。在模块中使用什么样的语法格式向外暴露成员模块化规范的好处:大家都遵守同样的模块化规范写代码,降低了沟通的成本,极大方便了各个模块之间的相互调用,利人利己。
二、Node,js 中模块化
2.Node.js 中的模块化
2.1 Node.js 中模块的分类
Nodejs 中根据模块来源的不同,将模块分为了3大类,分别是:
- 内置模块 (内置模块是由 Node,js 官方提供的,例如fs、path、http 等)
- 自定义模块 (用户创建的每个.s 文件,都是自定义模块)
- 第三方模块(由第三方开发出来的模块,并非官方提供的内置模块,也不是用户创建的自定义模块,使用前需要先下载)
2.2 加载模块
使用强大的 require() 方法,可以加载需要的内置模块、用户自定义模块、第三方模块进行使用。例如:
// 1,加载内置的 fs 模块
const fs = require( 'fs' )
// 2.加载用户的自定义模块
const custom = require( ' ./custom.js' )
// 3,加载第三方模块(关于第三方模块的下载和使用,会在后面的课程中进行专门的讲解)
const moment = require('moment')
注意:使用require()方法加载其它模块时,会执行被加载模块中的代码
注意: 在使用 require 加载用户自定义模块期间 可以省略 .js 的后缀名
2.3Nodejs 中的模块作用域
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 指向的对象为准。
console.log(exports);
console.log(module.exports);
console.log(exports === module.exports); // true
4.exports和 module.exports 的使用误区
时刻谨记,require()模块时,得到的永远是 module.exports 指向的对象:
注意: 为了防止混乱,建议大家不要在同一个模块中同时使用exports和 module.exports
2.5 Nodejs 中的模块化规范
Node.js 遵循了 CommonJS 模块化规范,CommonJS 规定了模块的特性和各模块之间如何相互依赖.
CommonJS规定:
① 每个模块内部,module 变量代表当前模块
② module 变量是一个对象,它的 exports 属性 (即 module.exports) 是对外的接口。
③ 加载某个模块,其实是加载该模块的 module.exports 属性。require()方法用于加载模块
三、 npm与包
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 包管理T具),这个包管理工具随着 Node.js 的安装包一起被安装到了用户的电脑上。 大家可以在终端中执行 npm -v 命令,来查看自己电脑上所安装的 npm 包管理工具的版本号:
3.2 npm 初体验
1. 格式化时间的传统做法
- ① 创建格式化时间的自定义模块
- ② 定义格式化时间的方法创建补零函数
- ③ 从自定义模块中导出格式化时间的函数
- ④ 导入格式化时间的自定义模块
- ⑤ 调用格式化时间的函数
2.格式化时间的高级做法
① 使用 npm 包管理工具,在项目中安装格式化时间的包 moment
② 使用 require()导入格式化时间的包
③ 参考moment的官方API文档对时间进行格式化
const moment = require('moment')
const dt = moment().format('YYYY-MM-DD HH:mm:ss')
console.log(dt) // 输出 2022-12-07 14:23:48
3.在项目中安装包的命令
- 如果想在项目中安装指定名称的包,需要运行如下的命令:
npm install 包的完整名称
- 上述的装包命令,可以简写成如下格式
npm i 完整的包名称
4.初次装包后多了哪些文件
初次装包完成后,在项目文件夹下多一个叫做 node modules 的文件夹和 package-lockjson 的配置文件
其中:
node modules 文件夹用来存放所有已安装到项目中的包。require() 导入第三方包时,就是从这个目录中查找并加载包,package-lock;json 配置文件用来记录 node modules 目录下的每一个包的下载信息,例如包的名字、版本号、下载地址等
注意:程序员不要手动修改 node modules 或 package-lock;json 文件中的任何代码,npm 包管理工具会自动维护它们.
5.安装指定版本的包
默认情况下,使用 npm install 命令安装包的时候,会自动安装最新版本的包。如果需要安装指定版本的包,可以在包名之后,通过@ 符号指定具体的版本,例如:
npm i moment@2.22 .2
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 这个包管理配置文件:
作用: 在执行命令所处的目录中,快速新建 package.json 文件
npm init -y
注意:
①上述命令只能在英文的目录下成功运,所以,项目文件夹的名称一定要使用英文命名,不要使用中文,不能出现空格
② 运行npm install 命令安装包的时候,npm 包管理工具会自动把包的名称和版本号,记录到 package.json 中
4. dependencies
package,json 文件中,有一个 dependencies 节点,专门用来记录您使用 npm install命令安装了哪些包。
5.一次性安装所有的包
可以运行 npm install 命令 (或 npm i) 一次性安装所有的依赖包
1 // 执行 npm install 命令时, npm 包管理T具会先读取 package.json 中的 dependencies 节点
2 //读取到记录的所有依赖包名称和版本号之后,npm 包管理工具会把这些包一次性下载到项目中
3 npm install
6.卸载包
可以运行 npm uninstall 命令,来卸载指定的包:
1 // 使用 npm uninstall 具体的包名 来卸载包
2 npm uninstall moment
注意: npm uninstall 命令执行成功后,会把卸载的包,自动从 package,json 的 dependencies 中移除掉.
7. devDependencies 节点
如果某些包只在项目开发阶段会用到,在项目上线之后不会用到,则建议把这些包记录到devDependencies 节点中。与之对应的,如果某些包在开发和项目上线之后都需要用到,则建议把这些包记录到 dependencies 节点中
您可以使用如下的命令,将包记录到 devDependencies 节点中:
// 安装指定的包,并记录到 devDependencies 节点中
npm i 包名 -D
// 注意:上述命令是简写形式,等价于下面完整的写法:
npm install 包名 --save-dev
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.bakdu.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 的下包镜像源
- 下包的镜像源,指的就是下包的服务器地址
# 查看当前的下包镜像源
npm config get registry
# 将下包的镜像源切换为淘宝像源
npm config set registry=https://registry.npm.taobao.org/
//https://registry.npm.taobao.org/ 2022年12月8日11:08:39 最新淘宝镜像地址为 https://registry.npmmirror.com
# 检查镜像源是否下载成功
npm config get registry
4. nrm
为了更方便的切换下包的镜像源,我们可以安装 nrm 这个小工具,利用 nrm 提供的终端命令,可以快速查看和切换下包的镜像源。
// 过 npm 包管理器,将 nrm 安装为全局可用的工具
npm i nrm -g
// 查看所有可用的镜像源
nrm ls
// 将下包的镜像源切换为 taobao 镜像
nrm use taobao
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
PS: 只能使用在根目录C盘下的/ D盘下的文件不能转换 会报错 【个人经验】
3.6 规范的包结构
在清楚了包的概念、以及如何下载和使用包之后,接下来,我们深入了解一下包的内部结构。
一个规范的包,它的组成结构,必须符合以下3点要求
① 包必须以单独的目录而存在
② 包的顶级目录下要必须包含 package.json 这个包管理配置文件
③ package,json 中必须包含 name,version,main 这三个属性,分别代表包的名字、版本号、包的入口。
注意:以上3点要求是一个规范的包结构必须遵守的格式,关于更多的约束,可以参考如下网址
https://yarnpkg.com/zh-Hans/docs/package-json
3.7 开发属于自己的包
1.需要实现的功能 【转义字符,还原字符】
// 1.导入自己的包
const itheima = require( 'itehima-utils')
// ------- 功能2: 转义 HTML 中的特殊字符------.
const htmlStr = '<h1 style="color: red;">你好! ©<span>小黄! </span></h1>'
const str = itheima.htmlEscape(htmIStr)
// <h1 style="color: red;">你好! &copy;<span>小黄! </span></h1>8 console.log(str)
// 1.导入自己的包
const itheima = require( 'itehima-utils')
// ------- 功能3: 还原 HTML 中的特殊字符-------
const rawHTML = itheima.htmlUnEscape(str)
// 输出 <h1 style="color: red;">你好! ©<span>小黄! </span></h1>
console.log(rawHTML)
2.初始化包的基本结构
① 新建 itheima-tools 文件夹,作为包的根目录
② 在 itheima-tools 文件夹中,新建如下三个文件
- package.json (包管理配置文件)
- index.js (包的入口文件)
- README.md (包的说明文档)
7.将不同的功能进行模块化拆分
① 将格式化时间的功能,拆分到 src -> dateFormatjs 中
② 将处理 HTML 字符串的功能,拆分到 src -> htmlEscape.js 中在index.js中,
③ 导入两个模块,得到需要向外共享的方法在index.js 中,
④ 使用 module.exports 把对应的方法共享出去
8.编写包的说明文档
包根目录中的 README.md 文件,是包的使用说明文档。通过它,我们可以事先把包的使用说明,以 markdown 的格式写出来,方便用户参考
README 文件中具体写什么内容,没有强制性的要求,只要能够清晰地把包的作用、用法、注意事项等描述清楚即可我们所创建的这个包的 README.md 文档中,会包含以下6 项内容:
安装方式、导入方式、格式化时间、转义HTML中的特殊字符、还原 HTML中的特殊字符、开源协议
3.8发布包
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 itheima-utils --force
注意:
① npm unpublish 命令只能删除 72 小时以内发布的包
② npm unpublish 删除的包,在24 小时内不允许重复发布
③ 发布包的时候要慎重,尽量不要往 npm 上发布没有意义的包!
四、模块的加载机制
4.模块的加载机制
4.1优先从缓存中加载
模块在第一次加载后会被缓存。 这也意味着多次调用 require() 不会导致模块的代码被执行多次注意:不论是内置模块、用户自定义模块、还是第三方模块,它们都会优先从缓存中加载,从而提高模块的加载效率。
4.2内置模块的加载机制
内置模块是由 Node.js 官方提供的模块,内置模块的加载优先级最高。e例如,require(fs)始终返回内置的 fs 模块,即使在 node modules 目录下有名字相同的包也叫做fs.
4.3自定义模块的加载机制
使用 require() 加载自定义模块时,必须指定以./或/开头的路径标识符在加载自定义模块时,如果没有指定./或.这样的路径标识符,则node 会把它当作内置模块或第三方模块进行加载
同时,在使用 require() 导入自定义模块时,如果省略了文件的扩展名,则 Node.s 会按顺序分别尝试加载以下的文件
按照确切的文件名进行加载
① 补全.js 扩展名进行加载
② 补全.json 扩展名进行加载
③ 补全.node 扩展名进行加载
④ 加载失败,终端报错
4.4 第三方模块的加载机制
如果传递给 require() 的模块标识符不是一个内置模块,也没有以/或/开头则 Noejs 会从当前模块的目录开始,尝试从/node modules 文件夹中加载第三方模块。
如果没有找到对应的第三方模块,则移动到再上一层父目录中,进行加载,直到文件系统的根目录。
例如,假设在 C:Users\itheima\projedfoojs’ 文件里调用了 require(tools),则 Nodejs 会按以下顺序查找:
C:\Users\itheima\project\node modules tools
2C:\Usersitheima\node modules tools
C:\Users\node modules tools3
C:\node modules tools4
4.5目录作为模块
当把目录作为模块标识符,传递给 require0进行加载的时候,有三种加载方式:
① 在被加载的目录下查找一个叫做 package,json 的文件,并寻找 main 属性,作为 require() 加载的入口
② 如果目录里没有 package.json 文件,或者 main 入口不存在或无法解析,则 Node.js 将会试图加载目录下的 index.js 文件
③ 如果以上两步都失败了则 Nodejs 会在终端打印错误消息,报告模块的缺失: Error: Cannot find modulexx!