webpack 入門

什么是 webpack?

webpack是近期最火的一款模塊加載器兼打包工具训堆,它能把各種資源描验,例如JS(含JSX)、coffee坑鱼、樣式(含less/sass)膘流、圖片等都作為模塊來使用和處理。

我們可以直接使用 require(XXX) 的形式來引入各模塊鲁沥,即使它們可能需要經(jīng)過編譯(比如JSX和sass)呼股,但我們無須在上面花費太多心思,因為 webpack 有著各種健全的加載器(loader)在默默處理這些事情画恰,這塊我們后續(xù)會提到彭谁。

你可以不打算將其用在你的項目上,但沒有理由不去掌握它允扇,因為以近期 Github 上各大主流的(React相關)項目來說缠局,它們倉庫上所展示的示例已經(jīng)是基于 webpack 來開發(fā)的,比如 React-Boostrap 和 Redux考润。

webpack的官網(wǎng)是 http://webpack.github.io/ 狭园,文檔地址是 http://webpack.github.io/docs/ ,想對其進行更詳細了解的可以點進去瞧一瞧糊治。

webpack 的優(yōu)勢

其優(yōu)勢主要可以歸類為如下幾個:

  1. webpack 是以 commonJS 的形式來書寫腳本滴唱矛,但對 AMD/CMD 的支持也很全面,方便舊項目進行代碼遷移井辜。
  2. 能被模塊化的不僅僅是 JS 了绎谦。
  3. 開發(fā)便捷,能替代部分 grunt/gulp 的工作粥脚,比如打包窃肠、壓縮混淆、圖片轉base64等阿逃。
  4. 擴展性強铭拧,插件機制完善,特別是支持 React 熱插拔(見 react-hot-loader )的功能讓人眼前一亮恃锉。
    我們談談第一點搀菩。以 AMD/CMD 模式來說,鑒于模塊是異步加載的破托,所以我們常規(guī)需要使用 define 函數(shù)來幫我們搞回調:
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();
};

這樣自然更簡單谜洽,不過即使你保留了之前 define 的寫法也是可以滴,畢竟 webpack 的兼容性相當出色吴叶,方便你舊項目的模塊直接遷移過來阐虚。

安裝和配置

安裝

我們常規(guī)直接使用 npm 的形式來安裝:

$ npm install webpack -g

當然如果常規(guī)項目還是把依賴寫入 package.json 包去更人性化:

$ npm init$ npm install webpack --save-dev

配置

每個項目下都必須配置有一個 webpack.config.js ,它的作用如同常規(guī)的 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",
    //支持數(shù)組形式审胸,將加載數(shù)組中的所有模塊,但以最后一個模塊作為輸出        
    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
配置信息的參數(shù)“?limit=8192”表示將所有小于8kb的圖片都轉為base64形式(其實應該說超過8kb的才使用 url-loader 來映射到文件挣菲,否則轉為data url形式)
⑷ 最后是 resolve 配置掷邦,這塊很好理解白胀,直接寫注釋了:

resolve: {
    //查找module的話從這里開始查找  
    root:'E:/github/flux-example/src',
    //絕對路徑        
    //自動擴展文件后綴名,意味著我們require模塊可以省略不寫后綴名     
    extensions: ['','.js','.json','.scss'],
    //模塊別名定義抚岗,方便后續(xù)直接引用別名或杠,無須多寫長長的地址
    alias: {         
      AppStore :'js/stores/AppStores.js',
      //后續(xù)直接 require('AppStore') 即可      
     ActionType :'js/actions/ActionType.js',           
     AppAction :'js/actions/AppAction.js'
    }   
}

關于 webpack.config.js 更詳盡的配置可以參考這里

運行 webpack

webpack 的執(zhí)行也很簡單宣蔚,直接執(zhí)行

$ webpack --display-error-details

即可向抢,后面的參數(shù)“--display-error-details”是推薦加上的认境,方便出錯時能查閱更詳盡的信息(比如 webpack 尋找模塊的過程),從而更好定位到問題挟鸠。
其他主要的參數(shù)有:

$ webpack --config XXX.js  
//使用另一份配置文件(比如webpack.config2.js)來打包

$ webpack --watch  
//監(jiān)聽變動并自動打包

$ webpack -p   
//壓縮混淆腳本叉信,這個非常非常重要!

$ webpack -d   
//生成map映射文件艘希,告知哪些模塊被最終打包到哪里了

