關于 webpack 你可能忽略的細節(附源碼分析)

注:本篇不是入門教程,入門請直接查看官方文檔。本篇的主要目標是通過實際問題來介紹 webpack 中容易被人忽略的細節, 以及源碼分析(以最新發布的 release 版本1.14.0的源碼為例), 并且提供幾種解決方案。

webpack from the official website

隨著前端技術的火熱發展,工程化,模塊化和組件化的思想已逐步成為主流,與之相應的,就需要有一整套工具流可以支撐起它。

現在比較熱門的前端資源模塊化管理和打包工具應該非 Webpack 莫屬了。

Webpack 是什么

它可以將許多松散的模塊按照依賴和規則打包成符合生產環境部署的前端資源。還可以將按需加載的模塊進行代碼分隔,等到實際需要的時候再異步加載。通過 loader 的轉換,任何形式的資源都可以視作模塊,比如 CommonJs 模塊、 AMD 模塊、 ES6 模塊、CSS、圖片、 JSON、Coffeescript、 LESS 等。
--引自 Webpack 中文指南

使用舉例

我們來看一下官方文檔中的最小用例,新建并寫入以下內容到這兩個文件:

cats.js

var cats = ['dave', 'henry', 'martha'];
module.exports = cats;

app.js (Entry Point)

cats = require('./cats.js');
console.log(cats);

這個時候,就可以使用 webpack 進行打包了:

webpack ./app.js app.bundle.js

我們來看一下發生了什么, 目錄下生成了一個打包后的文件 app.bundle.js ,這就是最基礎的打包過程。

提出問題

如何判斷打包是否成功?

通用方案

下面是我們常用的兩種判斷任務是否執行成功的方案

通過 return code

通過命令執行后的 return code 來判斷(在 shell 中使用 $? 獲得)。 并且通常情況下 0 是執行成功, 非 0 是未成功。 我們以上面的例子來測試一下:

webpack-demo.png

可以看到 $? 的值為 0 , 且打包后的文件運行正常。

那么我們來修改一下 app.js 文件的內容, 將 require 引入的模塊路徑故意寫錯,來測試一下:

webpack-error.png

注意:箭頭處 $? 的值仍然為 0, 且生成的打包后的文件運行出錯。

這就說明,根據 return code 的值判斷任務是否執行成功, 不可行!

通過標準錯誤輸出

我們也會通過標準錯誤輸出stderr)來判斷一個任務執行過程中是否有錯誤輸出。還是使用上面的例子做示范:

webpack-stderr.png

根據這個例子,可以看到 webpack 并沒有標準錯誤輸出!所以這個方法也不可行。

探究原因及源碼分析

這里以最新發布的 release 版本 1.14.0 的源碼作為分析。 在 lib/Compilation.js 中我們可以看到這樣一段代碼:

var errorAndCallback = function errorAndCallback(err) {
  err.dependencies = dependencies;
  err.origin = module;
  module.dependenciesErrors.push(err);
  _this.errors.push(err);
  if(bail) {
    callback(err);
  } else {
    callback();
  }
};

在源碼中可以看到這個函數其實被調用的還比較多, 例如:在模塊為可選的時候, 會判斷只是拋出警告還是處理錯誤, 而上面這段代碼自然也不必多數, 關鍵點在于 bail 的值, 而我們繼續找, 可以看到在 bin/config-optimist.js 中有對 bail 參數的解析, 這是一個布爾值。而因為沒有太多描述, 所以這個參數就經常容易被忽略。

解決方案

1. 加 bail 參數

基于上面簡要的分析, 我們來嘗試下 bail 參數的作用。 仍然使用上面的例子:

我們使用 webpack --bail true app.js app.bundle.js 進行測試

webpack-bail.png

可以看到, 使用 bail 參數并傳遞 true 進去, 在遇到錯誤的時候,打包過程將會退出, return code1 且把錯誤信息打印到 stderr .

2. 使用 webpack-fail-plugin

webpack-fail-plugin 是專為解決這個問題而生的,它會在錯誤發生的時候 return 1. 使用方法也很簡單:

安裝:

npm install webpack-fail-plugin

使用:

var failPlugin = require('webpack-fail-plugin');
 
module.exports = {
    //config 
    plugins: [
        failPlugin
    ]
}

3.使用 done plugin

具體用法如下:

// ...
plugins: [ 
  // ... 
  function() { 
    this.plugin("done", function(stats) {
      if (stats.compilation.errors && stats.compilation.errors.length) {
        console.log(stats.compilation.errors); 
        process.exit(1); 
      }
      // ... 
    }); 
  }
// ...
],
// ...

4. 使用 webpack 2

不過 webpack 2 現在還在 beta 階段,可以期待下。 (webpack 2 也仍然是使用 bail 參數)


可以通過下面二維碼訂閱我的文章公眾號【MoeLove】

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,224評論 6 529
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 97,916評論 3 413
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,014評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,466評論 1 308
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,245評論 6 405
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,795評論 1 320
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,869評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,010評論 0 285
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,524評論 1 331
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,487評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,634評論 1 366
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,173評論 5 355
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 43,884評論 3 345
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,282評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,541評論 1 281
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,236評論 3 388
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,623評論 2 370

推薦閱讀更多精彩內容

  • GitChat技術雜談 前言 本文較長,為了節省你的閱讀時間,在文前列寫作思路如下: 什么是 webpack,它要...
    蕭玄辭閱讀 12,704評論 7 110
  • 最近在學習 Webpack,網上大多數入門教程都是基于 Webpack 1.x 版本的,我學習 Webpack 的...
    My_Oh_My閱讀 8,199評論 40 247
  • webpack 介紹 webpack 是什么 為什么引入新的打包工具 webpack 核心思想 webpack 安...
    yxsGert閱讀 6,488評論 2 71
  • 說在前面:這些文章均是本人花費大量精力研究整理,如有轉載請聯系作者并注明引用,謝謝本文的受眾人群不是webpack...
    RockSAMA閱讀 6,944評論 2 7
  • 2017年11月13日紅源悟語今日成長行動是成功的開始,等待是失敗的根源!今日感悟一個人不開心的真正原因:智慧不夠!
    紅源隨筆閱讀 100評論 0 0