目录
1. 模块化的基本概念
1.1 什么是模块化
![](https://i-blog.csdnimg.cn/blog_migrate/68c7a66e80e542e1161d58a84dbeb8ac.png)
![](https://i-blog.csdnimg.cn/blog_migrate/bcb5c57d64afaf16cc7c83bf889b2481.png)
编程领域中的模块化,就是遵守固定的规则,把一个大文件拆成独立并互相依赖的多个小模块 把代码进行模块化拆分的好处
- ① 提高了代码的复用性
- ② 提高了代码的可维护性
- ③ 可以实现按需加载
1.2 模块化规范
- 使用什么样的语法格式来引用模块
- 在模块中使用什么样的语法格式向外暴露成员
2. Node.js 中的模块化
2.1 Node.js 中模块的分类
- Node.js 中根据模块来源的不同,将模块分为了 3 大类,分别是:
- 内置模块(内置模块是由 Node.js 官方提供的,例如 fs、path、http 等)
- 自定义模块(用户创建的每个 .js 文件,都是自定义模块)
- 第三方模块(由第三方开发出来的模块,并非官方提供的内置模块,也不是用户创建的自定义模块,使用前需要先下载)
2.2 加载模块
使用强大的 require() 方法,可以加载需要的内置模块、用户自定义模块、第三方模块进行使用。
注意:使用 require() 方法加载其它模块时,会执行被加载模块中的代码。
2.3 Node.js 中的模块作用域
![](https://i-blog.csdnimg.cn/blog_migrate/ac68dc720b3be4f06eb1423c7e5795e5.png)
2. 模块作用域的好处
防止了全局变量污染的问题
2.4 向外共享模块作用域中的成员
1. module 对象
在每个 .js 自定义模块中都有一个 module 对象,它里面存储了和当前模块有关的信息,打印如下
2. module.exports 对象
![](https://i-blog.csdnimg.cn/blog_migrate/c527038ee7de21e798bdb70dda877b5a.png)
4. exports 对象
![](https://i-blog.csdnimg.cn/blog_migrate/c1ea56d868fd451927a13f0aa0013647.png)
4. exports 和 module.exports 的使用误区
时刻谨记,require() 模块时,得到的永远是 module.exports 指向的对象
注意:为了防止混乱,建议大家不要在同一个模块中同时使用 exports 和 module.exports
2.5 Node.js 中的模块化规范
Node.js 遵循了 CommonJS 模块化规范,CommonJS 规定了模块的特性和各模块之间如何相互依赖。
- ① 每个模块内部,module 变量代表当前模块。
- ② module 变量是一个对象,它的 exports 属性(即 module.exports)是对外的接口。
- ③ 加载某个模块,其实是加载该模块的 module.exports 属性。require() 方法用于加载模块。
3. npm与包
3.1 包
1. 什么是包
Node.js 中的第三方模块又叫做包
就像电脑和计算机指的是相同的东西,第三方模块和包指的是同一个概念,只不过叫法不同
2. 包的来源
![](https://i-blog.csdnimg.cn/blog_migrate/596f23b6a449f29965a4d2a53373d123.png)
3.2 npm 初体验
![](https://i-blog.csdnimg.cn/blog_migrate/0947deb16692a2f8c5e63fbdae9921e6.png)
//定义格式化时间的方法
function dateFormeat(dataStr) {
const dt = new Date(dataStr)
const y = dt.getFullYear()
const m = padZero(dt.getMonth() + 1)
const d = padZero(dt.getDate())
const hh = padZero(dt.getHours())
const mm = padZero(dt.getMinutes())
const ss = padZero(dt.getSeconds())
return `${y}-${m}-${d} ${hh}:${mm}:${ss}`
}
//定义补零的函数
function padZero(n) {
return n > 9 ? n : '0' + n
}
module.exports = {
dateFormeat
}
//-------------------------------------
//导入自定义的格式化时间模块
const TIME = require('./15')
// 调用方法进行时间格式化
const dt = new Date()
console.log(dt);
const newDt = TIME.dateFormeat(dt)
console.log(newDt);
- ① 使用 npm 包管理工具,在项目中安装格式化时间的包 moment
- ② 使用 require() 导入格式化时间的包
- ③ 参考 moment 的官方 API 文档对时间进行格式化
3. 在项目中安装包的命令
如果想在项目中安装指定名称的包,需要运行如下的命令:
上述的装包命令,可以简写成如下格式:
- node_modules 文件夹用来存放所有已安装到项目中的包。require() 导入第三方包时,就是从这个目录中查找并加载包。
- package-lock.json 配置文件用来记录 node_modules 目录下的每一个包的下载信息,例如包的名字、版本号、下载地址等。
注意:程序员不要手动修改 node_modules 或 package-lock.json 文件中的任何代码,npm 包管理工具会自动维护它们。
![](https://i-blog.csdnimg.cn/blog_migrate/aea4a351a81b137eb4a069d25dba56ef.png)
- 第1位数字:大版本
- 第2位数字:功能版本
- 第3位数字:Bug修复版本
3.3 包管理配置文件
- 项目的名称、版本号、描述等
- 项目中都用到了哪些包
- 哪些包只在开发期间会用到
- 那些包在开发和部署时都需要用到
![](https://i-blog.csdnimg.cn/blog_migrate/72fdc0e3db5df235b1e0d05038a2068c.png)
2. 如何记录项目中安装了哪些包
- ① 上述命令只能在英文的目录下成功运行!所以,项目文件夹的名称一定要使用英文命名,不要使用中文,不能出现空格。
- ② 运行 npm install 命令安装包的时候,npm 包管理工具会自动把包的名称和版本号,记录到 package.json 中
![](https://i-blog.csdnimg.cn/blog_migrate/6d6649fa11852d4b5c1210dc1e04ee02.png)
![](https://i-blog.csdnimg.cn/blog_migrate/abed62fc229827ac3bc89417ab4c223a.png)
可以运行 npm install 命令(或 npm i)一次性安装所有的依赖包:
6. 卸载包
可以运行 npm uninstall 命令,来卸载指定的包:
注意:npm uninstall 命令执行成功后,会把卸载的包,自动从 package.json 的 dependencies 中移除掉。
![](https://i-blog.csdnimg.cn/blog_migrate/d7090340c91aa2be2c9e8b813e202c2c.png)
3.4 解决下包速度慢的问题
- 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%8%89%E7%BC%86/10520363
- https://baike.baidu.com/item/APG/23647721?fr=aladdin
2. 淘宝 NPM 镜像服务器
3. 切换 npm 的下包镜像源
下包的镜像源,指的就是下包的服务器地址。
4. nrm
![](https://i-blog.csdnimg.cn/blog_migrate/bedc08c28f083248785c12be52b9ec09.png)
3.5 包的分类
- 开发依赖包(被记录到 devDependencies 节点中的包,只在开发期间会用到)
- 核心依赖包(被记录到 dependencies 节点中的包,在开发期间和项目上线之后都会用到)
2. 全局
![](https://i-blog.csdnimg.cn/blog_migrate/15f947482c0ead9de2865dc76363f29e.png)
注意:
![](https://i-blog.csdnimg.cn/blog_migrate/06585ae1e042a8bfafaad6773ac48557.png)
3.6 规范的包结构
在清楚了包的概念、以及如何下载和使用包之后,接下来,我们深入了解一下包的内部结构
注意:以上 3 点要求是一个规范的包结构必须遵守的格式,关于更多的约束,可以参考如下网址: https://yarnpkg.com/zh-Hans/docs/package-json
3.7 开发属于自己的包
1. 需要实现的功能
- ① 格式化日期
- ② 转义 HTML 中的特殊字符
- ③ 还原 HTML 中的特殊字符
1. 需要实现的功能
2. 初始化包的基本结构
- package.json (包管理配置文件)
- index.js (包的入口文件)
- README.md (包的说明文档)
3. 初始化 package.json
关于更多 license 许可协议相关的内容,可参考 https://www.jianshu.com/p/86251523e898
4. 在 index.js 中定义格式化时间的方法
5. 在 index.js 中定义转义 HTML 的方法
6. 在 index.js 中定义还原 HTML 的方法
7. 将不同的功能进行模块化拆分
- ① 将格式化时间的功能,拆分到 src -> dateFormat.js 中
- ② 将处理 HTML 字符串的功能,拆分到 src -> htmlEscape.js 中
- ③ 在 index.js 中,导入两个模块,得到需要向外共享的方法
- ④ 在 index.js 中,使用 module.exports 把对应的方法共享出去
8. 编写包的说明文档
3.8 发布包
- ① 访问 https://www.npmjs.com/ 网站,点击 sign up 按钮,进入注册用户界面
- ② 填写账号相关的信息:Full Name、Public Email、Username、Password
- ③ 点击 Create an Account 按钮,注册账号
- ④ 登录邮箱,点击验证链接,进行账号的验证
2. 登录 npm 账号
npm 账号注册完成后,可以在终端中执行 npm login 命令,依次输入用户名、密码、邮箱后,即可登录成功。
3. 把包发布到 npm 上
将终端切换到包的根目录之后,运行 npm publish 命令,即可将包发布到 npm 上(注意:包名不能雷同)
4. 删除已发布的包
运行 npm unpublish 包名 --force 命令,即可从 npm 删除已发布的包。
注意:
- ① npm unpublish 命令只能删除 72 小时以内发布的包
- ② npm unpublish 删除的包,在 24 小时内不允许重复发布
- ③ 发布包的时候要慎重,尽量不要往 npm 上发布没有意义的包!
4. 模块的加载机制
4.1 优先从缓存中加载
4.2 内置模块的加载机制
4.3 自定义模块的加载机制
- ① 按照确切的文件名进行加载
- ② 补全 .js 扩展名进行加载
- ③ 补全 .json 扩展名进行加载
- ④ 补全 .node 扩展名进行加载
- ⑤ 加载失败,终端报错
4.4 第三方模块的加载机制
- ① C:\Users\itheima\project\node_modules\tools
- ② C:\Users\itheima\node_modules\tools
- ③ C:\Users\node_modules\tools
- ④ C:\node_modules\tools
4.5 目录作为模块
- ① 在被加载的目录下查找一个叫做 package.json 的文件,并寻找 main 属性,作为 require() 加载的入口
- ② 如果目录里没有 package.json 文件,或者 main 入口不存在或无法解析,则 Node.js 将会试图加载目录下的 index.js 文件。
- ③ 如果以上两步都失败了,则 Node.js 会在终端打印错误消息,报告模块的缺失:Error: Cannot find module 'xxx