詳解webpack-dev-middleware 源碼解讀

前言

Webpack 的使用目前已經是前端開發工程師必備技能之一。若是想在本地環境啟動一個開發服務，大家只需在 Webpack 的配置中，增加 devServer 的配置來啟動。devServer 配置的本質是 webpack-dev-server 這個包提供的功能，而 webpack-dev-middleware 則是這個包的底層依賴。

截至本文發表前，webpack-dev-middleware 的最新版本為 webpack-dev-middleware@3.7.2，本文的源碼來自于此版本。本文會講解 webpack-dev-middleware 的核心模塊實現，相信大家把這篇文章看完，再去閱讀源碼，會容易理解很多。

webpack-dev-middleware 是什么？

要回答這個問題，我們先來看看如何使用這個包：

const wdm = require('webpack-dev-middleware');
const express = require('express');
const webpack = require('webpack');
const webpackConf = require('./webapck.conf.js');
const compiler = webpack(webpackConf);
const app = express();
app.use(wdm(compiler));
app.listen(8080);

通過啟動一個 Express 服務，將 wdm(compiler) 的結果通過 app.use 方法注冊為 Express 服務的中間函數。從這里，我們不難看出 wdm(compiler) 的執行結果返回的是一個 express 的中間件。它作為一個容器，將 webpack 編譯后的文件存儲到內存中，然后在用戶訪問 express 服務時，將內存中對應的資源輸出返回。

為什么要使用 webpack-dev-middleware

熟悉 webpack 的同學都知道，webpack 可以通過watch mode 方式啟動，那為何我們不直接使用此方式來監聽資源變化呢？答案就是，webpack 的 watch mode 雖然能監聽文件的變更，并且自動打包，但是每次打包后的結果將會存儲到本地硬盤中，而 IO 操作是非常耗資源時間的，無法滿足本地開發調試需求。

而 webpack-dev-middleware 擁有以下幾點特性：

• 以 watch mode 啟動 webpack，監聽的資源一旦發生變更，便會自動編譯，生產最新的 bundle
• 在編譯期間，停止提供舊版的 bundle 并且將請求延遲到最新的編譯結果完成之后
• webpack 編譯后的資源會存儲在內存中，當用戶請求資源時，直接于內存中查找對應資源，減少去硬盤中查找的 IO 操作耗時

本文將主要圍繞這三個特性和主流程邏輯進行分析。

源碼解讀

讓我們先來看下 webpack-dev-middleware 的源碼目錄：

...
├── lib
│  ├── DevMiddlewareError.js
│  ├── index.js
│  ├── middleware.js
│  └── utils
│    ├── getFilenameFromUrl.js
│    ├── handleRangeHeaders.js
│    ├── index.js
│    ├── ready.js
│    ├── reporter.js
│    ├── setupHooks.js
│    ├── setupLogger.js
│    ├── setupOutputFileSystem.js
│    ├── setupRebuild.js
│    └── setupWriteToDisk.js
├── package.json
...

其中 lib 目錄下為源代碼，一眼望去有近 10 多個文件要解讀。但刨除 utils 工具集合目錄，其核心源碼文件其實只有兩個 index.js、middleware.js

下面我們就來分析核心文件 index.js 、middleware.js 的源碼實現

入口文件 index.js

從上文我們已經得知 wdm(compiler) 返回的是一個 express 中間件，所以入口文件 index.js 則為一個中間件的容器包裝函數。它接收兩個參數，一個為 webpack 的 compiler、另一個為配置對象，經過一系列的處理，最后返回一個中間件函數。下面我將對 index.js 中的核心代碼進行講解：

...
setupHooks(context);
...
// start watching
context.watching = compiler.watch(options.watchOptions, (err) => {
 if (err) {
  context.log.error(err.stack || err);
  if (err.details) {
   context.log.error(err.details);
  }
 }
});
...
setupOutputFileSystem(compiler, context);

index.js 最為核心的是以上 3 個部分的執行，分別完成了我們上文提到的兩點特性：

• 以監控的方式啟動 webpack
• 將 webpack 的編譯內容，輸出至內存中

setupHooks

此函數的作用是在 compiler 的 invalid、run、done、watchRun 這 4 個編譯生命周期上，注冊對應的處理方法

context.compiler.hooks.invalid.tap('WebpackDevMiddleware', invalid);
context.compiler.hooks.run.tap('WebpackDevMiddleware', invalid);
context.compiler.hooks.done.tap('WebpackDevMiddleware', done);
context.compiler.hooks.watchRun.tap(
 'WebpackDevMiddleware',
 (comp, callback) => {
  invalid(callback);
 }
);