其中的 -p 是很重要的參數(shù)茉盏,曾經(jīng)一個未壓縮的 700kb 的文件,壓縮后直接降到 180kb(主要是樣式這塊一句就獨占一行腳本枢冤,導致未壓縮腳本變得很大)鸠姨。
模塊引入
上面嘮嗑了那么多配置和執(zhí)行方法,下面開始說說尋常頁面和腳本怎么使用唄淹真。

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>

可以看到我們連樣式都不用引入,畢竟腳本執(zhí)行時會動態(tài)生成<style>并標簽打到head里核蘸。

JS

各腳本模塊可以直接使用 commonJS 來書寫巍糯,并可以直接引入未經(jīng)編譯的模塊,比如 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
);

一切就是這么簡單么么噠~ 后續(xù)各種有的沒的徙鱼,webpack 都會幫你進行處理宅楞。

其他

至此我們已經(jīng)基本上手了 webpack 的使用,下面是補充一些有用的技巧袱吆。

shimming

在 AMD/CMD 中厌衙,我們需要對不符合規(guī)范的模塊(比如一些直接返回全局變量的插件)進行 shim 處理,這時候我們需要使用 exports-loader 來幫忙:

{ test: require.resolve("./src/js/tool/swipe.js"), loader: "exports?swipe"}

之后在腳本中需要引用該模塊的時候绞绒,這么簡單地來使用就可以了:

require('./tool/swipe.js');swipe(); 

自定義公共模塊提取

在文章開始我們使用了 CommonsChunkPlugin 插件來提取多個頁面之間的公共模塊婶希,并將該模塊打包為 common.js 。
但有時候我們希望能更加個性化一些蓬衡,我們可以這樣配置:

var CommonsChunkPlugin = require("webpack/lib/optimize/CommonsChunkPlugin");
module.exports = {  
entry: {      
    p1:"./page1",
    p2: "./page2",   
    p3:"./page3",
    ap1:"./admin/page1",
    ap2:"./admin/page2"   
},
    
  output: {       
    filename:"[name].js"   
  },
  
  plugins: [     
    new CommonsChunkPlugin("admin-commons.js", ["ap1","ap2"]),
    new CommonsChunkPlugin("commons.js", ["p1","p2","admin-commons.js"])    
  ]

};

// <script>s required:
// page1.html: commons.js, p1.js
// page2.html: commons.js, p2.js
// page3.html: p3.js
// admin-page1.html: commons.js, admin-commons.js, ap1.js
// admin-page2.html: commons.js, admin-commons.js, ap2.js

獨立打包樣式文件

有時候可能希望項目的樣式能不要被打包到腳本中喻杈,而是獨立出來作為.css,然后在頁面中以<link>標簽引入狰晚。這時候我們需要 extract-text-webpack-plugin 來幫忙:

var webpack = require('webpack');
  
var commonsPlugin = new webpack.optimize.CommonsChunkPlugin(
'common.js'
);

    
var ExtractTextPlugin = require(
  "extract-text-webpack-plugin"
);
 
