入門Webpack

李一花發表於2018-06-12
Web

2017年12月7日更新，新增了clean-webpack-plugin,babel-env-preset,新增本文涉及到的所有程式碼的示例，如果你在學習過程中出錯了，可點選此處參考

寫在前面的話

閱讀本文之前，先看下面這個webpack的配置檔案，如果每一項你都懂，那本文能帶給你的收穫也許就比較有限，你可以快速瀏覽或直接跳過；如果你和十天前的我一樣，對很多選項存在著疑惑，那花一段時間慢慢閱讀本文，你的疑惑一定一個一個都會消失；如果你以前沒怎麼接觸過Webpack，而你又你對webpack感興趣，那麼動手跟著本文中那個貫穿始終的例子寫一次，寫完以後你會發現你已明明白白的走進了Webpack的大門。


 
// 一個常見的`webpack`配置檔案
const webpack = require(`webpack`);
const HtmlWebpackPlugin = require(`html-webpack-plugin`);
const ExtractTextPlugin = require(`extract-text-webpack-plugin`);

module.exports = {
        entry: __dirname + "/app/main.js", //已多次提及的唯一入口檔案
        output: {
            path: __dirname + "/build",
            filename: "bundle-[hash].js"
        },
        devtool: `none`,
        devServer: {
            contentBase: "./public", //本地伺服器所載入的頁面所在的目錄
            historyApiFallback: true, //不跳轉
            inline: true,
            hot: true
        },
        module: {
            rules: [{
                    test: /(.jsx|.js)$/,
                    use: {
                        loader: "babel-loader"
                    },
                    exclude: /node_modules/
                }, {
                    test: /.css$/,
                    use: ExtractTextPlugin.extract({
                        fallback: "style-loader",
                        use: [{
                            loader: "css-loader",
                            options: {
                                modules: true,
                                localIdentName: `[name]__[local]--[hash:base64:5]`
                            }
                        }, {
                            loader: "postcss-loader"
                        }],
                    })
                }
            }
        ]
    },
    plugins: [
        new webpack.BannerPlugin(`版權所有，翻版必究`),
        new HtmlWebpackPlugin({
            template: __dirname + "/app/index.tmpl.html" //new 一個這個外掛的例項，並傳入相關的引數
        }),
        new webpack.optimize.OccurrenceOrderPlugin(),
        new webpack.optimize.UglifyJsPlugin(),
        new ExtractTextPlugin("style.css")
    ]
};

什麼是WebPack，為什麼要使用它？

為什要使用WebPack

現今的很多網頁其實可以看做是功能豐富的應用，它們擁有著複雜的JavaScript程式碼和一大堆依賴包。為了簡化開發的複雜度，前端社群湧現出了很多好的實踐方法

  • 模組化，讓我們可以把複雜的程式細化為小的檔案;
  • 類似於TypeScript這種在JavaScript基礎上擴充的開發語言：使我們能夠實現目前版本的JavaScript不能直接使用的特性，並且之後還能轉換為JavaScript檔案使瀏覽器可以識別；
  • Scss，less等CSS前處理器
  • …

這些改進確實大大的提高了我們的開發效率，但是利用它們開發的檔案往往需要進行額外的處理才能讓瀏覽器識別,而手動處理又是非常繁瑣的，這就為WebPack類的工具的出現提供了需求。

什麼是Webpack

WebPack可以看做是模組打包機：它做的事情是，分析你的專案結構，找到JavaScript模組以及其它的一些瀏覽器不能直接執行的擴充語言（Scss，TypeScript等），並將其轉換和打包為合適的格式供瀏覽器使用。

WebPack和Grunt以及Gulp相比有什麼特性

其實Webpack和另外兩個並沒有太多的可比性，Gulp/Grunt是一種能夠優化前端的開發流程的工具，而WebPack是一種模組化的解決方案，不過Webpack的優點使得Webpack在很多場景下可以替代Gulp/Grunt類的工具。

Grunt和Gulp的工作方式是：在一個配置檔案中，指明對某些檔案進行類似編譯，組合，壓縮等任務的具體步驟，工具之後可以自動替你完成這些任務。

 

10164445_4i0h.png

Grunt和Gulp的工作流程

Webpack的工作方式是：把你的專案當做一個整體，通過一個給定的主檔案（如：index.js），Webpack將從這個檔案開始找到你的專案的所有依賴檔案，使用loaders處理它們，最後打包為一個（或多個）瀏覽器可識別的JavaScript檔案。

 

10164445_RqIP.png

Webpack工作方式

如果實在要把二者進行比較，Webpack的處理速度更快更直接，能打包更多不同型別的檔案。

開始使用Webpack

初步瞭解了Webpack工作方式後，我們一步步的開始學習使用Webpack。

安裝

Webpack可以使用npm安裝，新建一個空的練習資料夾（此處命名為webpack sample project），在終端中轉到該資料夾後執行下述指令就可以完成安裝。

//全域性安裝
npm install -g webpack
//安裝到你的專案目錄
npm install --save-dev webpack

正式使用Webpack前的準備

  1. 在上述練習資料夾中建立一個package.json檔案，這是一個標準的npm說明檔案，裡面蘊含了豐富的資訊，包括當前專案的依賴模組，自定義的指令碼任務等等。在終端中使用npm init命令可以自動建立這個package.json檔案

