close
大廠技術堅持周更精選好文

本文為來自 字節跳動-國際化電商-S項目 的文章,已授權 ELab 發布。

webpack 是當前使用較多的一個打包工具,將眾多代碼組織到一起使得在瀏覽器下可以正常運行,下面以打包為目的,實現一個簡易版 webpack,支持單入口文件的打包,不涉及插件、分包等。

前置知識

舉個🌰,先來看看下面這個 demo,例子很簡單,一個 index.js,裡面引用了一個文件 a.js,a.js 內部引入了 b.js,通過 webpack 最簡單的配置,將 index.js 文件作為入口進行打包。

來看看打包後的內容是怎樣的

//index.jsrequire('./a.js');console.log('entryload');//a.jsrequire("./b.js");consta=1;console.log("aload");module.exports=a;//b.jsconsole.log("bload");constb=1;module.exports=b;

可以看到打包產物是一個立即執行函數,函數初始先定義了多個 module,每個 module 是實際代碼中被 require 的文件內容,同時由於瀏覽器不支持 require 方法,webpack 內部自行實現了一個 __webpack__require__,並將代碼中的 require 全部替換為該函數(從打包結果可看出)。

在 webpack__require 定義之後,便開始執行入口文件,同時可以看出,webpack 的打包過程便是通過入口文件,將直接依賴和間接依賴以 module 的形式組織到一起,並通過自行實現的 require 實現模塊的同步加載。

了解了打包產物後,便可以開始實現簡易版的 webpack ,最終打包產物與 webpack 保持一致。

初始化參數

根據 Node 接口 | webpack 中文文檔[1] 可以知道,webpack node api 對外暴露出了 webpack 方法,通過調用 webpack 方法傳入配置,返回 compiler 對象,compiler 對象包含 run 方法可執行編譯,即

constwebpack=require('webpack');//引用webpackconstcompiler=webpack(options);//傳入配置生成compiler對象compiler.run((err,stats)=>{//執行編譯,傳入回調});

因此,首先需要實現一個 webpack 方法,同時該方法支持傳入 webpack 配置,返回 compiler 實例,webpack 官方支持了以 cli 的形式運行 webpack 命令和指定參數、配置文件,這一部分暫時簡單實現,我們暴露出一個方法,方法接收用戶的配置。

//mini-webpack/core/index.jsfunctionwebpack(){//創建compiler對象constcompiler=newCompiler(options);}module.exports=webpack;

如上,實現了一個 webpack 方法,可傳入一個 options 參數,包括用戶指定的打包入口 entry、output 等。

webpack({entry:'./index.js',output:{path:path.resolve(__dirname,"dist"),filename:"[name].js",},module:{rules:[]}})編譯

上面已經實現了 webpack 配置的傳入,compiler 的創建,接下來還需要實現 Compiler 類,該類內部暴露一個 run 方法,用於執行編譯。

首先需要明確編譯過程需要做的事情。

讀取入口文件,將入口文件交給匹配的 loader 處理,返回處理後的代碼
開始編譯 loader 處理完的代碼
若代碼中依賴了其他文件,則對 require 函數替換為 webpack 自行實現的 __webpack__require__, 保存該文件的處理結果,同時讓其他文件回到第 1 步進行處理,不斷循環。
編譯結束後,每個文件都有其對應的處理結果,將這些文件的編譯結果從初始的入口文件開始組織到一起。
入口文件 loader 處理

讀取入口文件,將入口文件交給 匹配的 loader 處理

//mini-webpackcompiler.jsconstfs=require('fs');classCompiler{constructor(options){this.options=options||{};//保存編譯過程編譯的modulethis.modules=newSet();}run(callback){constentryChunk=this.build(path.join(process.cwd(),this.options.entry));}build(modulePath){letoriginCode=fs.readFileSync(modulePath);originCode=this.dealWidthLoader(modulePath,originCode.toString());returnthis.dealDependencies(originCode,modulePath);}//將源碼交給匹配的loader處理dealWidthLoader(modulePath,originCode){[...this.options.module.rules].reverse().forEach(item=>{if(item.test(modulePath)){constloaders=[...item.use].reverse();loaders.forEach(loader=>originCode=loader(originCode))}})returnoriginCode}}module.exports=Compiler; 入口文件處理

這裡需要開始處理入口文件的依賴,將其 require 轉換成 自定義的 __webpack_require__,同時將其依賴收集起來,後續需要不斷遞歸處理其直接依賴和間接依賴,這裡用到了 babel 進行處理。

//調用webpack處理依賴的代碼dealDependencies(code,modulePath){constfullPath=path.relative(process.cwd(),modulePath);//創建模塊對象constmodule={id:fullPath,dependencies:[]//該模塊所依賴模塊絕對路徑地址};//處理require語句,同時記錄依賴了哪些文件constast=parser.parse(code,{sourceType:"module",ast:true,});//深度優先遍歷語法Treetraverse(ast,{CallExpression:(nodePath)=>{constnode=nodePath.node;if(node.callee.name==="require"){//獲得依賴的路徑constrequirePath=node.arguments[0].value;constmoduleDirName=path.dirname(modulePath);constfullPath=path.relative(path.join(moduleDirName,requirePath),requirePath);//替換require語句為webpack自定義的require方法node.callee=t.identifier("__webpack_require__");//將依賴的路徑修改成以當前路行為基準node.arguments=[t.stringLiteral(fullPath)];constexitModule=[...this.modules].find(item=>item.id===fullPath)//該文件可能已經被處理過,這裡判斷一下if(!exitModule){//記錄下當前處理的文件所依賴的文件(後續需逐一處理)module.dependencies.push(fullPath);}}},});//根據新的ast生成代碼const{code:compilerCode}=generator(ast);//保存處理後的代碼module._source=compilerCode;//返回當前模塊對象returnmodule;} 依賴處理

