webpack多頁應用架構系列（十二）：利用webpack生成HTML普通網頁&頁面模板

本文首發于Array_Huang的技術博客——實用至上，非經作者同意，請勿轉載。
原文地址：https://segmentfault.com/a/1190000007126268
如果您對本系列文章感興趣，歡迎關注訂閱這里：https://segmentfault.com/blog/array_huang

為什么要用webpack來生成HTML頁面

按照我們前面的十一篇的內容來看，自己寫一個HTML頁面，然后在上面加載webpack打包的js或其它類型的資源，感覺不也用得好好的么？

是的沒錯，不用webpack用requireJs其實也可以啊，甚至于，傳統那種人工管理模塊依賴的做法也沒有什么問題嘛。

但既然你都已經看到這一篇了，想必早已和我一樣，追求著以下這幾點吧：

  • 更懶，能自動化的事情絕不做第二遍。
  • 更放心，調通的代碼比人靠譜，更不容易出錯。
  • 代碼潔癖，什么東西該放哪，一點都不能含糊，混在一起我就要死了。

那么，廢話不多說，下面就來說說使用webpack生成HTML頁面有哪些好處吧。

對多個頁面共有的部分實現復用

在實際項目的開發過程中，我們會發現，雖然一個項目里會有很多個頁面，但這些頁面總有那么幾個部分是相同或相似的，尤其是頁頭頁尾，基本上是完全一致的。那我們要怎么處理這些共有的部分呢？

復制粘貼流

不就是復制粘貼的事嘛？寫好一份完整的HTML頁面，做下個頁面的時候，直接copy一份文件，然后直接在copy的文件上進行修改不就好了嗎？

誰是這么想這么做的，放學留下來，我保證不打死你！我曾經接受過這么一套系統，頂部欄菜單想加點東西，就要每個頁面都改一遍，可維護性爛到爆啊。

Iframe流

Iframe流常見于管理后臺類項目，可維護性OK，就是缺陷比較多，比如說：

  • 點擊某個菜單，頁面是加載出來了但是瀏覽器地址欄上的URL沒變，刷新的話又回到首頁了。
  • 搜索引擎收錄完蛋，前臺項目一般不能用Iframe來布局。
  • 沒有逼格，Low爆了，這是最重要的一點（大誤）。

SPA流

最近這幾年，隨著移動互聯網的興起，SPA也變得非常常見了。不過SPA的局限性也非常大，比如搜索引擎無法收錄，但我個人最在意的，是它太復雜了，尤其是一些本來業務邏輯就多的系統，很容易懵圈。

后端模板渲染

這倒真是一個辦法，只是，需要后端的配合，利用后端代碼把頁面的各個部分給拼合在一起，所以這方法對前端起家的程序員還是有點門檻的。

利用前端模板引擎生成HTML頁面

所謂“用webpack生成HTML頁面”，其實也并不是webpack起的核心作用，實際上靠的還是前端的模板引擎將頁面的各個部分給拼合在一起來達到公共區域的復用。webpack更多的是組織統籌整個生成HTML頁面的過程，并提供更大的控制力。最終，webpack生成的到底是完整的頁面，還是供后端渲染的模板，就全看你自己把控了，非常靈活，外人甚至察覺不出來這到底是你自己寫的還是代碼統一生成的。

處理資源的動態路徑

如果你想用在文件名上加hash的方法作為緩存方案的話，那么用webpack生成HTML頁面就成為你唯一的選擇了，因為隨著文件的變動，它的hash也會變化，那么整個文件名都會改變，你總不能在每次編譯后都手動修改加載路徑吧？還是放心交給webpack吧。

自動加載webpack生成的css、less

如果你使用webpack來生成HTML頁面，那么，你可以配置好每個頁面加載的chunk（webpack打包后生成的js文件），生成出來的頁面會自動用<script>來加載這些chunk，路徑什么的你都不用管了哈（當然前提是你配置好了output.publicPath）。另外，用extract-text-webpack-plugin打包好的css文件，webpack也會幫你自動添加到<link>里，相當方便。

徹底分離源文件目錄和生成文件目錄

使用webpack生成出來的HTML頁面可以很安心地跟webpack打包好的其它資源放到一起，相對于另起一個目錄專門存放HTML頁面文件來說，整個文件目錄結構更加合理：

build
  - index
    - index
      - entry.js
      - page.html
    - login
      - entry.js
      - page.html
      - styles.css