module.exports = {

        
plugins: [commonsPlugin, new ExtractTextPlugin(
"[name].css"
)],
     
entry: {   
//...省略其它配置

最終 webpack 執(zhí)行后會乖乖地把樣式文件提取出來:



四. 使用CDN/遠程文件
有時候我們希望某些模塊走CDN并以<script>的形式掛載到頁面上來加載筒饰,但又希望能在 webpack 的模塊中使用上。
這時候我們可以在配置文件里使用 externals 屬性來幫忙:

{  
  externals: {   
     // require("jquery") 是引用自外部模塊的      
    // 對應全局變量 jQuery      
    "jquery":"jQuery"  
  }
}

需要留意的是家肯,得確保 CDN 文件必須在 webpack 打包文件引入之前先引入龄砰。
我們倒也可以使用 script.js 在腳本中來加載我們的模塊:

var $script = require(
"scriptjs"
);

$script(
    "http://ajax.googleapis.com/ajax/libs/jquery/2.0.0/jquery.min.js",
    function() { 
  $('body').html(
      'It works!'
  )

});

五. 與 grunt/gulp 配合
以 gulp 為示例,我們可以這樣混搭:

gulp.task(
"webpack"
,
function
(callback) {

    
// run webpack

    
webpack({  // configuration   },function(err, stats) {
   if(err)
         throw new gutil.PluginError("webpack", err);       
         gutil.log("[webpack]", stats.toString({            
        // output options    
  }));     
  callback();  
});
});

當然我們只需要把配置寫到 webpack({ ... }) 中去即可,無須再寫 webpack.config.js 了换棚。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末式镐,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子固蚤,更是在濱河造成了極大的恐慌娘汞,老刑警劉巖,帶你破解...
    沈念sama閱讀 210,914評論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件夕玩,死亡現(xiàn)場離奇詭異你弦,居然都是意外死亡,警方通過查閱死者的電腦和手機燎孟,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 89,935評論 2 383
  • 文/潘曉璐 我一進店門禽作,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人揩页,你說我怎么就攤上這事旷偿。” “怎么了爆侣?”我有些...
    開封第一講書人閱讀 156,531評論 0 345
  • 文/不壞的土叔 我叫張陵萍程,是天一觀的道長。 經(jīng)常有香客問我兔仰,道長茫负,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 56,309評論 1 282
  • 正文 為了忘掉前任乎赴,我火速辦了婚禮忍法,結果婚禮上,老公的妹妹穿的比我還像新娘无虚。我一直安慰自己缔赠,他們只是感情好,可當我...
    茶點故事閱讀 65,381評論 5 384
  • 文/花漫 我一把揭開白布友题。 她就那樣靜靜地躺著,像睡著了一般戴质。 火紅的嫁衣襯著肌膚如雪度宦。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,730評論 1 289
  • 那天告匠,我揣著相機與錄音戈抄,去河邊找鬼。 笑死后专,一個胖子當著我的面吹牛划鸽,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 38,882評論 3 404
  • 文/蒼蘭香墨 我猛地睜開眼裸诽,長吁一口氣:“原來是場噩夢啊……” “哼嫂用!你這毒婦竟也來了?” 一聲冷哼從身側響起丈冬,我...
    開封第一講書人閱讀 37,643評論 0 266
  • 序言:老撾萬榮一對情侶失蹤嘱函,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后埂蕊,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體往弓,經(jīng)...
    沈念sama閱讀 44,095評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 36,448評論 2 325
  • 正文 我和宋清朗相戀三年蓄氧,在試婚紗的時候發(fā)現(xiàn)自己被綠了函似。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 38,566評論 1 339
  • 序言:一個原本活蹦亂跳的男人離奇死亡喉童,死狀恐怖撇寞,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情泄朴,我是刑警寧澤重抖,帶...
    沈念sama閱讀 34,253評論 4 328
  • 正文 年R本政府宣布,位于F島的核電站祖灰,受9級特大地震影響钟沛,放射性物質發(fā)生泄漏。R本人自食惡果不足惜局扶,卻給世界環(huán)境...
    茶點故事閱讀 39,829評論 3 312
  • 文/蒙蒙 一恨统、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧三妈,春花似錦畜埋、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,715評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至模燥,卻和暖如春咖祭,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背蔫骂。 一陣腳步聲響...
    開封第一講書人閱讀 31,945評論 1 264
  • 我被黑心中介騙來泰國打工么翰, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人辽旋。 一個月前我還...
    沈念sama閱讀 46,248評論 2 360
  • 正文 我出身青樓浩嫌,卻偏偏與公主長得像檐迟,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子码耐,可洞房花燭夜當晚...
    茶點故事閱讀 43,440評論 2 348

推薦閱讀更多精彩內容

  • 1.為什么要使用webpack 現(xiàn)今的很多網(wǎng)頁其實可以看做是功能豐富的應用追迟,它們擁有著復雜的JavaScript代...
    YINdevelop閱讀 500評論 0 5
  • 前言 眾所周知目前比較火的工具就是gulp和webpack,但webpack和gulp卻有所不同伐坏,本人兩者的底層研...
    cduyzh閱讀 1,362評論 0 13
  • Webpack 第一章 Webpack 簡介 Instagram團隊在進行前端開發(fā)的過程中怔匣,發(fā)現(xiàn)當項目組成員越來越...
    whitsats閱讀 623評論 0 1
  • 白陽信用社關于五一勞動節(jié)的倡議 在“五一”國際勞動節(jié)到來之際,白陽信用社利用桦沉,利用晨會時間每瞒,對社內所有員工發(fā)起了關...
    蓑舟雪燈晚閱讀 252評論 0 0