npm init

輸入這個命令後，終端會問你一系列諸如專案名稱，專案描述，作者等資訊，不過不用擔心，如果你不準備在npm中釋出你的模組，這些問題的答案都不重要，回車預設即可。

  1. package.json檔案已經就緒，我們在本專案中安裝Webpack作為依賴包

// 安裝Webpack
npm install --save-dev webpack

  1. 回到之前的空資料夾，並在裡面建立兩個資料夾,app資料夾和public資料夾，app資料夾用來存放原始資料和我們將寫的JavaScript模組，public資料夾用來存放之後供瀏覽器讀取的檔案（包括使用webpack打包生成的js檔案以及一個index.html檔案）。接下來我們再建立三個檔案:
  • index.html –放在public資料夾中;
  • Greeter.js— 放在app資料夾中;
  • main.js— 放在app資料夾中;

此時專案結構如下圖所示

 

10164445_gGfF.png

專案結構

我們在index.html檔案中寫入最基礎的html程式碼，它在這裡目的在於引入打包後的js檔案（這裡我們先把之後打包後的js檔案命名為bundle.js，之後我們還會詳細講述）。

<!-- index.html -->
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <title>Webpack Sample Project</title>
  </head>
  <body>
    <div id=`root`>
    </div>
    <script src="bundle.js"></script>
  </body>
</html>

我們在Greeter.js中定義一個返回包含問候資訊的html元素的函式,並依據CommonJS規範匯出這個函式為一個模組：

// Greeter.js
module.exports = function() {
  var greet = document.createElement(`div`);
  greet.textContent = "Hi there and greetings!";
  return greet;
};

main.js檔案中我們寫入下述程式碼，用以把Greeter模組返回的節點插入頁面。

//main.js 
const greeter = require(`./Greeter.js`);
document.querySelector("#root").appendChild(greeter());

正式使用Webpack

webpack可以在終端中使用，在基本的使用方法如下：

# {extry file}出填寫入口檔案的路徑，本文中就是上述main.js的路徑，
# {destination for bundled file}處填寫打包檔案的存放路徑
# 填寫路徑的時候不用新增{}
webpack {entry file} {destination for bundled file}

指定入口檔案後，webpack將自動識別專案所依賴的其它檔案，不過需要注意的是如果你的webpack不是全域性安裝的，那麼當你在終端中使用此命令時，需要額外指定其在node_modules中的地址，繼續上面的例子，在終端中輸入如下命令

# webpack非全域性安裝的情況
node_modules/.bin/webpack app/main.js public/bundle.js

結果如下

10164445_sJ60.png

使用命令列打包

可以看出webpack同時編譯了main.js 和Greeter,js,現在開啟index.html,可以看到如下結果

10164445_HVx7.png

htmlResult1

 

有沒有很激動，已經成功的使用Webpack打包了一個檔案了。不過在終端中進行復雜的操作，其實是不太方便且容易出錯的，接下來看看Webpack的另一種更常見的使用方法。

通過配置檔案來使用Webpack

Webpack擁有很多其它的比較高階的功能（比如說本文後面會介紹的loaders和plugins），這些功能其實都可以通過命令列模式實現，但是正如前面提到的，這樣不太方便且容易出錯的，更好的辦法是定義一個配置檔案，這個配置檔案其實也是一個簡單的JavaScript模組，我們可以把所有的與打包相關的資訊放在裡面。

繼續上面的例子來說明如何寫這個配置檔案，在當前練習資料夾的根目錄下新建一個名為webpack.config.js的檔案，我們在其中寫入如下所示的簡單配置程式碼，目前的配置主要涉及到的內容是入口檔案路徑和打包後檔案的存放路徑。

module.exports = {
  entry:  __dirname + "/app/main.js",//已多次提及的唯一入口檔案
  output: {
    path: __dirname + "/public",//打包後的檔案存放的地方
    filename: "bundle.js"//打包後輸出檔案的檔名
  }
}

注：“__dirname”是node.js中的一個全域性變數，它指向當前執行指令碼所在的目錄。

有了這個配置之後，再打包檔案，只需在終端裡執行webpack(非全域性安裝需使用node_modules/.bin/webpack)命令就可以了，這條命令會自動引用webpack.config.js檔案中的配置選項，示例如下：

10164445_OCao.png

配合配置檔案進行打包

又學會了一種使用Webpack的方法，這種方法不用管那煩人的命令列引數，有沒有感覺很爽。如果我們可以連webpack(非全域性安裝需使用node_modules/.bin/webpack)這條命令都可以不用，那種感覺會不會更爽~，繼續看下文。

更快捷的執行打包任務

在命令列中輸入命令需要程式碼類似於node_modules/.bin/webpack這樣的路徑其實是比較煩人的，不過值得慶幸的是npm可以引導任務執行，對npm進行配置後可以在命令列中使用簡單的npm start命令來替代上面略微繁瑣的命令。在package.json中對scripts物件進行相關設定即可，設定方法如下。

{
  "name": "webpack-sample-project",
  "version": "1.0.0",
  "description": "Sample webpack project",
  "scripts": {
    "start": "webpack" // 修改的是這裡，JSON檔案不支援註釋，引用時請清除
  },
  "author": "zhang",
  "license": "ISC",
  "devDependencies": {
    "webpack": "3.10.0"
  }
}

