學(xué)習(xí)minipack源碼犬缨,了解打包工具的工作原理

學(xué)習(xí)目標(biāo)

本質(zhì)上喳魏,webpack 是一個現(xiàn)代 JavaScript 應(yīng)用程序的靜態(tài)模塊打包器(module bundler)。當(dāng) webpack 處理應(yīng)用程序時怀薛,它會遞歸地構(gòu)建一個依賴關(guān)系圖(dependency graph)刺彩,其中包含應(yīng)用程序需要的每個模塊,然后將所有這些模塊打包成一個或多個 bundle枝恋。

通過minipack這個項目的源碼學(xué)習(xí)了解上邊提到的整個工作流程

demo目錄

.
├── example
      ├── entry.js
      ├── message.js
      ├── name.js

入口文件 entry.js:

// 入口文件 entry.js
import message from './message.js';

console.log(message);

message.js

// message.js
import {name} from './name.js';

export default `hello ${name}!`;

name.js

// name.js
export const name = 'world';

入口文件

入口起點(entry point)指示 webpack 應(yīng)該使用哪個模塊创倔,來作為構(gòu)建其內(nèi)部依賴圖的開始。進入入口起點后焚碌,webpack 會找出有哪些模塊和庫是入口起點(直接和間接)依賴的畦攘。

createAsset:生產(chǎn)一個描述該模塊的對象

createAsset 函數(shù)會解析js文本,生產(chǎn)一個描述該模塊的對象

function createAsset(filename) {
  /*讀取文件*/
  const content = fs.readFileSync(filename, 'utf-8');
  /*生產(chǎn)ast*/
  const ast = babylon.parse(content, {
    sourceType: 'module',
  });
   /* 該數(shù)組將保存此模塊所依賴的模塊的相對路徑十电。*/
  const dependencies = [];

   /*遍歷AST以嘗試?yán)斫庠撃K所依賴的模塊知押。 為此,我們檢查AST中的每個導(dǎo)入聲明摆出。*/
  traverse(ast, {
    ImportDeclaration: ({node}) => {
    /*將導(dǎo)入的值推送到依賴項數(shù)組中朗徊。*/
      dependencies.push(node.source.value);
    },
  });

  const id = ID++;
   
 /* 使用`babel-preset-env`將我們的代碼轉(zhuǎn)換為大多數(shù)瀏覽器可以運行的代碼。*/
  const {code} = transformFromAst(ast, null, {
    presets: ['env'],
  });
  /*返回這個描述對象*/
  return {
    id,
    filename,
    dependencies,
    code,
  };
}

createGraph: 生產(chǎn)依賴關(guān)系圖

function createGraph(entry) {
  // 解析入口文件
  const mainAsset = createAsset(entry);

  /*將使用隊列來解析每個模塊的依賴關(guān)系偎漫。 為此爷恳,定義了一個只包含入口模塊的數(shù)組。*/
  const queue = [mainAsset];

 /*我們使用`for ... of`循環(huán)迭代隊列象踊。 最初温亲,隊列只有一個模塊棚壁,但在我們迭代它時,我們會將其他新模塊推入隊列栈虚。 當(dāng)隊列為空時袖外,此循環(huán)將終止。*/
  for (const asset of queue) {
   /*我們的每個模塊都有一個它所依賴的模塊的相對路徑列表魂务。 我們將迭代它們曼验,使用我們的`createAsset()`函數(shù)解析它們,并跟蹤該模塊在此對象中的依賴關(guān)系粘姜。*/
    asset.mapping = {};

    // This is the directory this module is in.
    const dirname = path.dirname(asset.filename);

    // We iterate over the list of relative paths to its dependencies.
    asset.dependencies.forEach(relativePath => {
      // Our `createAsset()` function expects an absolute filename. The
      // dependencies array is an array of relative paths. These paths are
      // relative to the file that imported them. We can turn the relative path
      // into an absolute one by joining it with the path to the directory of
      // the parent asset.
      const absolutePath = path.join(dirname, relativePath);

      // Parse the asset, read its content, and extract its dependencies.
      const child = createAsset(absolutePath);

      // It's essential for us to know that `asset` depends on `child`. We
      // express that relationship by adding a new property to the `mapping`
      // object with the id of the child.
      asset.mapping[relativePath] = child.id;

      // Finally, we push the child asset into the queue so its dependencies
      // will also be iterated over and parsed.
      queue.push(child);
    });
  }

  // At this point the queue is just an array with every module in the target
  // application: This is how we represent our graph.
  return queue;
}

