什麼是 webpack。
webpack是近期最火的一款模組載入器兼打包工具,它能把各種資源,例如JS(含JSX)、coffee、樣式(含less/sass)、圖片等都作為模組來使用和處理。
我們可以直接使用 require(XXX) 的形式來引入各模組,即使它們可能需要經過編譯(比如JSX和sass),但我們無須在上面花費太多心思,因為 webpack 有著各種健全的載入器(loader)在默默處理這些事情,這塊我們後續會提到。
你可以不打算將其用在你的項目上,但沒有理由不去掌握它,因為以近期 Github 上各大主流的(React相關)項目來說,它們倉庫上所展示的樣本已經是基於 webpack 來開發的,比如 React-Boostrap 和 Redux。
webpack的官網是 http://webpack.github.io/ ,文檔地址是 http://webpack.github.io/docs/ ,想對其進行更詳細瞭解的可以點進去瞧一瞧。
webpack 的優勢
其優勢主要可以歸類為如下幾個:
1. webpack 是以 commonJS 的形式來書寫指令碼滴,但對 AMD/CMD 的支援也很全面,方便舊項目進行代碼遷移。
2. 能被模組化的不僅僅是 JS 了。
3. 開發便捷,能替代部分 grunt/gulp 的工作,比如打包、壓縮混淆、圖片轉base64等。
4. 擴充性強,外掛程式機制完善,特別是支援 React 熱插拔(見 react-hot-loader )的功能讓人眼前一亮。
我們談談第一點。以 AMD/CMD 模式來說,鑒於模組是非同步載入的,所以我們常規需要使用 define 函數來幫我們搞回調:
define(['package/lib'], function(lib){ function foo(){ lib.log('hello world!'); } return { foo: foo };});
另外為了可以相容 commonJS 的寫法,我們也可以將 define 這麼寫:
define(function (require, exports, module){ var someModule = require("someModule"); var anotherModule = require("anotherModule"); someModule.doTehAwesome(); anotherModule.doMoarAwesome(); exports.asplode = function (){ someModule.doTehAwesome(); anotherModule.doMoarAwesome(); };});
然而對 webpack 來說,我們可以直接在上面書寫 commonJS 形式的文法,無須任何 define (畢竟最終模組都打包在一起,webpack 也會最終自動加上自己的載入器):
var someModule = require("someModule"); var anotherModule = require("anotherModule"); someModule.doTehAwesome(); anotherModule.doMoarAwesome(); exports.asplode = function (){ someModule.doTehAwesome(); anotherModule.doMoarAwesome(); };
這樣擼碼自然更簡單,跟回調神馬的說 byebye~
不過即使你保留了之前 define 的寫法也是可以滴,畢竟 webpack 的相容性相當出色,方便你舊項目的模組隨即轉移過來。
安裝和配置
一. 安裝
我們常規直接使用 npm 的形式來安裝:
$ npm install webpack -g
當然如果常規項目還是把依賴寫入 package.json 包去更人性化:
$ npm init
$ npm install webpack --save-dev
二. 配置
每個項目下都必須配置有一個 webpack.config.js ,它的作用如同常規的 gulpfile.js/Gruntfile.js ,就是一個配置項,告訴 webpack 它需要做什麼。
我們看看下方的樣本:
var webpack = require('webpack');var commonsPlugin = new webpack.optimize.CommonsChunkPlugin('common.js');module.exports = { //外掛程式項 plugins: [commonsPlugin], //頁面入口檔案配置 entry: { index : './src/js/page/index.js' }, //入口檔案輸出配置 output: { path: 'dist/js/page', filename: '[name].js' }, module: { //載入器配置 loaders: [ { test: /\.css$/, loader: 'style-loader!css-loader' }, { test: /\.js$/, loader: 'jsx-loader?harmony' }, { test: /\.scss$/, loader: 'style!css!sass?sourceMap'}, { test: /\.(png|jpg)$/, loader: 'url-loader?limit=8192'} ] }, //其它解決方案配置 resolve: { root: 'E:/github/flux-example/src', //絕對路徑 extensions: ['', '.js', '.json', '.scss'], alias: { AppStore : 'js/stores/AppStores.js', ActionType : 'js/actions/ActionType.js', AppAction : 'js/actions/AppAction.js' } }};
⑴ plugins 是外掛程式項,這裡我們使用了一個 CommonsChunkPlugin 的外掛程式,它用於提取多個入口檔案的公用指令碼部分,然後產生一個 common.js 來方便多頁面之間進行複用。
⑵ entry 是頁面入口檔案配置,output 是對應輸出項配置(即入口檔案最終要產生什麼名字的檔案、存放到哪裡),其文法大致為:
{ entry: { page1: "./page1", //支援數組形式,將載入數組中的所有模組,但以最後一個模組作為輸出 page2: ["./entry1", "./entry2"] }, output: { path: "dist/js/page", filename: "[name].bundle.js" }}
該段代碼最終會產生一個 page1.bundle.js 和 page2.bundle.js,並存放到 ./dist/js/page 檔案夾下。
⑶ module.loaders 是最關鍵的一塊配置。它告知 webpack 每一種檔案都需要使用什麼載入器來處理:
module: { //載入器配置 loaders: [ //.css 檔案使用 style-loader 和 css-loader 來處理 { test: /\.css$/, loader: 'style-loader!css-loader' }, //.js 檔案使用 jsx-loader 來編譯處理 { test: /\.js$/, loader: 'jsx-loader?harmony' }, //.scss 檔案使用 style-loader、css-loader 和 sass-loader 來編譯處理 { test: /\.scss$/, loader: 'style!css!sass?sourceMap'}, //圖片檔案使用 url-loader 來處理,小於8kb的直接轉為base64 { test: /\.(png|jpg)$/, loader: 'url-loader?limit=8192'} ] }
如上,"-loader"其實是可以省略不寫的,多個loader之間用“!”串連起來。
注意所有的載入器都需要通過 npm 來載入,並建議查閱它們對應的 readme 來看看如何使用。
拿最後一個 url-loader 來說,它會將樣式中引用到的圖片轉為模組來處理,使用該載入器需要先進行安裝:
npm install url-loader -save-dev
配置資訊的參數“?limit=8192”表示將所有小於8kb的圖片都轉為base64形式(其實應該說超過8kb的才使用 url-loader 來映射到檔案,否則轉為data url形式)。
⑷ 最後是 resolve 配置,這塊很好理解,直接寫注釋了:
resolve: { //尋找module的話從這裡開始尋找 root: 'E:/github/flux-example/src', //絕對路徑 //自動擴充檔案尾碼名,意味著我們require模組可以省略不寫尾碼名 extensions: ['', '.js', '.json', '.scss'], //模組別名定義,方便後續直接引用別名,無須多寫長長的地址 alias: { AppStore : 'js/stores/AppStores.js',//後續直接 require('AppStore') 即可 ActionType : 'js/actions/ActionType.js', AppAction : 'js/actions/AppAction.js' } }
關於 webpack.config.js 更詳盡的配置可以參考這裡。
運行 webpack
webpack 的執行也很簡單,直接執行
$ webpack --display-error-details
即可,後面的參數“--display-error-details”是推薦加上的,方便出錯時能查閱更詳盡的資訊(比如 webpack 尋找模組的過程),從而更好定位到問題。
其他主要的參數有:
$ webpack --config XXX.js //使用另一份設定檔(比如webpack.config2.js)來打包$ webpack --watch //監聽變動並自動打包$ webpack -p //壓縮混淆指令碼,這個非常非常重要。$ webpack -d //產生map對應檔,告知哪些模組被最終打包到哪裡了
其中的 -p 是很重要的參數,曾經一個未壓縮的 700kb 的檔案,壓縮後直接降到 180kb(主要是樣式這塊一句就獨佔一行指令碼,導致未壓縮指令碼變得很大)。
模組引入
上面嘮嗑了那麼多配置和執行方法,下面開始說說尋常頁面和指令碼怎麼使用唄。
一. HTML
直接在頁面引入 webpack 最終產生的頁面指令碼即可,不用再寫什麼 data-main 或 seajs.use 了:
<!DOCTYPE html><html><head lang="en"> <meta charset="UTF-8"> <title>demo</title></head><body> <script src="dist/js/page/common.js"></script> <script src="dist/js/page/index.js"></script></body></html>
可以看到我們連樣式都不用引入,畢竟指令碼執行時會動態產生<style>並標籤打到head裡。
二. JS
各指令碼模組可以直接使用 commonJS 來書寫,並可以直接引入未經編譯的模組,比如 JSX、sass、coffee等(只要你在 webpack.config.js 裡配置好了對應的載入器)。
我們再看看編譯前的頁面入口檔案(index.js):
require('../../css/reset.scss'); //載入初始化樣式require('../../css/allComponent.scss'); //載入組件樣式var React = require('react');var AppWrap = require('../component/AppWrap'); //載入組件var createRedux = require('redux').createRedux;var Provider = require('redux/react').Provider;var stores = require('AppStore');var redux = createRedux(stores);var App = React.createClass({ render: function() { return ( <Provider redux={redux}> {function() { return <AppWrap />; }} </Provider> ); }});React.render( <App />, document.body);