注：package.json中的script會安裝一定順序尋找命令對應位置，本地的node_modules/.bin路徑就在這個尋找清單中，所以無論是全域性還是區域性安裝的Webpack，你都不需要寫前面那指明詳細的路徑了。

npm的start命令是一個特殊的指令碼名稱，其特殊性表現在，在命令列中使用npm start就可以執行其對於的命令，如果對應的此指令碼名稱不是start，想要在命令列中執行時，需要這樣用npm run {script name}如npm run build，我們在命令列中輸入npm start試試，輸出結果如下：

10164445_ksuy.png

使用npm start 打包程式碼

現在只需要使用npm start就可以打包檔案了，有沒有覺得webpack也不過如此嘛，不過不要太小瞧webpack，要充分發揮其強大的功能我們需要修改配置檔案的其它選項，一項項來看。

Webpack的強大功能

生成Source Maps（使除錯更容易）

開發總是離不開除錯，方便的除錯能極大的提高開發效率，不過有時候通過打包後的檔案，你是不容易找到出錯了的地方，對應的你寫的程式碼的位置的，Source Maps就是來幫我們解決這個問題的。

通過簡單的配置，webpack就可以在打包時為我們生成的source maps，這為我們提供了一種對應編譯檔案和原始檔的方法，使得編譯後的程式碼可讀性更高，也更容易除錯。

在webpack的配置檔案中配置source maps，需要配置devtool，它有以下四種不同的配置選項，各具優缺點，描述如下：

devtool選項 配置結果
source-map 在一個單獨的檔案中產生一個完整且功能完全的檔案。這個檔案具有最好的source map，但是它會減慢打包速度；
cheap-module-source-map 在一個單獨的檔案中生成一個不帶列對映的map，不帶列對映提高了打包速度，但是也使得瀏覽器開發者工具只能對應到具體的行，不能對應到具體的列（符號），會對除錯造成不便；
eval-source-map 使用eval打包原始檔模組，在同一個檔案中生成乾淨的完整的source map。這個選項可以在不影響構建速度的前提下生成完整的sourcemap，但是對打包後輸出的JS檔案的執行具有效能和安全的隱患。在開發階段這是一個非常好的選項，在生產階段則一定不要啟用這個選項；
cheap-module-eval-source-map 這是在打包檔案時最快的生成source map的方法，生成的Source Map 會和打包後的JavaScript檔案同行顯示，沒有列對映，和eval-source-map選項具有相似的缺點；

正如上表所述，上述選項由上到下打包速度越來越快，不過同時也具有越來越多的負面作用，較快的打包速度的後果就是對打包後的檔案的的執行有一定影響。

對小到中型的專案中，eval-source-map是一個很好的選項，再次強調你只應該開發階段使用它，我們繼續對上文新建的webpack.config.js，進行如下配置:

module.exports = {
  devtool: `eval-source-map`,
  entry:  __dirname + "/app/main.js",
  output: {
    path: __dirname + "/public",
    filename: "bundle.js"
  }
}

cheap-module-eval-source-map方法構建速度更快，但是不利於除錯，推薦在大型專案考慮時間成本時使用。

使用webpack構建本地伺服器

想不想讓你的瀏覽器監聽你的程式碼的修改，並自動重新整理顯示修改後的結果，其實Webpack提供一個可選的本地開發伺服器，這個本地伺服器基於node.js構建，可以實現你想要的這些功能，不過它是一個單獨的元件，在webpack中進行配置之前需要單獨安裝它作為專案依賴

npm install --save-dev webpack-dev-server

devserver作為webpack配置選項中的一項，以下是它的一些配置選項，更多配置可參考這裡

devserver的配置選項 功能描述
contentBase 預設webpack-dev-server會為根資料夾提供本地伺服器，如果想為另外一個目錄下的檔案提供本地伺服器，應該在這裡設定其所在目錄（本例設定到“public”目錄）
port 設定預設監聽埠，如果省略，預設為”8080“
inline 設定為true，當原始檔改變時會自動重新整理頁面
historyApiFallback 在開發單頁應用時非常有用，它依賴於HTML5 history API，如果設定為true，所有的跳轉將指向index.html

把這些命令加到webpack的配置檔案中，現在的配置檔案webpack.config.js如下所示

module.exports = {
  devtool: `eval-source-map`,

  entry:  __dirname + "/app/main.js",
  output: {
    path: __dirname + "/public",
    filename: "bundle.js"
  },

  devServer: {
    contentBase: "./public",//本地伺服器所載入的頁面所在的目錄
    historyApiFallback: true,//不跳轉
    inline: true//實時重新整理
  } 
}

在package.json中的scripts物件中新增如下命令，用以開啟本地伺服器：

 "scripts": {
    "test": "echo "Error: no test specified" && exit 1",
    "start": "webpack",
    "server": "webpack-dev-server --open"
  },

在終端中輸入npm run server即可在本地的8080埠檢視結果

10164445_m1OG.png

開啟本地伺服器

Loaders

鼎鼎大名的Loaders登場了！

