基于
02_模块化.pdf整理
适合作为 Node.js 模块化、npm 与模块加载机制的入门笔记。
这份 PDF 主要分成四部分:
如果说 day1 讲的是“Node.js 能做什么”,那么这份 day2 讲的就是:
Node.js 项目中的代码和依赖,应该如何被拆分、共享、安装和加载。
模块化的本质是:
在解决复杂问题时,把系统自顶向下拆分成多个小模块,每个模块都承担独立职责。
对于整个系统来说,模块应该具备这些特点:
在编程领域,模块化通常指:
模块化的好处:
一句话理解:
大项目不是一口气写成的,而是由很多职责单一的小模块组合起来的。
模块化规范,就是模块拆分与组合时要遵守的一套规则。
例如:
它的意义是:
根据来源不同,Node.js 中的模块分为三类:
由 Node.js 官方提供,例如:
fspathhttp用户自己创建的 .js 文件。
例如:
// utils.js
function add(a, b) {
return a + b
}
由第三方开发并发布的模块,不属于 Node.js 官方,也不是你自己写的,需要先安装再使用。
例如:
momentexpresslodashrequire()Node.js 使用 require() 来加载模块。
它可以加载:
例如:
const fs = require('fs')
const path = require('path')
const custom = require('./custom.js')
课程特别提醒:
使用
require()加载模块时,会执行被加载模块中的代码。
例如:
// a.js
console.log('a 模块被执行了')
require('./a.js')
运行时就会输出:
a 模块被执行了
这说明:
require() 不只是“拿到一个对象”在自定义模块中定义的变量、方法等成员,只能在当前模块内部访问。
这种“模块级别的访问限制”就叫:
模块作用域
例如:
// test.js
const username = 'zs'
function sayHi() {
console.log('hello')
}
外部文件不能直接访问 username 和 sayHi(),除非它们被显式导出。
最大的作用是:
防止全局变量污染。
也就是说:
module 对象在每个 .js 自定义模块中,Node.js 都提供了一个 module 对象。
这个对象里面保存了与当前模块相关的信息。
module.exports如果希望把模块内部的成员共享出去给其他文件用,可以使用:
module.exports
外界通过 require() 拿到的,实际上就是:
module.exports指向的对象
示例:
// utils.js
const username = 'zs'
function sayHi() {
console.log('Hello!')
}
module.exports.username = username
module.exports.sayHi = sayHi
// app.js
const m = require('./utils')
console.log(m)
课程强调:
require()导入模块时,得到的结果永远以module.exports指向的对象为准。
这句话非常重要,因为它决定了“最终导出结果到底是谁”。
exports 对象exports因为 module.exports 写起来比较长,Node.js 又提供了一个更简短的对象:
exports
默认情况下:
exports === module.exports
它们一开始指向同一个对象。
exports.username = 'zs'
exports.sayHi = function () {
console.log('Hello!')
}
最终共享结果,仍然以 module.exports 为准。
也就是说:
exports.xxx 上挂属性,本质上等于往 module.exports.xxx 上挂属性exports = {},不会真正改变最终导出结果例如:
exports = {
username: 'zs'
}
这样通常不会达到预期。
课程建议:
不要在同一个模块里同时混用
exports和module.exports。
实战建议:
exports.xxx = ...module.exports = {...}Node.js 遵循的是:
CommonJS 模块化规范
CommonJS 的核心约定:
module 对象module.exports 是对外接口require() 用来加载模块module.exports你可以把它总结成一句话:
导出靠
module.exports,导入靠require()。
在 Node.js 里:
第三方模块 = 包(package)
也就是说,“第三方模块”和“包”其实是一个东西,只是叫法不同。
包由第三方开发者或团队编写,并上传到 npm 平台供大家使用。
两个常见地址:
https://www.npmjs.com/https://registry.npmjs.org/因为 Node.js 内置模块提供的更多是底层能力。
而包通常是在这些底层能力基础上的进一步封装,提供:
课程举的类比很形象:
包和内置模块的关系,有点像 jQuery 和浏览器原生 API 的关系。
npm 全称:
Node Package Manager
它是 Node.js 自带的包管理工具,用于:
查看版本:
npm -v
课程中用“格式化时间”举了例子。
自己写一个时间格式化模块,需要:
直接安装成熟的第三方包,例如:
moment然后通过 require() 导入,调用官方 API 完成格式化。
这正体现了包的价值:
少重复造轮子。
npm install 包名
简写:
npm i 包名
例如:
npm install moment
npm i moment
npm install 包名@版本号
例如:
npm i moment@2.29.1
第一次安装包后,项目里通常会多出两个内容:
node_modules用来存放所有安装到项目中的包。
当你:
require('moment')
Node.js 就会去 node_modules 中查找这个包。
package-lock.json记录安装依赖的详细信息,例如:
课程强调:
node_modulespackage-lock.json它们应该交给 npm 自动维护。
包的版本号通常是三位数字:
x.y.z
例如:
2.24.0
它们分别表示:
升级规则:
例如:
1.2.3 -> 1.3.01.2.3 -> 2.0.0package.json 包管理配置文件当项目安装了很多包之后,node_modules 会非常大。
课程里的例子说明:
多人协作时,如果直接把整个 node_modules 传来传去,会很低效。
因此需要一个文件,记录:
这个文件就是:
package.json
npm init -y
课程提醒:
package.jsondependenciesdependencies 用来记录:
项目运行时也需要的依赖
例如:
{
"dependencies": {
"moment": "^2.29.1"
}
}
devDependenciesdevDependencies 用来记录:
只在开发阶段使用、上线后不需要的依赖
比如:
安装到开发依赖中通常用:
npm install 包名 -D
或:
npm i 包名 --save-dev
当别人给你一个没有 node_modules 的项目时,只要有 package.json,就可以直接执行:
npm install
或:
npm i
npm 会自动把所有依赖装回来。
npm uninstall 包名
特点:
dependencies 中移除课程特别提醒:
node_modules一定要加入.gitignore
因为:
npm 默认从国外官方源下载包:
https://registry.npmjs.org/由于网络链路问题,速度可能比较慢。
课程中介绍了淘宝镜像服务器,它会同步 npm 官方源的数据,在国内提供更快的下载速度。
nrm为了方便切换镜像源,可以安装:
nrm它可以帮助你:
使用 npm 下载的包,分成两类:
安装到当前项目的 node_modules 中。
又分两类:
记录在:
devDependencies只在开发阶段使用。
记录在:
dependencies开发和上线后都需要。
如果安装时使用 -g:
npm install 包名 -g
就会安装为全局包。
全局包的特点:
课程强调:
只有工具性质的包,才更适合全局安装。
一个规范的包,至少要满足这三个条件:
package.jsonpackage.json 中至少要有:
nameversionmain它们分别表示:
这说明一个包不是“随便几个 js 文件”,而是一个有规范入口和配置的完整单元。
课程里设计了一个练习包,需要实现三个功能:
例如创建:
package.jsonindex.jsREADME.md课程建议把不同功能拆到 src/ 中,例如:
src/dateFormat.jssrc/htmlEscape.js然后在入口 index.js 中统一导入并导出。
这种做法体现的思想很重要:
包本身也应该模块化。
README 是包的使用说明书。
一个合格的 README 通常至少说明:
流程大致是:
npm login
课程特别提醒:
发布包前,必须切换到 npm 官方源,否则可能发布失败。
进入包根目录后执行:
npm publish
注意:
npm unpublish 包名 --force
但有很多限制:
课程给出的态度也很明确:
发布包要慎重,不要随便往 npm 上发布没有意义的包。
这是这份 PDF 最容易出面试题的部分。
模块第一次加载后会被缓存。
这意味着:
require() 同一个模块这个机制适用于:
作用是:
提高模块加载效率。
内置模块加载优先级最高。
例如:
require('fs')
永远优先得到 Node.js 自带的 fs 模块。
即使你本地某个地方有一个同名第三方包,也不会抢过内置模块。
加载自定义模块时,必须加:
./../例如:
require('./utils')
如果不写,Node.js 会把它当成:
去查找。
如果省略扩展名,Node.js 会按顺序尝试:
.js.json.node这点很实用,因为很多时候我们写:
require('./utils')
实际上 Node.js 可能最终加载的是:
./utils.js
如果 require() 里的标识符:
./ 或 ../ 开头那么 Node.js 会把它当成第三方模块来查找。
查找规则是:
node_modules这个机制解释了为什么:
require() 到当 require() 传入的是一个目录时,Node.js 会按这个顺序尝试:
package.jsonmain 字段作为入口package.json,或 main 无法解析,则尝试 index.js也就是说,一个目录能否被 require(),关键看:
main 是否正确index.js如果只看这份 PDF,最少要掌握这些内容:
require() 会执行模块代码module.exportsexports 和 module.exports 的关系package.jsondependencies 和 devDependenciesnode_modules 向上查找package.json 的 main 或 index.jsmodule.exports = {
username: 'zs',
sayHi() {
console.log('Hello')
}
}
const m = require('./utils')
npm install 包名
npm i 包名
npm i 包名@版本号
npm i 包名 -D
npm uninstall 包名
package.jsonnpm init -y
npm install
建议你按这个顺序自己练一遍:
require() 导入module.exports 和 exportsnpm init -ypackage.json、package-lock.json、node_modules这样你会真正理解“模块化”不是背概念,而是组织代码和管理依赖的方式。
这份 PDF 的核心,可以总结成一句话:
模块化解决的是代码如何拆分与共享,npm 解决的是依赖如何安装与管理,加载机制决定了 Node.js 到底会把哪个模块加载进来。
正在加载评论...