Express 結合 Webpack 實現HMRwi

本篇檔案主要講結合 Webpack 和 Express 實現前後端熱更新開發，如果你還不太瞭解webpack推薦閱讀

webpack 官網文件

What

什麼是 webpack dev server

Webpack dev server 是一個輕量的node.js express伺服器，實現了 webpack 編譯程式碼實時輸出更新。在前後端分離的前端專案開發中經常用到。不過這篇文章應該不會講到它。

webpack dev middleware

Webpack dev middleware 是 WebPack 的一箇中介軟體。它用於在 Express 中分發需要通過 WebPack 編譯的檔案。單獨使用它就可以完成程式碼的熱過載（hot reloading）功能。

特性：

• 不會在硬碟中寫入檔案，完全基於記憶體實現。
• 如果使用 watch 模式監聽程式碼修改，Webpack 會自動編譯，如果在 Webpack 編譯過程中請求檔案，Webpack dev middleware 會延遲請求，直到編譯完成之後再開始傳送編譯完成的檔案。

webpack hot middleware

Webpack hot middleware 它通過訂閱 Webpack 的編譯更新，之後通過執行 webpack 的 HMR api 將這些程式碼模組的更新推送給瀏覽器端。

HMR

HMR 即 Hot Module Replacement 是 Webpack 一個重要的功能。它可以使我們不用通過手動地重新整理瀏覽器頁面實現將我們的更新程式碼實時應用到當前頁面中。

HMR 的實現原理是在我們的開發中的應用程式碼中加入了 HMR Runtime，它是 HMR 的客戶端（瀏覽器端 client）用於和開發伺服器通訊，接收更新的模組。服務端工作就是前面提到的 Webpack hot middleware 的，它會在程式碼更新編譯完成之後通過以 json 格式輸出給HMR Runtime 就會更具 json 中描述來動態更新相應的程式碼。

How

webpack 配置

先來在webpack配置檔案中引入

var webpack = require('webpack');
var HotMiddleWareConfig = 'webpack-hot-middleware/client?path=/__webpack_hmr&timeout=20000'

module.exports = {
  context: __dirname,
  entry: [
  	 // 新增一個和HotMiddleWare通訊的客戶端
    HotMiddleWareConfig,
    // 新增web應用入口檔案
    './client.js'
  ],
  output: {
    path: __dirname,
    publicPath: '/',
    filename: 'bundle.js'
  },
  devtool: '#source-map',
  plugins: [
    new webpack.optimize.OccurenceOrderPlugin(),
    // 在 webpack 外掛中引入 webpack.HotModuleReplacementPlugin
    new webpack.HotModuleReplacementPlugin(),
    new webpack.NoErrorsPlugin()
  ],
};
複製程式碼

webpack-hot-middleware example webpack.config.js

在我們的開發環境中是這樣配置的。getEntries 是自動根據我們規則獲取到入口檔案並加上 webpack hot middle 配置。

var webpack = require('webpack');
var path = require('path')
var merge = require('webpack-merge')
var baseConfig = require('./webpack.base')
var getEntries = require('./getEntries')

var publicPath = 'http://0.0.0.0:7799/dist/';
var hotMiddlewareScript = 'webpack-hot-middleware/client?reload=true';

var assetsInsert = require('./assetsInsert')

module.exports = merge(baseConfig, {
  entry: getEntries(hotMiddlewareScript),
  devtool: '#eval-source-map',
  output: {
    filename: './[name].[hash].js',
    path: path.resolve('./public/dist'),
    publicPath: publicPath
  },
  plugins: [
    new webpack.DefinePlugin({
      'process.env': {
        NODE_ENV: '"development"'
      }
    }),
    new webpack.optimize.OccurenceOrderPlugin(),
    new webpack.HotModuleReplacementPlugin(),
    new webpack.NoErrorsPlugin(),
    new assetsInsert()
  ]
})
複製程式碼

Express 中的配置

在 Express 的配置主要就4個步驟：

• 引入 webpack 的配置檔案和 生成 webpack 的編譯器
• 將編譯器連線至 webpack dev middleware
• 將編譯器連線至 webpack hot middleware
• 定義 express 配置