Loaders是webpack提供的最激動人心的功能之一了。通過使用不同的loader，webpack有能力呼叫外部的指令碼或工具，實現對不同格式的檔案的處理，比如說分析轉換scss為css，或者把下一代的JS檔案（ES6，ES7)轉換為現代瀏覽器相容的JS檔案，對React的開發而言，合適的Loaders可以把React的中用到的JSX檔案轉換為JS檔案。

Loaders需要單獨安裝並且需要在webpack.config.js中的modules關鍵字下進行配置，Loaders的配置包括以下幾方面：

  • test：一個用以匹配loaders所處理檔案的擴充名的正規表示式（必須）
  • loader：loader的名稱（必須）
  • include/exclude:手動新增必須處理的檔案（資料夾）或遮蔽不需要處理的檔案（資料夾）（可選）；
  • query：為loaders提供額外的設定選項（可選）

不過在配置loader之前，我們把Greeter.js裡的問候訊息放在一個單獨的JSON檔案裡,並通過合適的配置使Greeter.js可以讀取該JSON檔案的值，各檔案修改後的程式碼如下：

在app資料夾中建立帶有問候資訊的JSON檔案(命名為config.json)

{
  "greetText": "Hi there and greetings from JSON!"
}

更新後的Greeter.js

var config = require(`./config.json`);

module.exports = function() {
  var greet = document.createElement(`div`);
  greet.textContent = config.greetText;
  return greet;
};

注 由於webpack3.*/webpack2.*已經內建可處理JSON檔案，這裡我們無需再新增webpack1.*需要的json-loader。在看如何具體使用loader之前我們先看看Babel是什麼？

Babel

Babel其實是一個編譯JavaScript的平臺，它可以編譯程式碼幫你達到以下目的：

  • 讓你能使用最新的JavaScript程式碼（ES6，ES7…），而不用管新標準是否被當前使用的瀏覽器完全支援；
  • 讓你能使用基於JavaScript進行了擴充的語言，比如React的JSX；

Babel的安裝與配置

Babel其實是幾個模組化的包，其核心功能位於稱為babel-core的npm包中，webpack可以把其不同的包整合在一起使用，對於每一個你需要的功能或擴充，你都需要安裝單獨的包（用得最多的是解析Es6的babel-env-preset包和解析JSX的babel-preset-react包）。

我們先來一次性安裝這些依賴包

// npm一次性安裝多個依賴模組，模組之間用空格隔開
npm install --save-dev babel-core babel-loader babel-preset-env babel-preset-react

在webpack中配置Babel的方法如下:

module.exports = {
    entry: __dirname + "/app/main.js",//已多次提及的唯一入口檔案
    output: {
        path: __dirname + "/public",//打包後的檔案存放的地方
        filename: "bundle.js"//打包後輸出檔案的檔名
    },
    devtool: `eval-source-map`,
    devServer: {
        contentBase: "./public",//本地伺服器所載入的頁面所在的目錄
        historyApiFallback: true,//不跳轉
        inline: true//實時重新整理
    },
    module: {
        rules: [
            {
                test: /(.jsx|.js)$/,
                use: {
                    loader: "babel-loader",
                    options: {
                        presets: [
                            "env", "react"
                        ]
                    }
                },
                exclude: /node_modules/
            }
        ]
    }
};

現在你的webpack的配置已經允許你使用ES6以及JSX的語法了。繼續用上面的例子進行測試，不過這次我們會使用React，記得先安裝 React 和 React-DOM

npm install --save react react-dom

接下來我們使用ES6的語法，更新Greeter.js並返回一個React元件

//Greeter,js
import React, {Component} from `react`
import config from `./config.json`;

class Greeter extends Component{
  render() {
    return (
      <div>
        {config.greetText}
      </div>
    );
  }
}

export default Greeter

修改main.js如下，使用ES6的模組定義和渲染Greeter模組

// main.js
import React from `react`;
import {render} from `react-dom`;
import Greeter from `./Greeter`;

render(<Greeter />, document.getElementById(`root`));

重新使用npm start打包，如果之前開啟的本地伺服器沒有關閉，你應該可以在localhost:8080下看到與之前一樣的內容，這說明react和es6被正常打包了。

10164445_3dfX.png

localhost:8080

Babel的配置

Babel其實可以完全在 webpack.config.js 中進行配置，但是考慮到babel具有非常多的配置選項，在單一的webpack.config.js檔案中進行配置往往使得這個檔案顯得太複雜，因此一些開發者支援把babel的配置選項放在一個單獨的名為 “.babelrc” 的配置檔案中。我們現在的babel的配置並不算複雜，不過之後我們會再加一些東西，因此現在我們就提取出相關部分，分兩個配置檔案進行配置（webpack會自動呼叫.babelrc裡的babel配置選項），如下：

module.exports = {
    entry: __dirname + "/app/main.js",//已多次提及的唯一入口檔案
    output: {
        path: __dirname + "/public",//打包後的檔案存放的地方
        filename: "bundle.js"//打包後輸出檔案的檔名
    },
    devtool: `eval-source-map`,
    devServer: {
        contentBase: "./public",//本地伺服器所載入的頁面所在的目錄
        historyApiFallback: true,//不跳轉
        inline: true//實時重新整理
    },
    module: {
        rules: [
            {
                test: /(.jsx|.js)$/,
                use: {
                    loader: "babel-loader"
                },
                exclude: /node_modules/
            }
        ]
    }
};

//.babelrc
{
  "presets": ["react", "env"]
}

