Webpack 是如何實(shí)現(xiàn)打包的?下面本篇文章就來帶大家深入了解一下Webpack 打包原理,希望對(duì)大家有所幫助!
作為一個(gè)前端“攻城獅”,Webpack 再熟悉不過了,Webpack 能做的事太多了,可以將所有資源(包括 JS,TS,JSX,圖像,字體和 CSS 等)打包后置于依賴關(guān)系中,使你可以按照需求引用依賴來使用資源。Webpack 很出色的完成了轉(zhuǎn)譯前端多種文件資源,分析復(fù)雜模塊依賴的工作,并且我們還可以自定義 loader,自由的加載我們自己的資源,那 Webpack 是如何實(shí)現(xiàn)打包的呢?今天來我們一起來看下。
想要知道 Webpack 打包原理的我們需要提前知道兩個(gè)知識(shí)點(diǎn)
1、什么是 require?
說到 require 首先想到的可能就是 import,import 是 es6 的一個(gè)語法標(biāo)準(zhǔn),
– require 是運(yùn)行時(shí)調(diào)用,因此 require 理論上可以運(yùn)用在代碼的任何地方;
– import 是編譯時(shí)調(diào)用,因此必須放在文件開頭;
在我們使用 Webpack 進(jìn)行編譯的時(shí)候會(huì)使用 babel 把 import 轉(zhuǎn)譯成 require,在 CommonJS 中,有一個(gè)全局性方法 require(),用于加載模塊, AMD、CMD 也采用的 require 方式來引用。
例如:
var add = require('./a.js'); add(1,2)
簡(jiǎn)單看來 require 其實(shí)就是一個(gè)函數(shù),引用的 ./a.js
只是函數(shù)的一個(gè)參數(shù)。
2、什么是 exports?
在這里我們可以認(rèn)為 exports 是一個(gè)對(duì)象,MDN export 可以看下具體用法。
了解了require 和 exports,接下來我們就可以開始打包
我們先看看下面我們打包后的代碼結(jié)構(gòu),我們可以發(fā)現(xiàn)經(jīng)過打包后會(huì)出現(xiàn) require 和 exports。
并不是所有的瀏覽器都能執(zhí)行 require exports,必須自己去實(shí)現(xiàn)一下 require 和 exports 才能保證代碼的正常運(yùn)行。打包后的代碼就是一個(gè)自執(zhí)行函數(shù),參數(shù)有依賴信息,以及文件的 code,執(zhí)行的函數(shù)體通過 eval 執(zhí)行 code。
總體設(shè)計(jì)圖如下:
第一步:編寫我們的配置文件
配置文件中配置了我們打包的入口 entry 以及打包后的出口 output 為后面的生成文件做好準(zhǔn)備。
const path = require("path"); module.exports = { entry: "./src/index.js", output: { path: path.resolve(__dirname, "./dist"),//打包后輸出的文件地址,需要絕對(duì)路徑因此需要path filename:"main.js" }, mode:"development"
第二步:模塊分析
整體思路:可以總結(jié)來說就是利用 fs 文件讀取入口文件 通過 AST 獲取到 import 依賴的文件的路徑,如果依賴文件 依然有依賴一直遞歸下去直至依賴分析清楚,維護(hù)在一個(gè) map 里面。
細(xì)節(jié)拆解:有人會(huì)有疑惑為什么用 AST 因?yàn)?AST 天生有這個(gè)功能,它的 ImportDeclaration 能幫我們快速過濾出 import 語法,當(dāng)然用正則匹配也是可以的,畢竟文件讀取完就是一個(gè)字符串,通過編寫牛逼的正則獲取文件依賴路徑,但是不夠 elegant。
step1:新建 index.js,a.js,b.js 依賴關(guān)系如下
index.js文件
import { str } from "./a.js"; console.log(`${str} Webpack`)
a.js文件
import { b} from "./b.js" export const str = "hello"
b.js 文件
export const b="bbb"
step2:編寫 Webpack
模塊分析:利用 AST 的 @babel/parser 將文件讀取的字符串轉(zhuǎn)換成 AST 樹,@babel/traverse 進(jìn)行語法分析,利用 ImportDeclaration 過濾出 import 找出文件依賴。
const content = fs.readFileSync(entryFile, "utf-8"); const ast = parser.parse(content, { sourceType: "module" }); const dirname = path.dirname(entryFile); const dependents = {}; traverse(ast, { ImportDeclaration({ node }) { // 過濾出import const newPathName = "./" + path.join(dirname, node.source.value); dependents[node.source.value] = newPathName; } }) const { code } = transformFromAst(ast, null, { presets: ["@babel/preset-env"] }) return { entryFile, dependents, code }
結(jié)果如下:
利用遞歸或是循環(huán)逐個(gè) import 文件進(jìn)行依賴分析,這塊注意,我們是使用 for 循環(huán)實(shí)現(xiàn)了分析所有依賴,之所以循環(huán)可以分析所有依賴,注意 modules 的長(zhǎng)度是變化的,當(dāng)有依賴的時(shí)候 .modules.push 新的依賴,modules.length 就會(huì)變化。
for (let i = 0; i < this.modules.length; i++) { const item = this.modules[i]; const { dependents } = item; if (dependents) { for (let j in dependents) { this.modules.push(this.parse(dependents[j])); } } }
第三步:編寫 WebpackBootstrap 函數(shù)+生成輸出文件
編寫 WebpackBootstrap 函數(shù):這里我們需要做的首先是 WebpackBootstrap 函數(shù),編譯后我們?cè)创a的 import 會(huì)被解析成 require 瀏覽器既然不認(rèn)識(shí) require ,那我們就先聲明它,畢竟 require 就是一個(gè)方法,在編寫函數(shù)的時(shí)候還需要注意的是作用域隔離,防止變量污染。我們代碼中 exports 也需要我們聲明一下,保證代碼在執(zhí)行的時(shí)候 exports 已經(jīng)存在。
生成輸出文件:生成文件的地址我們?cè)谂渲梦募呀?jīng)寫好了,再用 fs.writeFileSync 寫入到輸出文件夾即可。
file(code) { const filePath = path.join(this.output.path, this.output.filename) const newCode = JSON.stringify(code); // 生成bundle文件內(nèi)容 const bundle = `(function(modules){ function require(module){ function pathRequire(relativePath){ return require(modules[module].dependents[relativePath]) } const exports={}; (function(require,exports,code){ eval(code) })(pathRequire,exports,modules[module].code); return exports } require('${this.entry}') })(${newCode})`; // WebpackBoostrap // 生成文件。放入dist 目錄 fs.writeFileSync(filePath,bundle,'utf-8') }
第四步:分析執(zhí)行順序
我們可以在瀏覽器的控制臺(tái)運(yùn)行一下打包后的結(jié)果,如果能正常應(yīng)該會(huì)打印出 hello Webpack。
總結(jié)
通過以上的分析,我們應(yīng)該對(duì) Webpack 的大概流程有基本的了解,利用 AST 去解析代碼只是本次演示的一種方式,不是 Webpack 的真實(shí)實(shí)現(xiàn),Webpack 他自己有自己的 AST 解析方式,萬變不離其宗都是拿到模塊依賴,Webpack 生態(tài)是很完整,有興趣的童鞋可以考慮以下三個(gè)問題:
- 如果出現(xiàn)組件循環(huán)引用那又應(yīng)該如何處理?
- Webpack 是如何加載 loader 的?
- 猶大大極力推薦的 vite 可以實(shí)現(xiàn)按需打包,大大提升開發(fā)時(shí)候打包速度,如果是 webapck 又是應(yīng)該如何實(shí)現(xiàn)?