前端打包利器:webpack工具
一、什麽是 webpack?
webpack是近期最火的一款模塊加載器兼打包工具,它能把各種資源,例如JS(含JSX)、coffee、樣式(含less/sass)、圖片等都作為模塊來使用和處理。
我們可以直接使用 require(XXX) 的形式來引入各模塊,即使它們可能需要經過編譯(比如JSX和sass),但我們無須在上面花費太多心思,因為 webpack 有著各種健全的加載器(loader)在默默處理這些事情,這塊我們後續會提到。
你可以不打算將其用在你的項目上,但沒有理由不去掌握它,因為以近期 Github 上各大主流的(React相關)項目來說,它們倉庫上所展示的示例已經是基於 webpack 來開發的,比如 React-Boostrap 和 Redux。
二、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 的兼容性相當出色,方便你舊項目的模塊直接遷移過來。
三、安裝和配置
1、安裝:
//我們常規直接使用 npm 的形式來安裝:
$ npm install webpack -g
//當然如果常規項目,還是把依賴寫入 package.json 包去,更人性化:
$ npm init
$ npm install webpack --save-dev
2、配置
每個項目下都必須配置有一個 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‘
}
}
};
(1) plugins 是插件項,這裏我們使用了一個 CommonsChunkPlugin 的插件,它用於提取多個入口文件的公共腳本部分,然後生成一個 common.js 來方便多頁面之間進行復用。
(2)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 文件夾下。
(3) 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形式)。
(4)最後是 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
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(主要是樣式這塊一句就獨占一行腳本,導致未壓縮腳本變得很大)。
五、模塊引入
上面說了那麽多配置和執行方法,下面開始說說尋常頁面和腳本怎麽使用唄。
1、 HTML
直接在頁面引入 webpack 最終生成的頁面腳本即可,不用再寫什麽 data-main 或 seajs.use 了:
<!DOCTYPE html>
<html>
<head lang="en">
<meta charset="UTF-8">
<title></title>
</head>
<body>
<script src="dist/js/page/common.js"></script>
<script src="dist/js/page/index.js"></script>
</body>
</html>
可以看到我們連樣式都不用引入,畢竟腳本執行時會動態生成<style>並標簽打到head裏。
2、 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);
一切就是這麽簡單,後續各種有的沒的,webpack 都會幫你進行處理。
前端打包利器:webpack工具