到目前為止，我們已經知道了，對於模組，Webpack能提供非常強大的處理功能，那那些是模組呢。

一切皆模組

Webpack有一個不可不說的優點，它把所有的檔案都都當做模組處理，JavaScript程式碼，CSS和fonts以及圖片等等通過合適的loader都可以被處理。

CSS

webpack提供兩個工具處理樣式表，css-loader 和 style-loader，二者處理的任務不同，css-loader使你能夠使用類似@import 和 url(...)的方法實現 require()的功能,style-loader將所有的計算後的樣式加入頁面中，二者組合在一起使你能夠把樣式表嵌入webpack打包後的JS檔案中。

繼續上面的例子

//安裝
npm install --save-dev style-loader css-loader
//使用
module.exports = {

   ...
    module: {
        rules: [
            {
                test: /(.jsx|.js)$/,
                use: {
                    loader: "babel-loader"
                },
                exclude: /node_modules/
            },
            {
                test: /.css$/,
                use: [
                    {
                        loader: "style-loader"
                    }, {
                        loader: "css-loader"
                    }
                ]
            }
        ]
    }
};

請注意這裡對同一個檔案引入多個loader的方法。

接下來，在app資料夾裡建立一個名字為”main.css”的檔案，對一些元素設定樣式

/* main.css */
html {
  box-sizing: border-box;
  -ms-text-size-adjust: 100%;
  -webkit-text-size-adjust: 100%;
}

*, *:before, *:after {
  box-sizing: inherit;
}

body {
  margin: 0;
  font-family: `Helvetica Neue`, Helvetica, Arial, sans-serif;
}

h1, h2, h3, h4, h5, h6, p, ul {
  margin: 0;
  padding: 0;
}

我們這裡例子中用到的webpack只有單一的入口，其它的模組需要通過 import, require, url等與入口檔案建立其關聯，為了讓webpack能找到”main.css“檔案，我們把它匯入”main.js “中，如下

//main.js
import React from `react`;
import {render} from `react-dom`;
import Greeter from `./Greeter`;

import `./main.css`;//使用require匯入css檔案

render(<Greeter />, document.getElementById(`root`));

通常情況下，css會和js打包到同一個檔案中，並不會打包為一個單獨的css檔案，不過通過合適的配置webpack也可以把css打包為單獨的檔案的。

上面的程式碼說明webpack是怎麼把css當做模組看待的，我們們繼續看一個更加真實的css模組實踐。

CSS module

在過去的一些年裡，JavaScript通過一些新的語言特性，更好的工具以及更好的實踐方法（比如說模組化）發展得非常迅速。模組使得開發者把複雜的程式碼轉化為小的，乾淨的，依賴宣告明確的單元，配合優化工具，依賴管理和載入管理可以自動完成。

不過前端的另外一部分，CSS發展就相對慢一些，大多的樣式表卻依舊巨大且充滿了全域性類名，維護和修改都非常困難。

被稱為CSS modules的技術意在把JS的模組化思想帶入CSS中來，通過CSS模組，所有的類名，動畫名預設都只作用於當前模組。Webpack對CSS模組化提供了非常好的支援，只需要在CSS loader中進行簡單配置即可，然後就可以直接把CSS的類名傳遞到元件的程式碼中，這樣做有效避免了全域性汙染。具體的程式碼如下

module.exports = {

    ...

    module: {
        rules: [
            {
                test: /(.jsx|.js)$/,
                use: {
                    loader: "babel-loader"
                },
                exclude: /node_modules/
            },
            {
                test: /.css$/,
                use: [
                    {
                        loader: "style-loader"
                    }, {
                        loader: "css-loader",
                        options: {
                            modules: true, // 指定啟用css modules
                            localIdentName: `[name]__[local]--[hash:base64:5]` // 指定css的類名格式
                        }
                    }
                ]
            }
        ]
    }
};

我們在app資料夾下建立一個Greeter.css檔案來進行一下測試

/* Greeter.css */
.root {
  background-color: #eee;
  padding: 10px;
  border: 3px solid #ccc;
}

匯入.root到Greeter.js中

import React, {Component} from `react`;
import config from `./config.json`;
import styles from `./Greeter.css`;//匯入

class Greeter extends Component{
  render() {
    return (
      <div className={styles.root}> //使用cssModule新增類名的方法
        {config.greetText}
      </div>
    );
  }
}

export default Greeter

放心使用把，相同的類名也不會造成不同元件之間的汙染。

10164445_e04D.png

應用了css module後的樣式

CSS modules 也是一個很大的主題，有興趣的話可以去其官方文件瞭解更多。

CSS前處理器

Sass 和 Less 之類的前處理器是對原生CSS的擴充，它們允許你使用類似於variables, nesting, mixins, inheritance等不存在於CSS中的特性來寫CSS，CSS前處理器可以這些特殊型別的語句轉化為瀏覽器可識別的CSS語句，

你現在可能都已經熟悉了，在webpack裡使用相關loaders進行配置就可以使用了，以下是常用的CSS 處理loaders:

  • Less Loader
  • Sass Loader
  • Stylus Loader

不過其實也存在一個CSS的處理平臺-PostCSS，它可以幫助你的CSS實現更多的功能，在其官方文件可瞭解更多相關知識。

