安裝配置
一. 安裝
我們常規直接使用 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 --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
);
一切就是這么簡單么么噠~ 后續各種有的沒的,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 。
但有時候我們希望能更加個性化一些,我們可以這樣配置:
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 執行后會乖乖地把樣式文件提取出來:
四. 使用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 了。
更多參照信息請參閱:grunt配置 / gulp配置 。
六. React 相關
⑴ 推薦使用 npm install react 的形式來安裝并引用 React 模塊,而不是直接使用編譯后的 react.js,這樣最終編譯出來的 React 部分的腳本會減少 10-20 kb左右的大小。
⑵ react-hot-loader 是一款非常好用的 React 熱插拔的加載插件,通過它可以實現修改-運行同步的效果,配合 webpack-dev-server 使用更佳!
基于 webpack 的入門指引就到這里,希望本文能對你有所幫助,你也可以參考下述的文章來入門:
webpack入門指謎
webpack-howto
共勉~