如何利用webpack生成HTML頁面

webpack生成HTML頁面主要是通過html-webpack-plugin來實現的，下面來介紹如何實現。

html-webpack-plugin的配置項

每一個html-webpack-plugin的對象實例都只針對/生成一個頁面，因此，我們做多頁應用的話，就要配置多個html-webpack-plugin的對象實例：

pageArr.forEach((page) => {
  const htmlPlugin = new HtmlWebpackPlugin({
    filename: `${page}/page.html`,
    template: path.resolve(dirVars.pagesDir, `./${page}/html.js`),
    chunks: [page, 'commons'],
    hash: true, // 為靜態資源生成hash值
    minify: true,
    xhtml: true,
  });
  configPlugins.push(htmlPlugin);
});

pageArr實際上是各個chunk的name，由于我在output.filename設置的是'[name]/entry.js'，因此也起到構建文件目錄結構的效果（具體請看這里），附上pageArr的定義：

module.exports = [
  'index/login',
  'index/index',
  'alert/index',
  'user/edit-password', 'user/modify-info',
];

html-webpack-plugin的配置項真不少，這里僅列出多頁應用常用到的配置：

  • filename，生成的網頁HTML文件的文件名，注意可以利用/來控制文件目錄結構的，其最終生成的路徑，是基于webpack配置中的output.path的。
  • template，指定一個基于某種模板引擎語法的模板文件，html-webpack-plugin默認支持ejs格式的模板文件，如果你想使用其它格式的模板文件，那么需要在webpack配置里設置好相應的loader，比如handlebars-loader啊html-loader啊之類的。如果不指定這個參數，html-webpack-plugin會使用一份默認的ejs模板進行渲染。如果你做的是簡單的SPA應用，那么這個參數不指定也行，但對于多頁應用來說，我們就依賴模板引擎給我們拼裝頁面了，所以這個參數非常重要。
  • inject，指示把加載js文件用的<script>插入到哪里，默認是插到<body>的末端，如果設置為'head'，則把<script>插入到<head>里。
  • minify，生成壓縮后的HTML代碼。
  • hash，在由html-webpack-plugin負責加載的js/css文件的網址末尾加個URL參數，此URL參數的值是代表本次編譯的一個hash值，每次編譯后該hash值都會變化，屬于緩存解決方案。
  • chunks，以數組的形式指定由html-webpack-plugin負責加載的chunk文件（打包后生成的js文件），不指定的話就會加載所有的chunk。

生成一個簡單的頁面

下面提供一份供生成簡單頁面（之所以說簡單，是因為不指定頁面模板，僅用默認模板）的配置：

var HtmlWebpackPlugin = require('html-webpack-plugin');
var webpackConfig = {
  entry: 'index.js',
  output: {
    path: 'dist',
    filename: 'index_bundle.js'
  },
  plugins: [new HtmlWebpackPlugin(
    title: '簡單頁面',
    filename: 'index.html',
  )],
};

使用這份配置編譯后，會在dist目錄下生成一個index.html，內容如下所示：

<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8">
    <title>簡單頁面</title>
  </head>
  <body>
    <script src="index_bundle.js"></script>
  </body>
</html>

由于沒有指定模板文件，因此生成出來的HTML文件僅有最基本的HTML結構，并不帶實質內容。可以看出，這更適合React這種把HTML藏js里的方案。

利用模板引擎獲取更大的控制力

接下來，我們演示如何通過制定模板文件來生成HTML的內容，由于html-webpack-plugin原生支持ejs模板，因此這里也以ejs作為演示對象：

<!DOCTYPE html>
<html>
  <head>
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta http-equiv="Content-type" content="text/html; charset=utf-8"/>
    <meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1" /> 
    <title><%= htmlWebpackPlugin.options.title %></title>
  </head>
  <body>
    <h1>這是一個用<b>html-webpack-plugin</b>生成的HTML頁面</h1>
    <p>大家仔細瞧好了</p>
  </body>
</html>

'html-webpack-plugin'的配置里也要指定template參數：

var HtmlWebpackPlugin = require('html-webpack-plugin');
var webpackConfig = {
  entry: 'index.js',
  output: {
    path: 'dist',
    filename: 'index_bundle.js'
  },
  plugins: [new HtmlWebpackPlugin(
    title: '按照ejs模板生成出來的頁面',
    filename: 'index.html',
    template: 'index.ejs',
  )],
};