舉例來說如何使用PostCSS，我們使用PostCSS來為CSS程式碼自動新增適應不同瀏覽器的CSS字首。

首先安裝postcss-loader 和 autoprefixer（自動新增字首的外掛）

npm install --save-dev postcss-loader autoprefixer

接下來，在webpack配置檔案中新增postcss-loader，在根目錄新建postcss.config.js,並新增如下程式碼之後，重新使用npm start打包時，你寫的css會自動根據Can i use裡的資料新增不同字首了。

//webpack.config.js
module.exports = {
    ...
    module: {
        rules: [
            {
                test: /(.jsx|.js)$/,
                use: {
                    loader: "babel-loader"
                },
                exclude: /node_modules/
            },
            {
                test: /.css$/,
                use: [
                    {
                        loader: "style-loader"
                    }, {
                        loader: "css-loader",
                        options: {
                            modules: true
                        }
                    }, {
                        loader: "postcss-loader"
                    }
                ]
            }
        ]
    }
}
// postcss.config.js
module.exports = {
    plugins: [
        require(`autoprefixer`)
    ]
}

至此，本文已經談論了處理JS的Babel和處理CSS的PostCSS的基本用法，它們其實也是兩個單獨的平臺，配合webpack可以很好的發揮它們的作用。接下來介紹Webpack中另一個非常重要的功能-Plugins

外掛（Plugins）

外掛（Plugins）是用來擴充Webpack功能的，它們會在整個構建過程中生效，執行相關的任務。
Loaders和Plugins常常被弄混，但是他們其實是完全不同的東西，可以這麼來說，loaders是在打包構建過程中用來處理原始檔的（JSX，Scss，Less..），一次處理一個，外掛並不直接操作單個檔案，它直接對整個構建過程其作用。

Webpack有很多內建外掛，同時也有很多第三方外掛，可以讓我們完成更加豐富的功能。

使用外掛的方法

要使用某個外掛，我們需要通過npm安裝它，然後要做的就是在webpack配置中的plugins關鍵字部分新增該外掛的一個例項（plugins是一個陣列）繼續上面的例子，我們新增了一個給打包後程式碼新增版權宣告的外掛。

const webpack = require(`webpack`);

module.exports = {
...
    module: {
        rules: [
            {
                test: /(.jsx|.js)$/,
                use: {
                    loader: "babel-loader"
                },
                exclude: /node_modules/
            },
            {
                test: /.css$/,
                use: [
                    {
                        loader: "style-loader"
                    }, {
                        loader: "css-loader",
                        options: {
                            modules: true
                        }
                    }, {
                        loader: "postcss-loader"
                    }
                ]
            }
        ]
    },
    plugins: [
        new webpack.BannerPlugin(`版權所有，翻版必究`)
    ],
};

通過這個外掛，打包後的JS檔案顯示如下

10164445_GJBj.png

版權所有，翻版必究

這就是webpack外掛的基礎用法了，下面給大家推薦幾個常用的外掛

HtmlWebpackPlugin

這個外掛的作用是依據一個簡單的index.html模板，生成一個自動引用你打包後的JS檔案的新index.html。這在每次生成的js檔名稱不同時非常有用（比如新增了hash值）。

安裝

npm install --save-dev html-webpack-plugin

這個外掛自動完成了我們之前手動做的一些事情，在正式使用之前需要對一直以來的專案結構做一些更改：

  1. 移除public資料夾，利用此外掛，index.html檔案會自動生成，此外CSS已經通過前面的操作打包到JS中了。
  2. 在app目錄下，建立一個index.tmpl.html檔案模板，這個模板包含title等必須元素，在編譯過程中，外掛會依據此模板生成最終的html頁面，會自動新增所依賴的 css, js，favicon等檔案，index.tmpl.html中的模板原始碼如下：

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <title>Webpack Sample Project</title>
  </head>
  <body>
    <div id=`root`>
    </div>
  </body>
</html>

3.更新webpack的配置檔案，方法同上,新建一個build資料夾用來存放最終的輸出檔案

const webpack = require(`webpack`);
const HtmlWebpackPlugin = require(`html-webpack-plugin`);

module.exports = {
    entry: __dirname + "/app/main.js",//已多次提及的唯一入口檔案
    output: {
        path: __dirname + "/build",
        filename: "bundle.js"
    },
    devtool: `eval-source-map`,
    devServer: {
        contentBase: "./public",//本地伺服器所載入的頁面所在的目錄
        historyApiFallback: true,//不跳轉
        inline: true//實時重新整理
    },
    module: {
        rules: [
            {
                test: /(.jsx|.js)$/,
                use: {
                    loader: "babel-loader"
                },
                exclude: /node_modules/
            },
            {
                test: /.css$/,
                use: [
                    {
                        loader: "style-loader"
                    }, {
                        loader: "css-loader",
                        options: {
                            modules: true
                        }
                    }, {
                        loader: "postcss-loader"
                    }
                ]
            }
        ]
    },
    plugins: [
        new webpack.BannerPlugin(`版權所有，翻版必究`),
        new HtmlWebpackPlugin({
            template: __dirname + "/app/index.tmpl.html"//new 一個這個外掛的例項，並傳入相關的引數
        })
    ],
};

再次執行npm start你會發現，build資料夾下面生成了bundle.js和index.html。