• 在 done 生命周期上注冊 done 方法，該方法主要是 report 編譯的信息以及執行 context.callbacks 回調函數
• 在 invalid、run、watchRun 等生命周期上注冊 invalid 方法，該方法主要是 report 編譯的狀態信息

compiler.watch

此部分的作用是，調用 compiler 的 watch 方法，之后 webpack 便會監聽文件變更，一旦檢測到文件變更，就會重新執行編譯。

setupOutputFileSystem

其作用是使用 memory-fs 對象替換掉 compiler 的文件系統對象，讓 webpack 編譯后的文件輸出到內存中。

fileSystem = new MemoryFileSystem();
// eslint-disable-next-line no-param-reassign
compiler.outputFileSystem = fileSystem;

通過以上 3 個部分的執行，我們以 watch mode 的方式啟動了 webpack，一旦監測的文件變更，便會重新進行編譯打包，同時我們又將文件的存儲方法改為了內存存儲，提高了文件的存儲讀取效率。最后，我們只需要返回 express 的中間件就可以了，而中間件則是調用 middleware(context) 函數得到的。下面，我們來看看 middleware 是如何實現的。

middleware.js

此文件返回的是一個 express 中間件函數的包裝函數，其核心處理邏輯主要針對 request 請求，根據各種條件判斷，最終返回對應的文件內容：

function goNext() {
 if (!context.options.serverSideRender) {
  return next();
 }
 return new Promise((resolve) => {
  ready(
   context,
   () => {
    // eslint-disable-next-line no-param-reassign
    res.locals.webpackStats = context.webpackStats;
    // eslint-disable-next-line no-param-reassign
    res.locals.fs = context.fs;
    resolve(next());
   },
   req
  );
 });
}

首先，middleware 中定義了一個 goNext() 方法，該方法判斷是否是服務端渲染。如果是，則調用 ready() 方法（此方法即為 ready.js 文件，作用為根據 context.state 狀態判斷直接執行回調還是將回調存儲 callbacks 隊列中）。如果不是，則直接調用 next() 方法，流轉至下一個 express 中間件。

const acceptedMethods = context.options.methods || ['GET', 'HEAD'];
if (acceptedMethods.indexOf(req.method) === -1) {
 return goNext();
}

接著，判斷 HTTP 協議的請求的類型，若請求不包含于配置中（默認 GET、HEAD 請求），則直接調用 goNext() 方法處理請求：

let filename = getFilenameFromUrl(
 context.options.publicPath,
 context.compiler,
 req.url
);
if (filename === false) {
 return goNext();
}

然后，根據請求的 req.url 地址，在 compiler 的內存文件系統中查找對應的文件，若查找不到，則直接調用 goNext() 方法處理請求：

return new Promise((resolve) => {
 // eslint-disable-next-line consistent-return
 function processRequest() {
  ...
 }
 ...
 ready(context, processRequest, req);
});

最后，中間件返回一個 Promise 實例，而在實例中，先是定義一個 processRequest 方法，此方法的作用是根據上文中找到的 filename 路徑獲取到對應的文件內容，并構造 response 對象返回，隨后調用 ready(context, processRequest, req) 函數，去執行 processRequest 方法。這里我們著重看下 ready 方法的內容：

if (context.state) {
 return fn(context.webpackStats);
}
context.log.info(`wait until bundle finished: ${req.url || fn.name}`);
context.callbacks.push(fn);

非常簡單的方法，判斷 context.state 的狀態，將直接執行回調函數 fn，或在 context.callbacks 中添加回調函數 fn。這也解釋了上文提到的另一個特性 “在編譯期間，停止提供舊版的 bundle 并且將請求延遲到最新的編譯結果完成之后”。若 webpack 還處于編譯狀態，context.state 會被設置為 false，所以當用戶發起請求時，并不會直接返回對應的文件內容，而是會將回調函數 processRequest 添加至 context.callbacks 中，而上文中我們說到在 compile.hooks.done 上注冊了回調函數 done，等編譯完成之后，將會執行這個函數，并循環調用 context.callbacks。

總結

源碼的閱讀是一個非常枯燥的過程，但是它的收益也是巨大的。上文的源碼解讀主要分析的是 webpack-dev-middleware 它是如何實現它所擁有的特性、如何處理用戶的請求等主要功能點，未包括其他分支邏輯處理、容錯。還需讀者在這篇文章基礎之上，再去閱讀詳細的源碼，望這篇文章能對你的閱讀過程起到一定的幫助作用。

到此這篇關于webpack-dev-middleware 源碼解讀的文章就介紹到這了,更多相關webpack-dev-middleware 源碼解讀內容請搜索億速云以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持億速云！