NX项目中NestJS生产构建清除非生产代码方案咨询

1. 利用NX环境变量注入+Webpack Tree Shaking #

NX默认基于Webpack构建，只要让process.env.NODE_ENV在编译时被替换为常量，Webpack的tree shaking就能自动清除死代码分支，完全移除非生产环境的代码和依赖。

配置步骤： #

• 修改项目的project.json，在build目标的生产配置中注入NODE_ENV=production：

{
  "targets": {
    "build": {
      "executor": "@nx/node:webpack",
      "options": {
        "outputPath": "dist/apps/your-app",
        "main": "apps/your-app/src/main.ts",
        "tsConfig": "apps/your-app/tsconfig.app.json",
        "environment": {
          "NODE_ENV": "production"
        }
      },
      "configurations": {
        "production": {
          "optimization": true,
          "extractLicenses": true,
          "inspect": false
        }
      }
    }
  }
}

• 重构业务代码，将环境判断提取为编译时常量，让Webpack能识别死代码：

import { HttpService } from '@nestjs/axios';
import { Injectable } from '@nestjs/common';
import { firstValueFrom } from 'rxjs';

// 提取为常量，编译时会被替换为布尔值true/false
const IS_PROD = process.env.NODE_ENV === 'production';

@Injectable()
export class SomeRandomService {
  constructor(private httpService: HttpService) {}

  randomRequest(body: any): Promise<any> {
    if (IS_PROD) {
      return firstValueFrom(
        this.httpService.post(`someRandomUrl`, body, {
          headers: {
            Accept: 'application/json',
          },
        })
      );
    } else {
      // 非生产环境的mock代码，生产构建会被完全移除
      return import('some-random-path-to-mock.mock');
    }
  }
}

• 确保tsconfig.app.json中compilerOptions的module为commonjs（NestJS默认配置），且NX生产构建默认开启的optimization.usedExports: true未被修改。

2. Babel插件强化死代码清除 #

如果Webpack的tree shaking效果不够彻底，可借助babel-plugin-dead-code-elimination强制移除非生产分支：

• 安装依赖：

npm install babel-plugin-dead-code-elimination --save-dev

• 项目根目录创建.babelrc：

{
  "presets": ["@nx/node/babel"],
  "plugins": [
    ["dead-code-elimination", { "env": { "NODE_ENV": "production" } }]
  ]
}

• 修改project.json的build目标，启用Babel配置：

{
  "targets": {
    "build": {
      "executor": "@nx/node:webpack",
      "options": {
        // ...其他配置
        "babelConfig": ".babelrc"
      }
    }
  }
}

3. NX文件替换隔离敏感Mock #

对于包含敏感数据的Mock文件，直接用NX的fileReplacements功能在生产构建时替换为空白实现：

• 创建生产版Mock文件some-random-path-to-mock.prod.mock.ts：

// 生产环境空实现，避免打包敏感数据
export default Promise.resolve({});

• 在project.json的生产配置中添加替换规则：

{
  "configurations": {
    "production": {
      // ...其他配置
      "fileReplacements": [
        {
          "replace": "apps/your-app/src/path/to/some-random-path-to-mock.mock.ts",
          "with": "apps/your-app/src/path/to/some-random-path-to-mock.prod.mock.ts"
        }
      ]
    }
  }
}

验证方法 #

生产构建完成后，通过以下方式确认非生产代码已移除：

• 查看dist目录下的编译产物，搜索Mock文件的内容或路径，确认不存在；
• 使用webpack-bundle-analyzer分析构建产物，确认Mock文件未被打包：

npx webpack-bundle-analyzer dist/apps/your-app/stats.json

内容的提问来源于stack exchange，提问作者Mor Bargig