10164446_5W46.png

build資料夾

Hot Module Replacement

Hot Module Replacement（HMR）也是webpack裡很有用的一個外掛，它允許你在修改元件程式碼後，自動重新整理實時預覽修改後的效果。

在webpack中實現HMR也很簡單，只需要做兩項配置

  1. 在webpack配置檔案中新增HMR外掛；
  2. 在Webpack Dev Server中新增“hot”引數；

不過配置完這些後，JS模組其實還是不能自動熱載入的，還需要在你的JS模組中執行一個Webpack提供的API才能實現熱載入，雖然這個API不難使用，但是如果是React模組，使用我們已經熟悉的Babel可以更方便的實現功能熱載入。

整理下我們的思路，具體實現方法如下

  • Babel和webpack是獨立的工具
  • 二者可以一起工作
  • 二者都可以通過外掛擴充功能
  • HMR是一個webpack外掛，它讓你能瀏覽器中實時觀察模組修改後的效果，但是如果你想讓它工作，需要對模組進行額外的配額；
  • Babel有一個叫做react-transform-hrm的外掛，可以在不對React模組進行額外的配置的前提下讓HMR正常工作；

還是繼續上例來實際看看如何配置

const webpack = require(`webpack`);
const HtmlWebpackPlugin = require(`html-webpack-plugin`);

module.exports = {
    entry: __dirname + "/app/main.js",//已多次提及的唯一入口檔案
    output: {
        path: __dirname + "/build",
        filename: "bundle.js"
    },
    devtool: `eval-source-map`,
    devServer: {
        contentBase: "./public",//本地伺服器所載入的頁面所在的目錄
        historyApiFallback: true,//不跳轉
        inline: true,
        hot: true
    },
    module: {
        rules: [
            {
                test: /(.jsx|.js)$/,
                use: {
                    loader: "babel-loader"
                },
                exclude: /node_modules/
            },
            {
                test: /.css$/,
                use: [
                    {
                        loader: "style-loader"
                    }, {
                        loader: "css-loader",
                        options: {
                            modules: true
                        }
                    }, {
                        loader: "postcss-loader"
                    }
                ]
            }
        ]
    },
    plugins: [
        new webpack.BannerPlugin(`版權所有，翻版必究`),
        new HtmlWebpackPlugin({
            template: __dirname + "/app/index.tmpl.html"//new 一個這個外掛的例項，並傳入相關的引數
        }),
        new webpack.HotModuleReplacementPlugin()//熱載入外掛
    ],
};

安裝react-transform-hmr

npm install --save-dev babel-plugin-react-transform react-transform-hmr

配置Babel

// .babelrc
{
  "presets": ["react", "env"],
  "env": {
    "development": {
    "plugins": [["react-transform", {
       "transforms": [{
         "transform": "react-transform-hmr",
         
         "imports": ["react"],
         
         "locals": ["module"]
       }]
     }]]
    }
  }
}

現在當你使用React時，可以熱載入模組了,每次儲存就能在瀏覽器上看到更新內容。

產品階段的構建

目前為止，我們已經使用webpack構建了一個完整的開發環境。但是在產品階段，可能還需要對打包的檔案進行額外的處理，比如說優化，壓縮，快取以及分離CSS和JS。

對於複雜的專案來說，需要複雜的配置，這時候分解配置檔案為多個小的檔案可以使得事情井井有條，以上面的例子來說，我們建立一個webpack.production.config.js的檔案，在裡面加上基本的配置,它和原始的webpack.config.js很像，如下

// webpack.production.config.js
const webpack = require(`webpack`);
const HtmlWebpackPlugin = require(`html-webpack-plugin`);

module.exports = {
    entry: __dirname + "/app/main.js", //已多次提及的唯一入口檔案
    output: {
        path: __dirname + "/build",
        filename: "bundle.js"
    },
    devtool: `null`, //注意修改了這裡，這能大大壓縮我們的打包程式碼
    devServer: {
        contentBase: "./public", //本地伺服器所載入的頁面所在的目錄
        historyApiFallback: true, //不跳轉
        inline: true,
        hot: true
    },
    module: {
        rules: [{
            test: /(.jsx|.js)$/,
            use: {
                loader: "babel-loader"
            },
            exclude: /node_modules/
        }, {
            test: /.css$/,
            use: ExtractTextPlugin.extract({
                fallback: "style-loader",
                use: [{
                    loader: "css-loader",
                    options: {
                        modules: true
                    }
                }, {
                    loader: "postcss-loader"
                }],
            })
        }]
    },
    plugins: [
        new webpack.BannerPlugin(`版權所有，翻版必究`),
        new HtmlWebpackPlugin({
            template: __dirname + "/app/index.tmpl.html" //new 一個這個外掛的例項，並傳入相關的引數
        }),
        new webpack.HotModuleReplacementPlugin() //熱載入外掛
    ],
};
//package.json
{
  "name": "test",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo "Error: no test specified" && exit 1",
    "start": "webpack",
    "server": "webpack-dev-server --open",
    "build": "NODE_ENV=production webpack --config ./webpack.production.config.js --progress"
  },
  "author": "",
  "license": "ISC",
  "devDependencies": {
...
  },
  "dependencies": {
    "react": "^15.6.1",
    "react-dom": "^15.6.1"
  }
}

