最近一个同事在使用Angular的时候,希望能像VUE那样,修改代码后浏览器不刷新,页面对应修改的组件自动更新的功能。这个功能的名字时HMR (hot module replace)。
稍微研究了一下,发现在angular/cli创建的项目中,实现这个不算太难,步骤如下:
- 首先创建一个
src/environments/environment.hmr.ts
文件,内容如下
export const environment = {
production: false,
hmr: true
};
当然,对应的environment.prod.ts
和environment.ts
需要增加一个hmr:false
.
如果environment.ts里面的
hmr
设置为ture
,那么ng serve --hmr
也有同样效果。不过我对热替换功能还不是那么相信,重新刷新浏览器能保证状态更加干净一些,所以让environment.ts
中的hmr
为false
.
- 在
.angular-cli.json
文件的环境中增加hmr
的环境,大致如下:
"environments": {
...
"hmr": "environments/environment.hmr.ts",
}
- 在
package.json
的scripts
中增加一个新的命令。(当然也可以不增加,直接运行ng serve --hmr -e=hmr
和运行npm run hmr
效果一样)
"scripts": {
...
"hmr": "ng serve --hmr -e=hmr"
}
安装
hmr
模块,命令如下:
npm install --save-dev @angularclass/hmr
创建
src\hmr.ts
文件,内容如下:
import { NgModuleRef, ApplicationRef } from '@angular/core';
import { createNewHosts } from '@angularclass/hmr';
export const hmrBootstrap = (module: any, bootstrap: () => Promise<NgModuleRef<any>>) => {
let ngModule: NgModuleRef<any>;
module.hot.accept();
bootstrap().then(currentModule => ngModule = currentModule);
module.hot.dispose(() => {
const appRef: ApplicationRef = ngModule.injector.get(ApplicationRef);
const elements = appRef.components.map(c => c.location.nativeElement);
const removeOldHosts = createNewHosts(elements);
ngModule.destroy();
removeOldHosts();
});
};
这事热替换的关键,
hmrBootstrap
会替换原始的bootstrap
(下面会看到), 替换后,当有新的模块更新时,hmr
会首先移除掉旧有的模块,然后接收新的模块。这些都是发生在浏览器里面。所以页面不会刷新。
- 更新
src\main.ts
文件如下:
import { enableProdMode } from '@angular/core';
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { AppModule } from './app/app.module';
import { environment } from './environments/environment';
import { hmrBootstrap } from './hmr';
if (environment.production) {
enableProdMode();
}
const bootstrap = () => platformBrowserDynamic().bootstrapModule(AppModule);
if (environment.hmr) {
if (module[ 'hot' ]) {
hmrBootstrap(module, bootstrap);
} else {
console.error('Ammm.. HMR is not enabled for webpack');
}
} else {
bootstrap();
}
这里替换就得启动文件,如果设置为
hmr
,那么调用hmrBootStrap
来启动网页,否则就用过去的
- 现在运行
npm run hmr
或者ng serve --hmr -e=hmr
,就实现了热替换功能。
参考文献: https://medium.com/wizardnet972/hot-module-replacement-with-angular-cli-5fc7a3ae4a9c