詳解webpack 多頁面/入口支持&公共組件單獨(dú)打包

更新時(shí)間：2017年06月29日 15:01:33 作者：sloong

這篇文章主要介紹了詳解webpack 多頁面/入口支持&公共組件單獨(dú)打包,具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下

webpack系列目錄

webpack 系列二：webpack 介紹&安裝

webpack 系列三：webpack 如何集成第三方j(luò)s庫

webpack 系列四：webpack 多頁面支持 & 公共組件單獨(dú)打包

webpack 系列五：webpack Loaders 模塊加載器

webpack 系列六：前端項(xiàng)目模板-webpack+gulp實(shí)現(xiàn)自動(dòng)構(gòu)建部署

基于webpack搭建純靜態(tài)頁面型前端工程解決方案模板，最終形態(tài)源碼見github: https://github.com/ifengkou/webpack-template

正文

本篇主要介紹：如何自動(dòng)構(gòu)建入口文件，并生成對(duì)應(yīng)的output；公共js庫如何單獨(dú)打包。

多入口文件，自動(dòng)掃描入口。同時(shí)支持SPA和多頁面型的項(xiàng)目

公共js庫如何單獨(dú)打包。

上一篇示例，主要介紹如何集成第三方j(luò)s庫到項(xiàng)目中使用，如jquery。示例的入口只有一個(gè)index，而且是將公共js庫連同page.js一起打包到output.js中。那么在開發(fā)中會(huì)出現(xiàn)，每新增一個(gè)頁面模塊，就需要修改webpack.config.js配置文件（增加一個(gè)入口），而且如果用到的第三方庫比較多，這樣也容易導(dǎo)致jquery,React等代碼庫重復(fù)被合并到打包后的js，導(dǎo)致js體積過大，頁面加載時(shí)間過長(zhǎng)

基礎(chǔ)結(jié)構(gòu)和準(zhǔn)備工作

以下示例基于上一篇進(jìn)行改進(jìn)，上一篇項(xiàng)目源碼

目錄結(jié)構(gòu)說明

.
├── package.json    # 項(xiàng)目配置
├── src      # 源碼目錄
│ ├── pageA.html    # 入口文件a
│ ├── pageB.html    # 入口文件b
│ ├── css/     # css資源
│ ├── img/     # 圖片資源
│ ├── js     # js&jsx資源
│ │ ├── pageA.js    # a頁面入口
│ │ ├── pageB.js    # b頁面入口
│ │ ├── lib/    # 沒有存放在npm的第三方庫或者下載存放到本地的基礎(chǔ)庫，如jQuery、Zepto、avalon
│ ├── pathmap.json   # 手動(dòng)配置某些模塊的路徑，可以加快webpack的編譯速度
├── webpack.config.js   # webpack配置入口

一：自動(dòng)構(gòu)建入口

官方多入口示例

webpack默認(rèn)支持多入口，官方也有多入口的示例。配件文件webpack.config.js如下

//已簡(jiǎn)化
var path = require("path");
module.exports = {
 entry: {
  pageA: "./pageA",
  pageB: "./pageB"
 },
 output: {
  path: path.join(__dirname, "js"),
  filename: "[name].bundle.js",
  chunkFilename: "[id].chunk.js"
 }
}

每新增一個(gè)頁面就需要在webpack.config.js的entry 中增加一個(gè) pageC:"./pageC"，頁面少還好，頁面一多，就有點(diǎn)麻煩了，而且配置文件，盡可能不改動(dòng)。那么如何支持不修改配置呢？

自動(dòng)構(gòu)建入口函數(shù)

entry實(shí)際上是一個(gè)map對(duì)象，結(jié)構(gòu)如下{filename:filepath}，那么我們可以根據(jù)文件名匹配，很容易構(gòu)造自動(dòng)掃描器：
npm 中有一個(gè)用于文件名匹配的 glob模塊，通過glob很容易遍歷出src/js目錄下的所有js文件：

安裝glob模塊

$ npm install glob --save-dev

修改webpack.config.js 配置，新增entries函數(shù)，修改entry:entries()，修改output的filename為"[name].js"