注意:如果是window電腦，build需要配置為"build": "set NODE_ENV=production && webpack --config ./webpack.production.config.js --progress".謝謝評論區簡友提醒。

優化外掛

webpack提供了一些在釋出階段非常有用的優化外掛，它們大多來自於webpack社群，可以通過npm安裝，通過以下外掛可以完成產品釋出階段所需的功能

  • OccurenceOrderPlugin :為元件分配ID，通過這個外掛webpack可以分析和優先考慮使用最多的模組，併為它們分配最小的ID
  • UglifyJsPlugin：壓縮JS程式碼；
  • ExtractTextPlugin：分離CSS和JS檔案

我們繼續用例子來看看如何新增它們，OccurenceOrder 和 UglifyJS plugins 都是內建外掛，你需要做的只是安裝其它非內建外掛

npm install --save-dev extract-text-webpack-plugin

在配置檔案的plugins後引用它們

// webpack.production.config.js
const webpack = require(`webpack`);
const HtmlWebpackPlugin = require(`html-webpack-plugin`);
const ExtractTextPlugin = require(`extract-text-webpack-plugin`);

module.exports = {
    entry: __dirname + "/app/main.js",//已多次提及的唯一入口檔案
    output: {
        path: __dirname + "/build",
        filename: "bundle.js"
    },
    devtool: `none`,
    devServer: {
        contentBase: "./public",//本地伺服器所載入的頁面所在的目錄
        historyApiFallback: true,//不跳轉
        inline: true,
        hot: true
    },
    module: {
        rules: [
            {
                test: /(.jsx|.js)$/,
                use: {
                    loader: "babel-loader"
                },
                exclude: /node_modules/
            },
            {
                test: /.css$/,
                use: [
                    {
                        loader: "style-loader"
                    }, {
                        loader: "css-loader",
                        options: {
                            modules: true
                        }
                    }, {
                        loader: "postcss-loader"
                    }
                ]
            }
        ]
    },
    plugins: [
        new webpack.BannerPlugin(`版權所有，翻版必究`),
        new HtmlWebpackPlugin({
            template: __dirname + "/app/index.tmpl.html"
        }),
        new webpack.optimize.OccurrenceOrderPlugin(),
        new webpack.optimize.UglifyJsPlugin(),
        new ExtractTextPlugin("style.css")
    ],
};

此時執行npm run build可以看見程式碼是被壓縮後的

10164446_376R.png

壓縮後的程式碼

快取

快取無處不在，使用快取的最好方法是保證你的檔名和檔案內容是匹配的（內容改變，名稱相應改變）

webpack可以把一個雜湊值新增到打包的檔名中，使用方法如下,新增特殊的字串混合體（[name], [id] and [hash]）到輸出檔名前

const webpack = require(`webpack`);
const HtmlWebpackPlugin = require(`html-webpack-plugin`);
const ExtractTextPlugin = require(`extract-text-webpack-plugin`);

module.exports = {
..
    output: {
        path: __dirname + "/build",
        filename: "bundle-[hash].js"
    },
   ...
};

現在使用者會有合理的快取了。

10164446_GVkp.png

帶hash值的js名

去除build檔案中的殘餘檔案

新增了hash之後，會導致改變檔案內容後重新打包時，檔名不同而內容越來越多，因此這裡介紹另外一個很好用的外掛clean-webpack-plugin。

安裝：
cnpm install clean-webpack-plugin --save-dev

使用：

引入clean-webpack-plugin外掛後在配置檔案的plugins中做相應配置即可：

const CleanWebpackPlugin = require("clean-webpack-plugin");
  plugins: [
    ...// 這裡是之前配置的其它各種外掛
    new CleanWebpackPlugin(`build/*.*`, {
      root: __dirname,
      verbose: true,
      dry: false
  })
  ]

關於clean-webpack-plugin的詳細使用可參考這裡

總結

其實這是一年前的文章了，趁週末重新執行和修改了一下，現在所有的程式碼都可以正常執行，所用webpack基於最新的webpack3.5.3。希望依舊能對你有幫助。

這是一篇好長的文章，謝謝你的耐心，能仔細看到了這裡，大概半個月前我第一次自己一步步配置專案所需的Webpack後就一直想寫一篇筆記做總結，幾次動筆都不能讓自己滿意，總覺得寫不清楚。其實關於Webpack本文講述得仍不完全，不過相信你看完後已經進入Webpack的大門，能夠更好的探索其它的關於Webpack的知識了。

歡迎大家在文後發表自己的觀點討論。

更新說明

2017-12-11更新，修改css module部分程式碼及示例圖片，css module真的非常好用，希望大家都能用上。

2017年9月18日更新，新增了一個使用webpack配置多頁應用的demo,可以點選此處檢視

2017年8月13日更新，本文依據webpack3.5.3將文章涉及程式碼完全重寫，所有程式碼都在Mac上正常執行過。希望依舊對你學習webpack有幫助。

2017年8月16號更新：
最近在Gitchat上將發起了一場關於webpack的分享，目的在於一起花最短的時間理解和學會webpack，感興趣的童鞋可以微信掃描註冊哈。

原文釋出時間為：2018年01月10日
原文作者：AlvinJw 

本文來源：開源中國 如需轉載請聯絡原作者


相關文章