那么，最后生成出來的HTML文件會是這樣的：

<!DOCTYPE html>
<html>
  <head>
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta http-equiv="Content-type" content="text/html; charset=utf-8"/>
    <meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1" /> 
    <title>按照ejs模板生成出來的頁面</title>
  </head>
  <body>
    <h1>這是一個用<b>html-webpack-plugin</b>生成的HTML頁面</h1>
    <p>大家仔細瞧好了</p>
    <script src="index_bundle.js"></script>
  </body>
</html>

到這里，我們已經可以控制整個HTML文件的內容了，那么生成后端渲染所需的模板也就不是什么難事了，以PHP的模板引擎smarty為例：

<!DOCTYPE html>
<html>
  <head>
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta http-equiv="Content-type" content="text/html; charset=utf-8"/>
    <meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1" /> 
    <title><%= htmlWebpackPlugin.options.title %></title>
  </head>
  <body>
    <h1>這是一個用<b>html-webpack-plugin</b>生成的HTML頁面</h1>
    <p>大家仔細瞧好了</p>
    <p>這是用smarty生成的內容：<b>{$articleContent}</b></p>
  </body>
</html>

處理資源的動態路徑

接下來在上面例子的基礎上，我們演示如何處理資源的動態路徑：

var HtmlWebpackPlugin = require('html-webpack-plugin');
var webpackConfig = {
  entry: 'index.js',
  output: {
    path: 'dist',
    filename: 'index_bundle.[chunkhash].js'
  },
  plugins: [new HtmlWebpackPlugin(
    title: '按照ejs模板生成出來的頁面',
    filename: 'index.html',
    template: 'index.ejs',
  )],
  module: {
    loaders: {
      // 圖片加載器，雷同file-loader，更適合圖片，可以將較小的圖片轉成base64，減少http請求
      // 如下配置，將小于8192byte的圖片轉成base64碼
      test: /\.(png|jpg|gif)$/,
      loader: 'url?limit=8192&name=./static/img/[hash].[ext]',
    },
  },
};

<!DOCTYPE html>
<html>
  <head>
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta http-equiv="Content-type" content="text/html; charset=utf-8"/>
    <meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1" /> 
    <title><%= htmlWebpackPlugin.options.title %></title>
  </head>
  <body>
    <h1>這是一個用<b>html-webpack-plugin</b>生成的HTML頁面</h1>
    <p>大家仔細瞧好了</p>
    <img src="<%= require('./imgs/login-bg.jpg')  %>" />
  </body>
</html>

我們改動了什么呢？

  1. 參數output.filename里，我們添了個變量[chunkhash]，這個變量的值會隨chunk內容的變化而變化，那么，這個chunk文件最終的路徑就會是一個動態路徑了。
  2. 我們在頁面上添加了一個<img>，它的src是require一張圖片，相應地，我們配置了針對圖片的loader配置，如果圖片比較小，require()就會返回DataUrl，而如果圖片比較大，則會拷貝到dist/static/img/目錄下，并返回新圖片的路徑。

下面來看看，到底html-webpack-plugin能不能處理好這些動態的路徑。

