logologo
文档仓库
文档仓库
logologo
开始

概述

第一步
控制器
提供者
模块
中间件
异常过滤器
管道
守卫
拦截器
自定义装饰器

基础

自定义提供程序
异步提供者
动态模块
注入作用域
循环依赖
模块引用
懒加载模块
执行上下文
生命周期事件
发现服务
平台无关
单元测试

技术

配置
SQL
Mongo
验证
缓存
序列化
版本控制
任务调度
队列
日志
Cookies
事件
压缩
文件上传
文件流
HTTP 模块
Session
MVC
性能(Fastify)
SSE

安全

认证
授权
加密与哈希
Helmet
CORS
CSRF
速率限制

GraphQL

快速开始
解析器
变更
订阅
标量
指令
接口
联合与枚举
字段中间件
类型映射
插件
复杂度
扩展
CLI 插件
生成SDL
共享模型
其他功能
联邦

WebSocket

网关
异常过滤器
管道
守卫
拦截器
适配器

微服务

基础
Redis
MQTT
NATS
RabbitMQ
Kafka
gRPC
自定义传输
异常过滤器
管道
守卫
拦截器
部署
独立应用程序

CLI

概述
工作区
库
用法
脚本

OpenAPI

介绍
装饰器
类型映射
操作
其他特性
安全
类型与参数
CLI 插件

实用示例

REPL
CRUD生成器
SWC
Passport(认证)
热重载
MikroORM
TypeORM
Mongoose
Sequelize
路由模块
Swagger
健康检查
CQRS
Compodoc
Prisma
Sentry
静态资源
Commander
异步本地存储
Necord
套件(原Automock)

常见问题

Serverless
HTTP 适配器
长连接
全局前缀
原始请求体
混合应用
HTTPS & 多服务器
请求生命周期
错误

开发工具

概述
CI/CD
迁移指南
API参考(官方)

生态与案例

谁在用
精彩资源

支持

支持

社区

贡献者

最后更新于: 2025/11/18 02:11:37

上一页Passport(认证)
下一页MikroORM

#热重载

对应用程序启动过程影响最大的是 TypeScript 编译 。幸运的是,借助 webpack 的 HMR(热模块替换)功能,我们无需在每次变更时重新编译整个项目。这大幅减少了实例化应用程序所需的时间,使迭代开发变得更加轻松。

警告

请注意 webpack 不会自动将资源文件(例如 graphql 文件)复制到 dist 目录。同样地,webpack 也不支持通配符静态路径(例如 TypeOrmModule 中的 entities 属性)。

#使用 CLI

若您使用 Nest CLI,配置过程相当简单。该 CLI 封装了 webpack,因此可以使用 HotModuleReplacementPlugin。

#安装

首先安装所需依赖包:

$ npm i --save-dev webpack-node-externals run-script-webpack-plugin webpack
提示

若使用 Yarn Berry(非经典版 Yarn),请安装 webpack-pnp-externals 而非 webpack-node-externals。

#配置

安装完成后,在应用程序的根目录下创建一个 webpack-hmr.config.js 文件。

const nodeExternals = require('webpack-node-externals');
const { RunScriptWebpackPlugin } = require('run-script-webpack-plugin');

module.exports = function (options, webpack) {
  return {
    ...options,
    entry: ['webpack/hot/poll?100', options.entry],
    externals: [
      nodeExternals({
        allowlist: ['webpack/hot/poll?100'],
      }),
    ],
    plugins: [
      ...options.plugins,
      new webpack.HotModuleReplacementPlugin(),
      new webpack.WatchIgnorePlugin({
        paths: [/\.js$/, /\.d\.ts$/],
      }),
      new RunScriptWebpackPlugin({
        name: options.output.filename,
        autoRestart: false,
      }),
    ],
  };
};
提示

使用 Yarn Berry(非经典 Yarn)时,不要在 externals 配置属性中使用 nodeExternals,而应改用 webpack-pnp-externals 包中的 WebpackPnpExternals: WebpackPnpExternals({ exclude: ['webpack/hot/poll?100'] }) 。

该函数第一个参数接收包含默认 webpack 配置的原始对象,第二个参数接收 Nest CLI 使用的底层 webpack 包引用。它返回一个修改后的 webpack 配置,其中包含 HotModuleReplacementPlugin、WatchIgnorePlugin 和 RunScriptWebpackPlugin 插件。

#热模块替换

要启用 HMR,请打开应用程序入口文件(main.ts)并添加以下 webpack 相关指令:

declare const module: any;

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  await app.listen(process.env.PORT ?? 3000);

  if (module.hot) {
    module.hot.accept();
    module.hot.dispose(() => app.close());
  }
}
bootstrap();

为简化执行流程,请在 package.json 文件中添加一个脚本。

"start:dev": "nest build --webpack --webpackPath webpack-hmr.config.js --watch"

现在只需打开命令行并运行以下命令:

$ npm run start:dev

#无命令行界面

如果不使用 Nest CLI,配置会稍显复杂(需要更多手动步骤)。

#安装

首先安装所需依赖包:

$ npm i --save-dev webpack webpack-cli webpack-node-externals ts-loader run-script-webpack-plugin
提示

如果使用 Yarn Berry(非经典版 Yarn),请安装 webpack-pnp-externals 包而非 webpack-node-externals。

#配置

安装完成后,在应用程序的根目录下创建一个 webpack.config.js 文件。

const webpack = require('webpack');
const path = require('path');
const nodeExternals = require('webpack-node-externals');
const { RunScriptWebpackPlugin } = require('run-script-webpack-plugin');

module.exports = {
  entry: ['webpack/hot/poll?100', './src/main.ts'],
  target: 'node',
  externals: [
    nodeExternals({
      allowlist: ['webpack/hot/poll?100'],
    }),
  ],
  module: {
    rules: [
      {
        test: /.tsx?$/,
        use: 'ts-loader',
        exclude: /node_modules/,
      },
    ],
  },
  mode: 'development',
  resolve: {
    extensions: ['.tsx', '.ts', '.js'],
  },
  plugins: [
    new webpack.HotModuleReplacementPlugin(),
    new RunScriptWebpackPlugin({ name: 'server.js', autoRestart: false }),
  ],
  output: {
    path: path.join(__dirname, 'dist'),
    filename: 'server.js',
  },
};
提示

使用 Yarn Berry(非经典版 Yarn)时,不要在 externals 配置属性中使用 nodeExternals,而应改用 webpack-pnp-externals 包中的 WebpackPnpExternals: WebpackPnpExternals({ exclude: ['webpack/hot/poll?100'] }) 。

此配置向 webpack 说明了关于应用程序的几个关键信息:入口文件的位置、存放编译后文件的目录,以及用于编译源文件的加载器类型。通常即使您不完全理解所有选项,也可以直接使用此文件。

#热模块替换

要启用 HMR,请打开应用程序入口文件(main.ts)并添加以下 webpack 相关指令:

declare const module: any;

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  await app.listen(process.env.PORT ?? 3000);

  if (module.hot) {
    module.hot.accept();
    module.hot.dispose(() => app.close());
  }
}
bootstrap();

为简化执行流程,请在 package.json 文件中添加一个脚本。

"start:dev": "webpack --config webpack.config.js --watch"

现在只需打开命令行并运行以下命令:

$ npm run start:dev

#示例

一个可用的示例在此处查看。