1_认识模块化开发
1.1_什么是模块化?
- 事实上模块化开发最终的目的是将程序划分成一个个小的结构;
- 这个结构中编写属于自己的逻辑代码,有自己的作用域,定义变量名词时不会影响到其他的结构;
- 这个结构可以将自己希望暴露的变量、函数、对象等导出给其结构使用;
- 也可以通过某种方式,导入另外结构中的变量、函数、对象等;
上面说提到的结构,就是模块;按照这种结构划分开发程序的过程,就是模块化开发的过程;
不论JavaScript现在发展的有多好,它都有很多的缺陷:
- 比如var定义的变量作用域问题;
- 比如JavaScript的面向对象并不能像常规面向对象语言一样使用class;
- 比如JavaScript没有模块化的问题;
1.2_模块化的历史
在网页开发的早期,Brendan Eich开发JavaScript仅仅作为一种脚本语言,做一些简单的表单验证或动画实现等,那个时候代码还是很少的:
- 这个时候只需JavaScript代码写到
<script>
标签中即可; - 并没有必要放到多个文件中来编写。通常来说 JavaScript 程序的长度只有一行。
但是随着前端和JavaScript的快速发展,JavaScript代码变得越来越复杂了:
- ajax的出现,前后端开发分离,意味着后端返回数据后,需要通过JavaScript进行前端页面的渲染;
- SPA的出现,前端页面变得更加复杂:包括前端路由、状态管理等等一系列复杂的需求需要通过JavaScript来实现;
- 包括Node的实现,JavaScript编写复杂的后端程序,没有模块化是致命的硬伤;
所以,模块化已经是JavaScript一个非常迫切的需求:
- 但是JavaScript本身,直到ES6(2015)才推出了自己的模块化方案;
- 在此之前,为了让JavaScript支持模块化,涌现出了很多不同的模块化规范:AMD、CMD、CommonJS等;
1.3_没有模块化带来的问题
早期没有模块化带来了很多的问题:比如命名冲突的问题。这个问题可以用:立即函数调用表达式(IIFE :Immediately Invoked Function Expression)来解决。
但是,其实带来了新的问题:
- 第一,必须记得每一个模块中返回对象的命名,才能在其他模块使用过程中正确的使用;
- 第二,代码写起来混乱不堪,每个文件中的代码都需要包裹在一个匿名函数中来编写;
- 第三,在没有合适的规范情况下,每个人、每个公司都可能会任意命名、甚至出现模块名称相同的情况;
所以,会发现,虽然实现了模块化,但是的实现过于简单,并且是没有规范的。
- 需要制定一定的规范来约束每个人都按照这个规范去编写模块化的代码;
- 这个规范中应该包括核心功能:模块本身可以导出暴露的属性,模块又可以导入自己需要的属性;
- JavaScript社区为了解决上面的问题,涌现出一系列好用的规范,接下来就学习具有代表性的一些规范
2_CommonJS和Node
2.1_CommonJS和Node的关系
CommonJS是一个规范,最初是在浏览器以外的地方使用,且当时被命名为ServerJS,后来为了体现它的广泛性,修改为CommonJS,平时也会简称为CJS。
- Node是CommonJS在服务器端一个具有代表性的实现;【流行使用】
- Browserify是CommonJS在浏览器中的一种实现;【废弃不用】
- webpack打包工具具备对CommonJS的支持和转换;【流行使用】
因为Node中对CommonJS进行了支持和实现,所以在开发node的过程中可以方便的进行模块化开发:
- 在Node中每一个js文件都是一个单独的模块;
- 这个模块中包括CommonJS规范的核心变量:exports、module.exports、require;
- 可以使用这些变量来方便的进行模块化开发;
前面提到过模块化的核心是导出和导入,Node中对其进行了实现:
- exports和module.exports可以负责对模块中的内容进行导出;
- require函数可以帮助导入其他模块(自定义模块、系统模块、第三方库模块)中的内容;
demo:
(1)util.js文件代码
const UTIL_NAME = "util_name"
function formatCount() {
return "200万"
}
function formatDate() {
return "2022-10-10"
}
console.log(exports) // {}
// 必须有exports导出操作,其他模块才能导入
exports.UTIL_NAME = UTIL_NAME
exports.formatCount = formatCount
exports.formatDate = formatDate
(2)main.js文件代码
//导入方法 1.【require导入】直接获取导的对象, 从对象中获取属性
const util = require("./util.js")
console.log(util.UTIL_NAME)
console.log(util.formatCount())
console.log(util.formatDate())
// 导入方法2.导入对象时直接对其进行解构.这样使用时就不用加前缀until.
const {
UTIL_NAME,
formatCount,
formatDate
} = require("./util.js")
console.log(UTIL_NAME)
console.log(formatCount())
console.log(formatDate())
(3)在对应路径的终端中输入node main.js
命令运行,即可输出
{}
util_name
200万
2022-10-10
2.2_exports导出(少用)
注意,exports是一个对象。可以在这个对象中添加很多个属性,添加的属性会导出(以刚才的代码为例)。util.js文件
// 必须有exports导出操作,其他模块才能导入
exports.UTIL_NAME = UTIL_NAME
exports.formatCount = formatCount
exports.formatDate = formatDate
另外一个文件中可以导入:main.js文件
//【require导入】直接获取导的对象, 从对象中获取属性
const util = require("./util.js")
如何理解导入导出的本质?理解下面j几句话,Node中的模块化一目了然
- main中的util变量等于exports对象;
- require通过各种查找方式,最终找到了exports这个对象;并且将这个exports对象赋值给了util变量;
- util变量就是exports对象了;
也就是说,导入导出的本质是引用赋值,多个对象指向同一个值,这些对象都可以对这个值进行增删改查。
2.3_module.exports导出
Node中导出东西的时候,经常通过module.exports导出, module.exports和exports有什么关系或者区别呢?
追根溯源,通过维基百科中对CommonJS规范的解析:
- CommonJS中是没有module.exports的概念的;
- 但是为了实现模块的导出,Node中使用的是Module的类,每一个模块都是Module的一个实例,也就是module;
- 所以在Node中真正用于导出的其实根本不是exports,而是module.exports;
- 因为module才是导出的真正实现者;
但是,为什么exports也可以导出呢?
- 这是因为module对象的exports属性是exports对象的一个引用;
- 也就是说 module.exports = exports = main中的util变量;
3_require函数解析
require是一个函数,可以帮助引入一个文件(模块)中导出的对象。
require的查找规则?
导入格式:require(X)
3.1_情况一
X是一个Node核心模块,比如path、http。那么 直接返回核心模块,并且停止查找,
// 1.根据路径导入自己编写模块
const utils = require("./utils")
console.log(utils.formatDate())
3.2_情况二
X是以 ./
【当前文件下】或 ../
【上一级文件夹】或 /
【根目录】开头的
第一步:将X当做一个文件在对应的目录下查找;
- 如果有后缀名,按照后缀名的格式查找对应的文件
- 如果没有后缀名,会按照如下顺序:
- 直接查找文件X
- 查找X.js文件
- 查找X.json文件
- 查找X.node文件
第二步:没有找到对应的文件,将X作为一个目录,查找目录下面的index文件
- 查找X/index.js文件
- 查找X/index.json文件
- 查找X/index.node文件
最后一步, 如果没有找到,那么报错:not found
3.3_情况三
直接是一个X,不是路径名称,也不是核心模块名称。
会默认在当前目录、上一级目录、上上上一级目录、上上上一级目录…根目录查找node_moules文件夹。
如果上面的路径中都没有找到,那么报错:not found
4_模块的加载过程
结论一:模块在被第一次引入时,模块中的js代码会被运行一次
结论二:模块被多次引入时,会缓存,最终只加载(运行)一次
- 为什么只会加载运行一次呢?
- 这是因为每个模块对象module都有一个属性:loaded。
- 为false表示还没有加载,为true表示已经加载;
结论三:如果有循环引入,那么加载顺序是什么?若出现下图模块的引用关系,那么加载顺序是什么呢?
- 这其实是一种数据结构:图结构;
- 图结构在遍历的过程中,有深度优先搜索(DFS, depth first search)和广度优先搜索(BFS, breadth first search);
- Node采用的是深度优先算法:main -> aaa -> ccc -> ddd -> eee ->bbb
5_(可略过)
5.1_CommonJS规范缺点
CommonJS加载模块是同步的:
- 同步的意味着只有等到对应的模块加载完毕,当前模块中的内容才能被运行;
- 这个在服务器不会有什么问题,因为服务器加载的js文件都是本地文件,加载速度非常快;
如果将它应用于浏览器呢?
- 浏览器加载js文件需要先从服务器将文件下载下来,之后再加载运行;
- 那么采用同步的就意味着后续的js代码都无法正常运行,即使是一些简单的DOM操作;
所以在浏览器中,通常不使用CommonJS规范:
- 当然在webpack中使用CommonJS是另外一回事;
- 因为它会将的代码转成浏览器可以直接执行的代码;
在早期为了可以在浏览器中使用模块化,通常会采用AMD或CMD:
- 但是目前一方面现代的浏览器已经支持ES Modules,另一方面借助于webpack等工具可以实现对CommonJS或者ES
Module代码的转换; - AMD和CMD已经使用非常少了;
5.2_AMD规范
AMD主要是应用于浏览器的一种模块化规范:
- AMD是Asynchronous Module Definition(异步模块定义)的缩写;
- 它采用的是异步加载模块;
- 事实上AMD的规范还要早于CommonJS,但是CommonJS目前依然在被使用,而AMD使用的较少了;
提到过,规范只是定义代码的应该如何去编写,只有有了具体的实现才能被应用: AMD实现的比较常用的库是require.js和curl.js;
5.3_CMD规范
CMD规范也是应用于浏览器的一种模块化规范:
- CMD 是Common Module Definition(通用模块定义)的缩写;
- 它也采用的也是异步加载模块,但是它将CommonJS的优点吸收了过来;
- 但是目前CMD使用也非常少了;
CMD也有自己比较优秀的实现方案: SeaJS
6_ES Module
6.1_认识
JavaScript没有模块化一直是它的痛点,所以才会产生前面学习的社区规范:CommonJS、AMD、CMD等,所以在ECMA推出自己的模块化系统时,大家也是兴奋异常。
前端模块化目前有两种推荐方案:
- ES Module 浏览器自身支持
- webpack打包工具
ES Module和CommonJS的模块化有一些不同之处:
- 一方面它使用了import和export关键字;
- 另一方面它采用编译期的静态分析,并且也加入了动态引用的方式;
ES Module模块采用export和import关键字来实现模块化:
export
负责将模块内的内容导出;import
负责从其他模块导入内容;
注意
- 采用ES Module将自动采用严格模式:use strict
- 本地模块代码试运行,推荐使用的VSCode插件:Live Server
demo:
(1)foo.js文件代码
const name = "hhh"
const age = 18
function sayHello() {
console.log("sayHello")
}
// 导出 export
export {
name,
age,
sayHello
}
(2)mian.js文件代码
// 导入 import
// 注意事项一: 在浏览器中直接使用esmodule时, 必须在文件后加上后缀名.js,否则报错
import { name, age, sayHello } from "./foo.js"
// const name = "main"
console.log(name)
console.log(age)
sayHello()
(3)Index.html文件关键代码
<body>
<!-- 注意事项二: 在打开对应的html时, 如果html中有使用模块化的代码, 那么必须开启一个服务来打开 .比如 liveServer-->
<script src="./foo.js" type="module"></script>
<script src="./main.js" type="module"></script>
<!-- 注意事项三: 在script标签引入模块的js文件时,要加上类型 type="module"-->
</body>
6.2_exports导出
export关键字将一个模块中的变量、函数、类等导出;
将其他中内容全部导出,有如下的方式:
方式一:在语句声明的前面直接加上export关键字
export const name = "hhh"
export const age = 18
export function sayHello() {
console.log("sayHello")
}
export class Person {}
方式二:将所有需要导出的标识符,放到export后面的 {}中
- 注意:这里的 {}里面不是ES6的对象字面量的增强写法,{}也不是表示一个对象的;
- 所以: 例如export {name: name},是错误的写法;
const name = "hhh"
const age = 18
function sayHello() {
console.log("sayHello")
}
// 1.导出方式一:
export {
name,
age,
sayHello
}
方式三:导出时给标识符起一个别名。 通过as关键字起别名
const name = "hhh"
const age = 18
function sayHello() {
console.log("sayHello")
}
// 1.导出方式一:
export {
name as cname,
age,
sayHello
}
6.3_import导出
方式一:import {标识符列表} from ‘模块’; 注意:这里的{}也不是一个对象,里面只是存放导入的标识符列表内容;
import { name, age, sayHello } from "./foo.js"
方式二:导入时给标识符起别名。 通过as关键字起别名
import { name as fname, age, sayHello } from "./foo.js"
方式三:通过 * 将模块功能放到一个模块功能对象(a module object)上
import * as foo from "./foo.js"
6.4_export和import结合使用
export和import可以结合使用
- 在开发和封装一个功能库时,通常希望将暴露的所有接口放到一个文件中;
- 这样方便指定统一的接口规范,也方便阅读;
- 这个时候,就可以使用export和import结合使用;
demo:
index.js文件代码。导入两个模块的js文件,并导出相关的标识符。
(1)index.js原始导入导出版本如下:
import { formatCount, formatDate } from './format.js'
import { parseLyric } from './parse.js'
export {
formatCount,
formatDate,
parseLyric
}
(2)index.js经过export和import结合使用版本如下:
// 优化方式一
export { formatCount, formatDate } from './format.js'
export { parseLyric } from './parse.js'
// 优化方式二
export * from './format.js'
export * from './parse.js'
(3)main.js导入index.js如下
import {
formatCount,
formatDate,
parseLyric
} from './utils/index.js'
console.log(formatCount())
console.log(formatDate())
console.log(parseLyric())
6.5_default用法
前面的导出功能都是有名字的导出(named exports):
- 在导出export时指定了名字;
- 在导入import时需要知道具体的名字;
还有一种导出叫做默认导出(default export)
- 默认导出export时可以不需要指定名字;
- 在导入时不需要使用 {},并且可以自己来指定名字;
- 它也方便和现有的CommonJS等规范相互操作;
注意:在一个模块中,只能有一个默认导出(default exp
// 1. 第一种.默认的导出:
// // 1.1. 定义函数
// function parseLyric() {
// return ["歌词"]
// }
// const name = "aaaa"
// // export {
// // parseLyric,
// // name
// // }
// 1.2.默认导出
// export default parseLyric
//2.第二种 定义标识符直接作为默认导出
export default function() {
return ["新歌词"]
}
// 注意事项: 一个模块只能有一个默认导出
导入代码
// import { parseLyric } from "./parse_lyric.js"
import parseLyric from "./parse_lyric.js"
console.log(parseLyric())
6.6_import函数
通过import加载一个模块,是不可以在其放到逻辑代码中的。比如下面这个代码,就是一种错误写法
let flag = true
if (flag) {
// 不允许在逻辑代码中编写import导入声明语法, 只能写到js代码顶层
import { name, age, sayHello } from "./foo.js"
console.log(name, age)
}
为什么会出现这个情况呢?
- 这是因为ES Module在被JS引擎解析时,就必须知道它的依赖关系;
- 由于这个时候js代码没有任何的运行,所以无法在进行类似于if判断中根据代码的执行情况;
- 甚至拼接路径的写法也是错误的:因为必须到运行时能确定path的值;
但是某些情况下,确确实实希望动态的来加载某一个模块:
- 如果根据不懂的条件,动态来选择加载模块的路径;
- 这个时候需要使用 import() 函数来动态加载; import函数返回一个Promise,可以通过then获取结果,那么则允许在逻辑代码使用impoert;
let flag = true
if (flag) {
// 如果确实是逻辑成立时, 才需要导入某个模块
// import函数
const importPromise = import("./foo.js")
importPromise.then(res => {
console.log(res.name, res.age)
})
}
**import meta** import.meta是一个给JavaScript模块暴露特定上下文的元数据属性的对象。
- 它包含了这个模块的信息,比如说这个模块的URL;
- 在ES11(ES2020)中新增的特性;
7_ES Module解析过程
ES Module是如何被浏览器解析并且让模块之间可以相互引用的呢?
https://hacks.mozilla.org/2018/03/es-modules-a-cartoon-deep-dive/
ES Module的解析过程可以划分为三个阶段:
- 阶段一:构建(Construction),根据地址查找js文件,并且下载,将其解析成模块记录(Module Record);
- 阶段二:实例化(Instantiation),对模块记录进行实例化,并且分配内存空间,解析模块的导入和导出语句,把模块指向对应的内存地址。
- 阶段三:运行(Evaluation),运行代码,计算值,并且将值填充到内存地址中