<!DOCTYPE html>
<html>
  <head>
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta http-equiv="Content-type" content="text/html; charset=utf-8"/>
    <meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1" /> 
    <title>按照ejs模板生成出來的頁面</title>
  </head>
  <body>
    <h1>這是一個用<b>html-webpack-plugin</b>生成的HTML頁面</h1>
    <p>大家仔細瞧好了</p>
    ![](http://upload-images.jianshu.io/upload_images/2970956-47399d0cc987233e.jpeg?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)
    <script src="index_bundle.c3a064486c8318e5e11a.js"></script>
  </body>
</html>

顯然，html-webpack-plugin成功地將chunk加載了，又處理好了轉化為DataUrl格式的圖片，這一切，都是我們手工難以完成的事情。

還未結束

至此，我們實現了使用webpack生成HTML頁面并嘗到了它所帶來的甜頭，但我們尚未實現“對多個頁面共有的部分實現復用”，下一節《webpack多頁應用架構系列（十三）：構建一個簡單的模板布局系統》我們就來介紹這部分的內容。

示例代碼

諸位看本系列文章，搭配我在Github上的腳手架項目食用更佳哦（笑）：Array-Huang/webpack-seed（https://github.com/Array-Huang/webpack-seed）。

附系列文章目錄（同步更新）

本文首發于Array_Huang的技術博客——實用至上，非經作者同意，請勿轉載。
原文地址：https://segmentfault.com/a/1190000007126268
如果您對本系列文章感興趣，歡迎關注訂閱這里：https://segmentfault.com/blog/array_huang

最后編輯于 ：
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明：文章內容（如有圖片或視頻亦包括在內）由作者上傳并發布，文章內容僅代表作者本人觀點，簡書系信息發布平臺，僅提供信息存儲服務。
  • 人面猴
    序言：七十年代末，一起剝皮案震驚了整個濱河市，隨后出現的幾起案子，更是在濱河造成了極大的恐慌，老刑警劉巖，帶你破解...
    沈念sama閱讀 228,646評論 6贊 533
  • 死咒
    序言：濱河連續發生了三起死亡事件，死亡現場離奇詭異，居然都是意外死亡，警方通過查閱死者的電腦和手機，發現死者居然都...
    沈念sama閱讀 98,595評論 3贊 418
  • 救了他兩次的神仙讓他今天三更去死
    文/潘曉璐 我一進店門，熙熙樓的掌柜王于貴愁眉苦臉地迎上來，“玉大人，你說我怎么就攤上這事。” “怎么了？”我有些...
    開封第一講書人閱讀 176,560評論 0贊 376
  • 道士緝兇錄：失蹤的賣姜人
    文/不壞的土叔 我叫張陵，是天一觀的道長。 經常有香客問我，道長，這世上最難降的妖魔是什么？ 我笑而不...
    開封第一講書人閱讀 63,035評論 1贊 314
  • ?港島之戀（遺憾婚禮）
    正文 為了忘掉前任，我火速辦了婚禮，結果婚禮上，老公的妹妹穿的比我還像新娘。我一直安慰自己，他們只是感情好，可當我...
    茶點故事閱讀 71,814評論 6贊 410
  • 惡毒庶女頂嫁案：這布局不是一般人想出來的
    文/花漫 我一把揭開白布。 她就那樣靜靜地躺著，像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上，一...
    開封第一講書人閱讀 55,224評論 1贊 324
  • 城市分裂傳說
    那天，我揣著相機與錄音，去河邊找鬼。 笑死，一個胖子當著我的面吹牛，可吹牛的內容都是我干的。 我是一名探鬼主播，決...
    沈念sama閱讀 43,301評論 3贊 442
  • 雙鴛鴦連環套：你想象不到人心有多黑
    文/蒼蘭香墨 我猛地睜開眼，長吁一口氣：“原來是場噩夢啊……” “哼！你這毒婦竟也來了？” 一聲冷哼從身側響起，我...
    開封第一講書人閱讀 42,444評論 0贊 288
  • 萬榮殺人案實錄
    序言：老撾萬榮一對情侶失蹤，失蹤者是張志新（化名）和其女友劉穎，沒想到半個月后，有當地人在樹林里發現了一具尸體，經...
    沈念sama閱讀 48,988評論 1贊 335
  • ?護林員之死
    正文 獨居荒郊野嶺守林人離奇死亡，尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,804評論 3贊 355
  • ?白月光啟示錄
    正文 我和宋清朗相戀三年，在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,998評論 1贊 370
  • 活死人
    序言：一個原本活蹦亂跳的男人離奇死亡，死狀恐怖，靈堂內的尸體忽然破棺而出，到底是詐尸還是另有隱情，我是刑警寧澤，帶...
    沈念sama閱讀 38,544評論 5贊 360
  • ?日本核電站爆炸內幕
    正文 年R本政府宣布，位于F島的核電站，受9級特大地震影響，放射性物質發生泄漏。R本人自食惡果不足惜，卻給世界環境...
    茶點故事閱讀 44,237評論 3贊 347
  • 男人毒藥：我在死后第九天來索命
    文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧，春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,665評論 0贊 26
  • 一樁弒父案，背后竟有這般陰謀
    文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至，卻和暖如春，著一層夾襖步出監牢的瞬間，已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,927評論 1贊 287
  • 情欲美人皮
    我被黑心中介騙來泰國打工， 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留，地道東北人。 一個月前我還...
    沈念sama閱讀 51,706評論 3贊 393
  • 代替公主和親
    正文 我出身青樓，卻偏偏與公主長得像，于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子，可洞房花燭夜當晚...
    茶點故事閱讀 47,993評論 2贊 374

推薦閱讀更多精彩內容