var http = require('http');

var express = require('express');

var app = express();

app.use(require('morgan')('short'));

// ************************************
// This is the real meat of the example
// ************************************
(function() {
  // Step 1: 引入 webpack 的配置檔案和 生成 webpack 的編譯器
  var webpack = require('webpack');
  var webpackConfig = require(process.env.WEBPACK_CONFIG ? process.env.WEBPACK_CONFIG : './webpack.config');
  var compiler = webpack(webpackConfig);
  // Step 2: 將編譯器掛載給 webpack dev middleware
  app.use(require("webpack-dev-middleware")(compiler, {
    noInfo: true, publicPath: webpackConfig.output.publicPath
  }));

  // Step 3: 將編譯器掛載給 webpack hot middleware
  app.use(require("webpack-hot-middleware")(compiler, {
    log: console.log, path: '/__webpack_hmr', heartbeat: 10 * 1000
  }));
})();

// 定義 express 配置

app.get("/", function(req, res) {
  res.sendFile(__dirname + '/index.html');
});
app.get("/multientry", function(req, res) {
  res.sendFile(__dirname + '/index-multientry.html');
});

if (require.main === module) {
  var server = http.createServer(app);
  server.listen(process.env.PORT || 1616, function() {
    console.log("Listening on %j", server.address());
  });
}
複製程式碼

webpack-hot-middleware example server.js

區分開發和生產環境

要注意的是一定要在定義 express router 前定義 webpack 相關的中介軟體。還有一點是這裡server.js 只是開發環境中使用，在生成環境中我們就不需要再用到它們了。 所以在我們實際的使用中需要通過定義環境變數來區分開發和生產環境

var NODE_ENV = process.env.NODE_ENV || 'production';
var isDev = NODE_ENV === 'development';

if (isDev) {
    var webpack = require('webpack'),
        webpackDevMiddleware = require('webpack-dev-middleware'),
        webpackHotMiddleware = require('webpack-hot-middleware'),
        webpackDevConfig = require('./build/webpack.config.js');

    var compiler = webpack(webpackDevConfig);

    app.use(webpackDevMiddleware(compiler, {
        publicPath: webpackDevConfig.output.publicPath,
        noInfo: true,
        stats: {
            colors: true
        }
    }));
    
    app.use(webpackHotMiddleware(compiler));
    
    routerConfig(app, {
        dirPath: __dirname + '/server/routes/',
        map: {
            'index': '/',
            'api': '/api/*',
            'proxy': '/proxy/*'
        }
    });

    var reload = require('reload');
    var http = require('http');

    var server = http.createServer(app);
    reload(server, app);

    app.use(express.static(path.join(__dirname, 'public')));

    server.listen(port, function(){
        console.log('App (dev) is now running on port ' + port + '!');
    });
} else {
    routerConfig(app, {
        dirPath: __dirname + '/server/routes/',
        map: {
            'index': '/',
            'api': '/api/*',
            'proxy': '/proxy/*'
        }
    });
    app.use(express.static(path.join(__dirname, 'public')));
    
    app.listen(port, function () {
        console.log('App (Production) is now running on port ' + port + '!');
    });
}

複製程式碼

supervisor

以上在前端我們實現了前端檔案的熱更新，但是我們在修改服務端檔案的時候，並不會使Node自動重啟，所以我們使用 supervisor 來作為監聽檔案修改事件來自動重啟 Node服務。

supervisor 需要 全域性安裝

npm install supervisor -g
複製程式碼

安裝完成之後我們就可以在命令列中使用

我們在 package.json 的 scripts 中寫好常用的命令，之後只用 npm run xxx 即可使用

"scripts": {
    "dev": "export NODE_ENV=development && supervisor -w server,app.js app",
    "build": "node build/build.js",
    "start": "node app"
  },
複製程式碼

node-supervisor

supervisor [options] <program>

supervisor -w server,app.js app
複製程式碼

-w 就是一個 options 配置項，它用於監聽指定目錄或者檔案的變更，可以使用，分隔，監聽多個目錄或者檔案，這就是監聽了 server 目錄和根目錄的 app.js 到變更之後就會重啟我們的 Express 入口檔案 app。