NX+Nest.js+TypeORM项目Webpack打包下的数据库迁移配置问题

问题描述 #

基于NX搭建的Nest.js + Angular项目，TypeORM数据库在serve模式下运行正常，但迁移配置遇到障碍：常规Nest.js项目的dist目录结构与原项目一致，迁移文件会被编译复制到对应目录，只要TypeORM配置正确（migrationsRun设为true、migrations路径正确），服务启动时会自动执行迁移；但NX通过Webpack打包后，dist目录仅生成单个main.js文件，迁移文件未被包含或复制，导致自动迁移失效。补充：问题根源是Webpack将所有代码合并为单个文件，而非NX本身。

项目结构 #

project/
├─ apps/
│  ├─ api/
│  │  ├─ src/
│  │  │  ├─ config/
│  │  │  │  ├─ database/
│  │  │  │  │  ├─ typeorm.config.ts
│  │  │  ├─ database/
│  │  │  │  ├─ migrations/
|  |  |  |  |  ├─ 1668904379611-SomeMigration.ts
├─ dist/
│  ├─ apps/
│  │  ├─ api/
│  │  │  ├─ main.js

当前TypeORM配置（typeorm.config.ts） #

host: process.env.MYSQL_HOST,
port: +process.env.MYSQL_PORT,
username: process.env.MYSQL_USER,
database: process.env.MYSQL_DATABASE,
password: process.env.MYSQL_PASSWORD,
entities: [__dirname + '/../../**/*.entity{.ts,.js}'],
migrations: [__dirname + '/../../**/database/migrations/*{.ts,.js}'],
extra: {
  charset: 'utf8mb4_unicode_ci',
},
synchronize: false,
migrationsRun: true,
logging: true,
autoLoadEntities: true,

最优解决方案 #

方案1：使用TypeORM CLI单独执行迁移（推荐） #

Webpack打包会合并代码，导致迁移文件无法被TypeORM单独识别，最稳妥的方式是脱离打包流程，用TypeORM CLI独立管理迁移：

• 在项目根目录创建ormconfig.json（或ormconfig.js），配置与typeorm.config.ts对齐，路径适配CLI执行环境：

  {
    "type": "mysql",
    "host": "${MYSQL_HOST}",
    "port": "${MYSQL_PORT}",
    "username": "${MYSQL_USER}",
    "database": "${MYSQL_DATABASE}",
    "password": "${MYSQL_PASSWORD}",
    "entities": ["apps/api/src/**/*.entity.ts"],
    "migrations": ["apps/api/src/database/migrations/*.ts"],
    "extra": {
      "charset": "utf8mb4_unicode_ci"
    },
    "cli": {
      "migrationsDir": "apps/api/src/database/migrations"
    }
  }
  

• 在package.json中添加迁移管理脚本：

  "scripts": {
    "migrate:run": "typeorm-ts-node-commonjs migration:run -d ormconfig.json",
    "migrate:generate": "typeorm-ts-node-commonjs migration:generate -d ormconfig.json apps/api/src/database/migrations/$npm_config_name",
    "migrate:create": "typeorm-ts-node-commonjs migration:create apps/api/src/database/migrations/$npm_config_name"
  }
  

• 部署流程调整为：先执行npm run migrate:run完成迁移，再启动服务。这种方式完全规避Webpack打包的路径问题，迁移逻辑独立可控，是生产环境的最优选择。

方案2：修改NX配置，让迁移文件单独编译输出 #

如果坚持要在服务启动时自动执行迁移，可以修改NX构建配置，让迁移文件不被Webpack打包，而是单独编译输出到dist目录：

• 打开apps/api/project.json，找到targets.build配置，添加资源复制和额外入口配置：

  "build": {
    "executor": "@nrwl/nest:build",
    "options": {
      "outputPath": "dist/apps/api",
      "main": "apps/api/src/main.ts",
      "tsConfig": "apps/api/tsconfig.app.json",
      "assets": [
        "apps/api/src/assets",
        // 将迁移目录作为静态资源复制到dist
        {
          "input": "apps/api/src/database/migrations",
          "glob": "*.ts",
          "output": "./database/migrations"
        }
      ],
      "additionalEntryPoints": [
        // 让迁移文件单独编译为JS
        "apps/api/src/database/migrations/*.ts"
      ]
    }
  }
  

• 修改typeorm.config.ts中的migrations路径，适配编译后的位置：

  migrations: [__dirname + '/../database/migrations/*.js'],
  

  注意：该方案配置复杂度较高，后续新增迁移文件时需确保配置覆盖，且可能增加构建体积，仅适合必须自动执行迁移的场景。

方案3：代码中手动导入迁移文件 #

如果不想修改配置，可以在typeorm.config.ts中手动导入所有迁移文件，让Webpack将其打包进main.js，TypeORM即可识别：

import { SomeMigration1668904379611 } from '../../database/migrations/1668904379611-SomeMigration';

// ...其他配置
migrations: [SomeMigration1668904379611],

缺点：每次新增迁移都需手动导入，维护成本高，不适合迁移文件较多的项目。

总结 #

优先选择方案1（TypeORM CLI），逻辑清晰、维护简单，完全规避Webpack打包带来的路径问题，是生产环境的最优解；若必须实现启动自动迁移，再考虑方案2或3。

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