webpack中的HMR(热更新)原理剖析

　　webpack中的HMR(热更新)原理剖析

　　简介

　　Hot Module Replacement（以下简称 HMR）是 webpack 发展至今引入的最令人兴奋的特性之一 ，当你对代码进行修改并保存后，webpack 将对代码重新打包，并将新的模块发送到浏览器端，浏览器通过新的模块替换老的模块，这样在不刷新浏览器的前提下就能够对应用进行更新。

　　基本实现原理大致这样的，构建 bundle 的时候，加入一段 HMR runtime 的 js 和一段和服务沟通的 js 。文件修改会触发 webpack 重新构建，服务器通过向浏览器发送更新消息，浏览器通过 jsonp 拉取更新的模块文件，jsonp 回调触发模块热替换逻辑。

　　热更新配置

　　 if (module.hot) { //判断是否有热加载<br /> module.hot.accept('./hmrTest.js', function() { //热加载的模块路径<br /> console.log('Accepting the updated printMe module!'); //热加载的回调，即发生了模块更新时，执行什么 callback<br /> printMe();<br /> })<br /> }<br />

　　缺点：更新逻辑得自己写。比如要使页面显示的内容生效，需要在回调中写入document.append(xxx)

　　 import { hot } from 'react-hot-loader';<br /> const Record = ()=>{<br /> ...<br /> }<br /> export default hot(module)(Record);<br /> 或<br /><br /> if (module.hot) {<br /> module.hot.accept('./App', function () {<br /> var NextApp = require('./App')<br /> ReactDOM.render(, rootEl)<br /> })<br /> }<br />

　　实现过程

　　watch 编译过程、devServer 推送更新消息到浏览器

　　浏览器接收到服务端消息做出响应

　　对模块进行热更新或刷新页面

　　watch 编译过程、devServer 推送更新消息到浏览器

　　webpack-dev-server 里引用了 webpack-dev-middleware，相关的 watch 逻辑就是在里面实现的。

　　 //webpack-dev-server/lib/Server.js<br /> setupDevMiddleware() {<br /> this.middleware = webpackDevMiddleware(<br /> this.compiler,<br /> Object.assign({}, this.options, { logLevel: this.log.options.level })<br /> );<br /> }<br /> // webpack-dev-middleware/index.js<br /> if (!options.lazy) {<br /> context.watching = compiler.watch(options.watchOptions, (err) => {<br /> ...<br /> });<br /> }<br />

　　以上代码可以看出，webpack-dev-middleware 是通过调用 webpack 的 api 对文件系统 watch 的。watchOptions 如果没有配置的话，会取默认值。值的含义见：

　　当文件发生变化时，重新编译输出 bundle.js。devServer 下，是没有文件会输出到 output.path 目录下的，这时 webpack 是把文件输出到了内存中。webpack 中使用的操作内存的库是 memory-fs，它是 NodeJS 原生 fs 模块内存版(in-memory)的完整功能实现，会将你请求的url映射到对应的内存区域当中，因此读写都比较快。

　　 // webpack-dev-middleware/lib/fs.js<br /> fileSystem = fs;<br /> } else if (isMemoryFs) {<br /> fileSystem = compiler.outputFileSystem;<br /> } else {<br /> fileSystem = new MemoryFileSystem();<br /> compiler.outputFileSystem = fileSystem;<br /> }<br />

　　devServer 通知浏览器端文件发生改变，在启动 devServer 的时候，sockjs 在服务端和浏览器端建立了一个 webSocket 长连接，以便将 webpack 编译和打包的各个阶段状态告知浏览器，最关键的步骤还是 webpack-dev-server 调用 webpack api *敏*感*词* compile的 done 事件，当compile 完成后，webpack-dev-server通过 _sendStatus 方法将编译打包后的新模块 hash 值发送到浏览器端。

　　 // webpack-dev-server/lib/Server.js<br /> const addHooks = (compiler) => {<br /> ...<br /> done.tap('webpack-dev-server', (stats) => {<br /> this._sendStats(this.sockets, this.getStats(stats));<br /> this._stats = stats;<br /> });<br /> };<br /> ...<br /> _sendStats(sockets, stats, force) {<br /> ...<br /> this.sockWrite(sockets, 'hash', stats.hash);<br /> if (stats.errors.length > 0) {<br /> this.sockWrite(sockets, 'errors', stats.errors);<br /> } else if (stats.warnings.length > 0) {<br /> this.sockWrite(sockets, 'warnings', stats.warnings);<br /> } else {<br /> this.sockWrite(sockets, 'ok');<br /> }<br /> }<br />

　　浏览器接收到服务端消息做出响应

　　这里的主要逻辑位于 webpack-dev-server/client-src 中，webpack-dev-server 修改了webpack 配置中的 entry 属性，在里面添加了 webpack-dev-client 的代码，这样在最后的 bundle.js 文件中就会有接收 websocket 消息的代码了。

　　 //webpack-dev-server/lib/utils/addEntries.js<br /> let hotEntry;<br /> if (options.hotOnly) {<br /> hotEntry = require.resolve('webpack/hot/only-dev-server');<br /> } else if (options.hot) {<br /> hotEntry = require.resolve('webpack/hot/dev-server');<br /> }<br /> ...<br /> if (hotEntry && checkInject(options.injectHot, config, true)) {<br /> additionalEntries.push(hotEntry);<br /> }<br /> config.entry = prependEntry(config.entry || './src', additionalEntries);<br />

　　以上代码可以看出，如果选择了热加载，输出的 bundle.js 会包含接收 websocket 消息的代码。而且 plugin 也会注入一个 HotModuleReplacementPlugin，构建过程中热加载相关的逻辑都在这个插件中。这个插件主要处理两部分逻辑：

　　先看一张图，看看 websocket 中的消息长什么样子：

　　

　　可以看到，接收的消息只有 type 和 hash 两个内容。在 client 里面的逻辑，他们分别对应不同的处理逻辑：

　　 // webpack-dev-server/client-src/default/index.js<br /> hash(hash) {<br /> status.currentHash = hash;<br /> },<br /> ...<br /> ok() {<br /> sendMessage('Ok');<br /> if (options.useWarningOverlay || options.useErrorOverlay) {<br /> overlay.clear();<br /> }<br /> if (options.initial) {<br /> return (options.initial = false);<br /> } // eslint-disable-line no-return-assign<br /> reloadApp(options, status);<br /> }<br />

　　可以看出，当接收到 type 为 hash 消息后会将 hash 值暂存起来，当接收到 type 为 ok 的消息后对应用执行 reload 操作，而 hash 消息是在 ok 消息之前的。再看看 reload 里面的处理逻辑：

　　 // webpack-dev-server/client-src/default/reloadApp.js<br /> if (hot) {<br /> ...<br /> const hotEmitter = require('webpack/hot/emitter');<br /> hotEmitter.emit('webpackHotUpdate', currentHash);<br /> if (typeof self !== 'undefined' && self.window) {<br /> self.postMessage(`webpackHotUpdate${currentHash}`, '*');<br /> }<br /> }<br />

　　可以看出，如果配置了模块热更新，就调用 webpack/hot/emitter 将最新 hash 值发送给 webpack，然后将控制权交给 webpack 客户端代码。如果没有配置模块热更新，就进行 liveReload 的逻辑。webpack/hot/dev-server 中会*敏*感*词* webpack-dev-server/client-src 发送的 webpackHotUpdate 消息,然后调用 webpack/lib/HotModuleReplacement.runtime 中的 check 方法，检测是否有新的更新：

　　 // webpack/hot/dev-server.js<br /> var hotEmitter = require("./emitter");<br /> hotEmitter.on("webpackHotUpdate", function(currentHash) {<br /> lastHash = currentHash;<br /> if (!upToDate() && module.hot.status() === "idle") {<br /> log("info", "[HMR] Checking for updates on the server...");<br /> check();<br /> }<br /> });<br /> <br /> // webpack/lib/HotModuleReplacement.runtime<br /> function hotCheck(apply) {<br /> ...<br /> return hotDownloadManifest(hotRequestTimeout).then(function(update) {<br /> ...<br /> hotEnsureUpdateChunk(chunkId);<br /> ...<br /> return promise;<br /> });<br /> }<br />

　　以上代码可以看出，在 check 过程中，主要调用了两个方法 hotDownloadManifest 和 hotDownloadUpdateChunk。hotDownloadManifest 是通过 Ajax 向服务器请求十分有更新的文件，如果有就返回对应的文件信息，hotDownloadUpdateChunk 是通过Jsonp的方式，请求最新的代码模块。如下图所示:

　　

　　

　　补充，这两个文件的名称是可以配置的，如果没有配置，则取定义在 WebpackOptionsDefaulter 中的默认配置。

　　 this.set("output.hotUpdateChunkFilename", "[id].[hash].hot-update.js");<br /> this.set("output.hotUpdateMainFilename", "[hash].hot-update.json");<br />

　　对模块进行热更新或刷新页面

　　综上，我们获得了更新的内容。接下来就可以进行更新了。这部分的逻辑在 webpack/lib/HotModuleReplacement.runtime 中。

　　首先，更新过的模块，现在都属于 outdated 的模块，所以先找出过期的模块及其依赖:

　　 //webpack/lib/HotModuleReplacement.runtime<br /> <br /> function getAffectedStuff(updateModuleId) {<br /> var outdatedModules = [updateModuleId];<br /> var outdatedDependencies = {};<br /> ...<br /> return {<br /> type: "accepted",<br /> moduleId: updateModuleId,<br /> outdatedModules: outdatedModules,<br /> outdatedDependencies: outdatedDependencies<br /> };<br /> }<br />

　　根据调用的 Api 信息，对结果进行标注及处理。

　　 switch (result.type) {<br /> case "self-declined":<br /> ...<br /> break;<br /> case "declined":<br /> ...<br /> break;<br /> case "unaccepted":<br /> ...<br /> break;<br /> case "accepted":<br /> if (options.onAccepted) options.onAccepted(result);<br /> doApply = true;<br /> break;<br /> case "disposed":<br /> if (options.onDisposed) options.onDisposed(result);<br /> doDispose = true;<br /> break;<br /> }<br />

　　从缓存中删除过期的模块和依赖

　　 // remove module from cache<br /> delete installedModules[moduleId];<br /><br /> // when disposing there is no need to call dispose handler<br /> delete outdatedDependencies[moduleId];<br /><br /> // remove "parents" references from all children<br /> for (j = 0; j < module.children.length; j++) {<br /> ...<br /> }<br /> // remove outdated dependency from module children<br /> var dependency;<br /> var moduleOutdatedDependencies;<br /> for (moduleId in outdatedDependencies) {<br /> ...<br /> }<br />

　　将新的模块添加到 modules 中，当下次调用 webpack_require (webpack 重写的 require 方法)方法的时候，就是获取到了新的模块代码了。

　　 // insert new code<br /> for (moduleId in appliedUpdate) {<br /> if (Object.prototype.hasOwnProperty.call(appliedUpdate, moduleId)) {<br /> modules[moduleId] = appliedUpdate[moduleId];<br /> }<br /> }<br />

　　最后就是错误的兼容了，如果热加载失败，将会刷新浏览器。

　　参考资料

　　最后