//引入glob
var glob = require('glob')
//entries函數(shù)
var entries= function () {
 var jsDir = path.resolve(srcDir, 'js')
 var entryFiles = glob.sync(jsDir + '/*.{js,jsx}')
 var map = {};

 for (var i = 0; i < entryFiles.length; i++) {
  var filePath = entryFiles[i];
  var filename = filePath.substring(filePath.lastIndexOf('\/') + 1, filePath.lastIndexOf('.'));
  map[filename] = filePath;
 }
 return map;
}
//修改入口，已經(jīng)修改outp的filename
module.exports = {
 //entry: "./src/js/index.js",
 entry: entries(),
 output: {
  path: path.join(__dirname, "dist"),
  filename: "[name].js"
 },
 ......
 //以下省略，可以見下文詳細(xì)配置

測(cè)試

1.在src/js目錄中新增pageA.js

//js只有兩行代碼，在body中加一句話
var $ = require("jquery")
$("<div>這是jquery生成的多頁面示例</div>").appendTo("body")

2.新增pageA.html，也順便修改原來的index.html 對(duì)于js文件名的更改

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title></title>
</head>
<body>
<script src="../dist/index.js"></script>
</body>
</html>

3.執(zhí)行webpack，啟動(dòng)dev-server

$ webpack
$ webpack-dev-server

OK，成功打包生成pageA.js,成功運(yùn)行

二：公共庫單獨(dú)打包

先來分析下，上個(gè)步驟打包的日志：

index.js 依賴了avalon 和 jquery，然后打包后的index.js 有480kb

pageA.js 只用了jquery，然后打包后的js 有294kb

那么如果引用的lib庫多一點(diǎn)，又被很多頁面引用，那么lib庫就會(huì)被重復(fù)打包到page.js中去，模塊越多重復(fù)加載的情況越嚴(yán)重。

如果把公共代碼提取出來作為單獨(dú)的js，那么就到處可以復(fù)用，瀏覽器也就可以進(jìn)行緩存，這時(shí)候就需要用到webpack內(nèi)置插件WebPack.optimize.CommonsChunkPlugin

CommonsChunkPlugin 介紹

使用

new webpack.optimize.CommonsChunkPlugin(options)

Options
翻譯得比較簡(jiǎn)單，詳見官方說明:

options.name or options.names(string|string[]): 公共模塊的名稱
options.filename (string): 公開模塊的文件名（生成的文件名）
options.minChunks (number|Infinity|function(module,count) - boolean): 為number表示需要被多少個(gè)entries依賴才會(huì)被打包到公共代碼庫；為Infinity 僅僅創(chuàng)建公共組件塊，不會(huì)把任何modules打包進(jìn)去。并且提供function，以便于自定義邏輯。
options.chunks(string[]):只對(duì)該chunks中的代碼進(jìn)行提取。
options.children(boolean):如果為true,那么公共組件的所有子依賴都將被選擇進(jìn)來
options.async(boolean|string):如果為true,將創(chuàng)建一個(gè) option.name的子chunks（options.chunks的同級(jí)chunks）異步common chunk
options.minSize(number):所有公共module的size 要大于number，才會(huì)創(chuàng)建common chunk

2個(gè)常用的例子，更多例子見官方說明:

1.Commons chunk for entries：針對(duì)入口文件提取公共代碼

new CommonsChunkPlugin({
 name: "commons",
 // (the commons chunk name)

 filename: "commons.js",
 // (the filename of the commons chunk)

 // minChunks: 3,
 // (Modules must be shared between 3 entries)

 // chunks: ["pageA", "pageB"],
 // (Only use these entries)
})

2.Explicit vendor chunk：直接指定第三方依賴庫，打包成公共組件

entry: {
 vendor: ["jquery", "other-lib"],
 app: "./entry"
}
new CommonsChunkPlugin({
 name: "vendor",

 // filename: "vendor.js"
 // (Give the chunk a different name)

 minChunks: Infinity,
 // (with more entries, this ensures that no other module
 // goes into the vendor chunk)
})

CommonsChunkPlugin使用

基于上篇的項(xiàng)目，參考上面的第二個(gè)例子，我們將jquery 和 avalon 提取出來打包成vendor.js

完整的webpack.config.js 如下：

```js 
var webpack = require("webpack");
 var path = require("path");
 var srcDir = path.resolve(process.cwd(), 'src');
 var nodeModPath = path.resolve(__dirname, './node_modules');
 var pathMap = require('./src/pathmap.json');
 var glob = require('glob')
 var CommonsChunkPlugin = webpack.optimize.CommonsChunkPlugin;
 var entries= function () {
 var jsDir = path.resolve(srcDir, 'js')
 var entryFiles = glob.sync(jsDir + '/*.{js,jsx}')
 var map = {};
 for (var i = 0; i < entryFiles.length; i++) {
  var filePath = entryFiles[i];
  var filename = filePath.substring(filePath.lastIndexOf('\/') + 1, filePath.lastIndexOf('.'));
  map[filename] = filePath;
 }
 return map;
}

module.exports = {
 //entry: "./src/js/index.js",
 //entry: entries(),
 entry: Object.assign(entries(), {
  // 用到什么公共lib（例如jquery.js），就把它加進(jìn)vendor去，目的是將公用庫單獨(dú)提取打包
  'vendor': ['jquery', 'avalon']
 }),
 output: {
  path: path.join(__dirname, "dist"),
  filename: "[name].js"
 },
 module: {
  loaders: [
   {test: /\.css$/, loader: 'style-loader!css-loader'}
  ]
 },
 resolve: {
  extensions: ['.js', "", ".css"],
  root: [srcDir,nodeModPath],
  alias: pathMap,
  publicPath: '/'
 },
 plugins: [
  new CommonsChunkPlugin({
   name: 'vendor',
   minChunks: Infinity
  })
 ]
}
```

測(cè)試、驗(yàn)證

1.修改入口(Object.assign 是html5.js里面的....)

//entry: entries(),
entry: Object.assign(entries(), {
 // 用到什么公共lib（例如jquery.js），就把它加進(jìn)vendor去，目的是將公用庫單獨(dú)提取打包
 'vendor': ['jquery', 'avalon']
}),

2.加入插件CommonsChunkPlugin

var CommonsChunkPlugin = webpack.optimize.CommonsChunkPlugin;
config 中增加 plugins
 plugins: [
  new CommonsChunkPlugin({
   name: 'vendor',
   minChunks: Infinity
  })
 ]

3.修改index.html 和 pageA.html，增加對(duì)verdor.js的引用

<script src="../dist/vendor.js"></script>
<script src="../dist/index.js"></script>
//<script src="../dist/pageA.js"></script>

4.執(zhí)行webpack

$ webpack

結(jié)果分析

可以看到index.js 就只有457 bytes了，pageA.js 227bytes。vendor.js 是集成了jquery+avalon，所以有488kb。

這樣vendor.js 就可以重復(fù)利用了，也方便瀏覽器進(jìn)行緩存。

調(diào)試過程中發(fā)現(xiàn)

Uncaught ReferenceError: webpackJsonp is not defined

這個(gè)是因?yàn)楫?dāng)時(shí)把vendor.js引入放到了page.js 后面，導(dǎo)致page.js執(zhí)行異常，所以，請(qǐng)一定把vendor.js 放在前面。

生成后的index.js就很輕便了，第三方庫都被打包到vendor中了，代碼如下:

webpackJsonp([0],[
/* 0 */
/***/ function(module, exports, __webpack_require__) {

 /**
  * Created by sloong on 2016/6/1.
  */
 //avalon 測(cè)試
 var avalon = __webpack_require__(1);
 avalon.define({
  $id: "avalonCtrl",
  name: "Hello Avalon!"
 });

 /*
 //zepto 測(cè)試
 require("zepto")

 $("<div>這是zepto生成的</div>").appendTo("body")*/

 //jquery 測(cè)試
 var $ = __webpack_require__(2)
 $("<div>這是jquery生成的</div>").appendTo("body")

/***/ }
]);

頁面測(cè)試均正常