到這裡為止便處理完了入口文件,但是在處理文件過程,還收集了入口文件依賴的其他文件未處理,因此,在 dealDependencies 尾部,加入以下代碼

//調用webpack處理依賴的代碼dealDependencies(code,modulePath){.........//為當前模塊掛載新的生成的代碼module._source=compilerCode;//遞歸處理其依賴module.dependencies.forEach((dependency)=>{constdepModule=this.build(dependency);//同時保存下編譯過的依賴this.modules.add(depModule);});.........//返回當前模塊對象returnmodule;} Chunk

在上面的步驟中,已經處理了入口文件、依賴文件,但目前它們還是分散開來,在 webpack 中,是支持多個入口,每個入口是一個 chunk,這個 chunk 將包含入口文件及其依賴的 module

//mini-webpackcompiler.jsconstfs=require('fs');classCompiler{constructor(options){this.options=options||{};//保存編譯過程編譯的modulethis.modules=newSet();}run(callback){constentryModule=this.build(path.join(process.cwd(),this.options.entry));constentryChunk=this.buildChunk("entry",entryModule);}build(modulePath){}//將源碼交給匹配的loader處理dealWidthLoader(modulePath,originCode){}//調用webpack處理依賴的代碼dealDependencies(code,modulePath){}buildChunk(entryName,entryModule){return{name:entryName,//入口文件編譯結果entryModule:entryModule,//所有直接依賴和間接依賴編譯結果modules:this.modules,};}}module.exports=Compiler;文件生成

至此我們已經將入口文件和其所依賴的所有文件編譯完成,現在需要將編譯後的代碼生成對應的文件。

根據最上面利用官方 webpack 打包出來的產物,保留其基本結構,將構造的 chunk 內部的 entryModule 的 source 以及 modules 的 souce 替換進去,並根據初始配置的 output 生成對應文件。

//mini-webpackcompiler.jsconstfs=require('fs');classCompiler{constructor(options){this.options=options||{};//保存編譯過程編譯的module,下面會講解到this.modules=newSet();}run(callback){constentryModule=this.build(path.join(process.cwd(),this.options.entry));constentryChunk=this.buildChunk("entry",entryModule);this.generateFile(entryChunk);}build(modulePath){}//將源碼交給匹配的loader處理dealWidthLoader(modulePath,originCode){}//調用webpack處理依賴的代碼dealDependencies(code,modulePath){}buildChunk(entryName,entryModule){}generateFile(entryChunk){//獲取打包後的代碼constcode=this.getCode(entryChunk);if(!fs.existsSync(this.options.output.path)){fs.mkdirSync(this.options.output.path);}//寫入文件fs.writeFileSync(path.join(this.options.output.path,this.options.output.filename.replace("[name]",entryChunk.name)),code);}getCode(entryChunk){return`(()=>{//webpackBootstrapvar__webpack_modules__={${entryChunk.modules.map(module=>`"${module.id}":(module,__unused_webpack_exports,__webpack_require__)=>{${module._source}}`).join(',')}};var__webpack_module_cache__={};function__webpack_require__(moduleId){//CheckifmoduleisincachevarcachedModule=__webpack_module_cache__[moduleId];if(cachedModule!==undefined){returncachedModule.exports;}//Createanewmodule(andputitintothecache)varmodule=(__webpack_module_cache__[moduleId]={exports:{},});//Executethemodulefunction__webpack_modules__[moduleId](module,module.exports,__webpack_require__);//Returntheexportsofthemodulereturnmodule.exports;}var__webpack_exports__={};//ThisentryneedtobewrappedinanIIFEbecauseitneedtobeisolatedagainstothermodulesinthechunk.(()=>{${entryChunk.entryModule._source};})();})()`;}}module.exports=Compiler;

試試在瀏覽器下跑一下生成的代碼

符合預期,至此便完成了一個極簡的 webpack,針對單入口文件進行打包。當然真正的 webpack 遠非如此簡單,這裡僅僅只是實現其一個打包思路。

❤️ 謝謝支持

以上便是本次分享的全部內容,希望對你有所幫助^_^

喜歡的話別忘了 分享、點讚、收藏 三連哦~。

歡迎關注公眾號 ELab團隊 收貨大廠一手好文章~

字節跳動校/社招內推碼: WWCM1TA
投遞鏈接: https://job.toutiao.com/s/rj1fwQW

可憑內推碼投遞 字節跳動-國際化電商-S項目 團隊 相關崗位哦~

參考資料
[1]

Node 接口 | webpack 中文文檔: https://webpack.docschina.org/api/node/#webpack

- END -
arrow
arrow
    全站熱搜
    創作者介紹
    創作者 鑽石舞台 的頭像
    鑽石舞台

    鑽石舞台

    鑽石舞台 發表在 痞客邦 留言(0) 人氣()