webpack入門指南(轉)

什麼是 webpack?css

webpack是近期最火的一款模塊加載器兼打包工具,它能把各類資源,例如JS(含JSX)、coffee、樣式(含less/sass)、圖片等都做爲模塊來使用和處理。html

咱們能夠直接使用 require(XXX) 的形式來引入各模塊,即便它們可能須要通過編譯(好比JSX和sass),但咱們無須在上面花費太多心思,由於 webpack 有着各類健全的加載器(loader)在默默處理這些事情,這塊咱們後續會提到。react

你能夠不打算將其用在你的項目上,但沒有理由不去掌握它,由於以近期 Github 上各大主流的(React相關)項目來講,它們倉庫上所展現的示例已是基於 webpack 來開發的,好比 React-Boostrap 和 Redux。jquery

webpack的官網是 http://webpack.github.io/ ,文檔地址是 http://webpack.github.io/docs/ ,想對其進行更詳細瞭解的能夠點進去瞧一瞧。webpack

webpack 的優點git

其優點主要能夠歸類爲以下幾個:github

1. webpack 是以 commonJS 的形式來書寫腳本滴,但對 AMD/CMD 的支持也很全面,方便舊項目進行代碼遷移。web

2. 能被模塊化的不只僅是 JS 了。ajax

3. 開發便捷,能替代部分 grunt/gulp 的工做,好比打包、壓縮混淆、圖片轉base64等。npm

4. 擴展性強,插件機制完善,特別是支持 React 熱插拔(見 react-hot-loader )的功能讓人眼前一亮。

咱們談談第一點。以 AMD/CMD 模式來講,鑑於模塊是異步加載的,因此咱們常規須要使用 define 函數來幫咱們搞回調:

1
2
3
4
5
6
7
8
define([ 'package/lib' ], function (lib){
     function foo(){
         lib.log( 'hello world!' );
     }
     return {
         foo: foo
     };
});

另外爲了能夠兼容 commonJS 的寫法,咱們也能夠將 define 這麼寫:

1
2
3
4
5
6
7
8
9
10
11
12
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 也會最終自動加上本身的加載器):

1
2
3
4
5
6
7
8
9
10
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 它須要作什麼。

咱們看看下方的示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
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 是對應輸出項配置(即入口文件最終要生成什麼名字的文件、存放到哪裏),其語法大體爲:

1
2
3
4
5
6
7
8
9
10
11
{
     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 每一種文件都須要使用什麼加載器來處理:

1
2
3
4
5
6
7
8
9
10
11
12
13
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 配置,這塊很好理解,直接寫註釋了:

1
2
3
4
5
6
7
8
9
10
11
12
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 尋找模塊的過程),從而更好定位到問題。

其餘主要的參數有:

1
2
3
4
5
6
7
$ webpack --config XXX.js   //使用另外一份配置文件(好比webpack.config2.js)來打包
 
$ webpack --watch   //監聽變更並自動打包
 
$ webpack -p    //壓縮混淆腳本,這個很是很是重要!
 
$ webpack -d    //生成map映射文件,告知哪些模塊被最終打包到哪裏了

其中的 -p 是很重要的參數,曾經一個未壓縮的 700kb 的文件,壓縮後直接降到 180kb(主要是樣式這塊一句就獨佔一行腳本,致使未壓縮腳本變得很大)

模塊引入

上面嘮嗑了那麼多配置和執行方法,下面開始說說尋常頁面和腳本怎麼使用唄。

一. HTML

直接在頁面引入 webpack 最終生成的頁面腳本便可,不用再寫什麼 data-main 或 seajs.use 了:

1
2
3
4
5
6
7
8
9
10
11
<!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):

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
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
);

一切就是這麼簡單麼麼噠~ 後續各類有的沒的,webpack 都會幫你進行處理。

其餘

至此咱們已經基本上手了 webpack 的使用,下面是補充一些有用的技巧。

一. shimming

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

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

以後在腳本中須要引用該模塊的時候,這麼簡單地來使用就能夠了:

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

二. 自定義公共模塊提取

在文章開始咱們使用了 CommonsChunkPlugin 插件來提取多個頁面之間的公共模塊,並將該模塊打包爲 common.js 。

但有時候咱們但願能更加個性化一些,咱們能夠這樣配置:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
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 來幫忙:

1
2
3
4
5
6
7
8
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 執行後會乖乖地把樣式文件提取出來:

四. 使用CDN/遠程文件

有時候咱們但願某些模塊走CDN並以<script>的形式掛載到頁面上來加載,但又但願能在 webpack 的模塊中使用上。

這時候咱們能夠在配置文件裏使用 externals 屬性來幫忙:

1
2
3
4
5
6
7
{
     externals: {
         // require("jquery") 是引用自外部模塊的
         // 對應全局變量 jQuery
         "jquery" : "jQuery"
     }
}

須要留意的是,得確保 CDN 文件必須在 webpack 打包文件引入以前先引入。

咱們倒也可使用 script.js 在腳本中來加載咱們的模塊:

1
2
3
4
var $script = require( "scriptjs" );
$script( "//ajax.googleapis.com/ajax/libs/jquery/2.0.0/jquery.min.js" , function () {
   $( 'body' ).html( 'It works!' )
});

五. 與 grunt/gulp 配合

以 gulp 爲示例,咱們能夠這樣混搭:

1
2
3
4
5
6
7
8
9
10
11
12
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 了。

更多參照信息請參閱:grunt配置 / gulp配置 。

六. React 相關

⑴ 推薦使用 npm install react 的形式來安裝並引用 React 模塊,而不是直接使用編譯後的 react.js,這樣最終編譯出來的 React 部分的腳本會減小 10-20 kb左右的大小。

⑵ react-hot-loader 是一款很是好用的 React 熱插拔的加載插件,經過它能夠實現修改-運行同步的效果,配合 webpack-dev-server 使用更佳!

基於 webpack 的入門指引就到這裏,但願本文能對你有所幫助,你也能夠參考下述的文章來入門:

webpack入門指謎

webpack-howto

共勉

(文章轉自:http://www.w2bc.com/Article/50764)

相關文章
相關標籤/搜索