通過createGraph函數(shù) 生成的依賴關(guān)系對象:

[ 
  { id: 0,
    filename: './example/entry.js',
    dependencies: [ './message.js' ],
    code: '"use strict";\n\nvar _message = require("./message.js");\n\nvar _message2 = _interopRequireDefault(_message);\n\nfunction _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }\n\nconsole.log(_message2.default);',
    mapping: { './message.js': 1 } },

  { id: 1,
    filename: 'example/message.js',
    dependencies: [ './name.js' ],
    code: '"use strict";\n\nObject.defineProperty(exports, "__esModule", {\n  value: true\n});\n\nvar _name = require("./name.js");\n\nexports.default = "hello " + _name.name + "!";',
    mapping: { './name.js': 2 } },

  { id: 2,
    filename: 'example/name.js',
    dependencies: [],
    code: '"use strict";\n\nObject.defineProperty(exports, "__esModule", {\n  value: true\n});\nvar name = exports.name = \'world\';',
    mapping: {} } 
    
]

bundle 打包

bundle函數(shù)把上邊得到的依賴關(guān)系對象作為參數(shù)鬓照,生產(chǎn)瀏覽器可以運行的包

function bundle(graph) {
 let modules = '';
 graph.forEach(mod => {
   modules += `${mod.id}: [
     function (require, module, exports) {
       ${mod.code}
     },
     ${JSON.stringify(mod.mapping)},
   ],`;
 });

 const result = `
   (function(modules) {
     function require(id) {
       const [fn, mapping] = modules[id];
       function localRequire(name) {
         return require(mapping[name]);
       }
       const module = { exports : {} };
       fn(localRequire, module, module.exports);
       return module.exports;
     }
     require(0);
   })({${modules}})
 `;

 // We simply return the result, hurray! :)
 return result;
}

參考例子,最終生產(chǎn)的代碼:

(function (modules) {
    function require(id) {
        const [fn, mapping] = modules[id];

        function localRequire(name) {
            return require(mapping[name]);
        }

        const module = { exports: {} };

        fn(localRequire, module, module.exports);

        return module.exports;
    }

    require(0);
})({
    0: [
        function (require, module, exports) {
            "use strict";
            var _message = require("./message.js");
            var _message2 = _interopRequireDefault(_message);
            function _interopRequireDefault(obj) {
                return obj && obj.__esModule ? obj : { default: obj };
            }

            console.log(_message2.default);
        },
        { "./message.js": 1 },
    ],
    1: [
        function (require, module, exports) {
            "use strict";
            Object.defineProperty(exports, "__esModule", {
                value: true
            });
            var _name = require("./name.js");
            exports.default = "hello " + _name.name + "!";
        },
        { "./name.js": 2 },
    ],

    2: [
        function (require, module, exports) {
            "use strict";
            Object.defineProperty(exports, "__esModule", {
                value: true
            });
            var name = exports.name = 'world';
        },
        {},
    ],
})

分析打包后的這段代碼
這是一個自執(zhí)行函數(shù)

(function (modules) {
...
})({...})

函數(shù)體內(nèi)聲明了 require函數(shù)孤紧,并執(zhí)行調(diào)用了require(0);
require函數(shù)就是 從參數(shù)modules對象中找到對應(yīng)id的 [fn, mapping]
如果模塊有依賴其他模塊的話豺裆,就會執(zhí)行傳入的require函數(shù),也就是localRequire函數(shù)

