NestJS+MikroORM使用绝对路径导入模块失败的问题求助

问题背景 #

使用NestJS搭配TypeScript和MikroORM时，在File.ts中通过绝对路径src/db/entities/Directory导入实体，执行npx mikro-orm migration:create命令会提示找不到模块，但相对路径可正常工作，需要实现绝对路径导入。

当前环境配置 #

项目目录结构

Project/
├─ backend/
│  ├─ dist/
│  │  ├─ (与src结构一致)
│  ├─ src/
│  │  ├─ db/
│  │  │  ├─ entities/
│  │  │  │  ├─ File.ts
│  │  │  │  ├─ Directory.ts
│  ├─ mikro-orm.config.ts 
│  ├─ tsconfig.json 
│  ├─ package.json

MikroORM 核心配置

// mikro-orm.config.ts
{
    ...
    entities: ['dist/db/entities'],
    entitiesTs: ['src/db/entities'],
    baseDir: process.cwd() // 默认值
    ...
}

TypeScript 配置

// tsconfig.json
{
    "compilerOptions": {
        "module": "commonjs",
        "declaration": true,
        "removeComments": true,
        "emitDecoratorMetadata": true,
        "experimentalDecorators": true,
        "allowSyntheticDefaultImports": true,
        "target": "ES2021",
        "sourceMap": true,
        "outDir": "./dist",
        "baseUrl": "./",
        "incremental": true,
        "skipLibCheck": true,
        "strictNullChecks": true,
        "noImplicitAny": true,
        "strictBindCallApply": true,
        "forceConsistentCasingInFileNames": true,
        "noFallthroughCasesInSwitch": true,
        "strict": true,
        "noUncheckedIndexedAccess": true,
        "exactOptionalPropertyTypes": true
    }
}

package.json 相关配置

{
    ...
    "mikro-orm": {
        "useTsNode": true
    }
}

解决方案 #

1. 配置TypeScript路径映射 #

在tsconfig.json的compilerOptions中添加paths字段，将src前缀映射到实际的src目录，让TypeScript识别绝对路径：

{
    "compilerOptions": {
        ...
        "baseUrl": "./",
        "paths": {
            "src/*": ["src/*"]
        },
        ...
    }
}

2. 让MikroORM CLI加载路径解析插件 #

MikroORM CLI依赖ts-node执行TypeScript代码，需要配置ts-node加载tsconfig-paths/register来解析路径映射。修改package.json中的mikro-orm配置：

{
    ...
    "mikro-orm": {
        "useTsNode": true,
        "tsNodeConfig": {
            "require": ["tsconfig-paths/register"]
        }
    }
}

或者，也可以在执行MikroORM命令时临时指定加载插件：

npx mikro-orm migration:create -r tsconfig-paths/register

3. 验证绝对路径导入 #

修改后，在File.ts中即可使用绝对路径导入实体：

import { Directory } from 'src/db/entities/Directory';

此时执行npx mikro-orm migration:create就能正常识别模块，不会再报错。

额外注意事项 #

• 你的项目已经安装了tsconfig-paths（在devDependencies中），无需额外安装
• 若使用ts-node-dev启动开发服务器，需在启动命令中添加-r tsconfig-paths/register，确保开发环境也支持绝对路径导入

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