function require(id) {
        // 數(shù)組的解構(gòu)賦值
        const [fn, mapping] = modules[id];

        function localRequire(name) {
            return require(mapping[name]);
        }

        const module = { exports: {} };

        fn(localRequire, module, module.exports); // 遞歸調(diào)用

        return module.exports;
    }

接收一個模塊id,過程如下:

第一步:解構(gòu)module(數(shù)組解構(gòu))号显,獲取fn和當(dāng)前module的依賴路徑
第二步:定義引入依賴函數(shù)(相對引用)臭猜,函數(shù)體同樣是獲取到依賴module的id,localRequire 函數(shù)傳入到fn中
第三步:定義module變量押蚤,保存的是依賴模塊導(dǎo)出的對象蔑歌,存儲在module.exports中,module和module.exports也傳入到fn中
第四步:遞歸執(zhí)行揽碘,直到子module中不再執(zhí)行傳入的require函數(shù)

要更好了解“打包”的原理丐膝,就需要學(xué)習(xí)“模塊化”的知識。

參考:

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末钾菊,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子偎肃,更是在濱河造成了極大的恐慌煞烫,老刑警劉巖,帶你破解...
    沈念sama閱讀 212,816評論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件累颂,死亡現(xiàn)場離奇詭異滞详,居然都是意外死亡,警方通過查閱死者的電腦和手機紊馏,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,729評論 3 385
  • 文/潘曉璐 我一進店門料饥,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人朱监,你說我怎么就攤上這事岸啡。” “怎么了赫编?”我有些...
    開封第一講書人閱讀 158,300評論 0 348
  • 文/不壞的土叔 我叫張陵巡蘸,是天一觀的道長奋隶。 經(jīng)常有香客問我,道長悦荒,這世上最難降的妖魔是什么唯欣? 我笑而不...
    開封第一講書人閱讀 56,780評論 1 285
  • 正文 為了忘掉前任,我火速辦了婚禮搬味,結(jié)果婚禮上境氢,老公的妹妹穿的比我還像新娘。我一直安慰自己碰纬,他們只是感情好萍聊,可當(dāng)我...
    茶點故事閱讀 65,890評論 6 385
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著嘀趟,像睡著了一般脐区。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上她按,一...
    開封第一講書人閱讀 50,084評論 1 291
  • 那天牛隅,我揣著相機與錄音,去河邊找鬼酌泰。 笑死媒佣,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的陵刹。 我是一名探鬼主播默伍,決...
    沈念sama閱讀 39,151評論 3 410
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼衰琐!你這毒婦竟也來了也糊?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,912評論 0 268
  • 序言:老撾萬榮一對情侶失蹤羡宙,失蹤者是張志新(化名)和其女友劉穎狸剃,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體狗热,經(jīng)...
    沈念sama閱讀 44,355評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡钞馁,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,666評論 2 327
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了匿刮。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片僧凰。...
    茶點故事閱讀 38,809評論 1 341
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖熟丸,靈堂內(nèi)的尸體忽然破棺而出训措,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 34,504評論 4 334
  • 正文 年R本政府宣布隙弛,位于F島的核電站架馋,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏全闷。R本人自食惡果不足惜叉寂,卻給世界環(huán)境...
    茶點故事閱讀 40,150評論 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望总珠。 院中可真熱鬧屏鳍,春花似錦、人聲如沸局服。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,882評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽淫奔。三九已至山涡,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間唆迁,已是汗流浹背鸭丛。 一陣腳步聲響...
    開封第一講書人閱讀 32,121評論 1 267
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留唐责,地道東北人鳞溉。 一個月前我還...
    沈念sama閱讀 46,628評論 2 362
  • 正文 我出身青樓,卻偏偏與公主長得像鼠哥,于是被迫代替她去往敵國和親熟菲。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 43,724評論 2 351

推薦閱讀更多精彩內(nèi)容