NestJS集成MikroORM无法自动加载实体及创建表问题

问题 #

参考NestJS官方文档的「自动加载实体」教程搭建基于MikroORM的NestJS项目时，遇到MikroORM无法自动创建数据库表的问题，相关代码如下：

AppModule.ts #

@Module({
  imports: [
    MikroOrmModule.forRoot({
      type: 'postgresql',
      host: 'localhost',
      user: 'test',
      password: 'test',
      dbName: 'test',
      port: 5440,
      autoLoadEntities: true,
      entities: ['../entity/domain'],
      entitiesTs: ['../entity/domain'],
      allowGlobalContext: true,
      schemaGenerator: {
        createForeignKeyConstraints: false,
      },
    }),
    UserModule,
  ],
  controllers: [],
  providers: [],
})
export class AppModule {}

UserModule #

@Module({
  imports: [UserEntityModule],
  controllers: [UserController],
  providers: [UserService, UserRepository],
})
export class UserModule {}

UserRepository #

import { InjectRepository } from '@mikro-orm/nestjs';
import { EntityRepository } from '@mikro-orm/postgresql';
import { Injectable } from '@nestjs/common';

@Injectable()
export class UserRepository {
  constructor(
    @InjectRepository(User)
    private readonly userRepository: EntityRepository<User>,
  ) {}

  async save(req: UserSaveRequest) {
    const response = await this.userRepository
      .createQueryBuilder()
      .insert(req)
      .execute();

    return response;
  }
}

UserEntityModule #

import { MikroOrmModule } from '@mikro-orm/nestjs';

@Module({
  imports: [MikroOrmModule.forFeature([User])],
  exports: [MikroOrmModule],
})
export class UserEntityModule {}

User #

import { Entity, Property } from '@mikro-orm/core';

@Entity({ tableName: 'users' })
export class User extends BaseEntity {
  @Property({ comment: "user's nickname" })
  nickname: string;
}

BaseEntity #

export abstract class BaseEntity {
  @PrimaryKey()
  id: number;
}

解决方法 #

1. 补全BaseEntity的装饰器导入 #

BaseEntity中的@PrimaryKey装饰器未从@mikro-orm/core导入，导致MikroORM无法识别主键字段，实体元数据不完整。修改BaseEntity：

import { PrimaryKey } from '@mikro-orm/core';

export abstract class BaseEntity {
  @PrimaryKey()
  id: number;
}

2. 修正实体路径配置 #

entities和entitiesTs路径需要包含通配符来匹配所有实体文件，否则MikroORM无法找到实体类。更新AppModule中的配置：

MikroOrmModule.forRoot({
  // ...其他配置
  entities: ['../entity/domain/**/*.js'], // 编译后的JS文件路径
  entitiesTs: ['../entity/domain/**/*.ts'], // 源码TS文件路径
})

注意：路径需根据项目实际目录结构调整，确保能正确指向实体文件所在位置。

3. 启用自动同步数据库Schema #

MikroORM默认不会自动创建表，需显式开启Schema同步，推荐两种方式：

方式一：启动时自动生成表结构

修改AppModule的MikroOrm配置，添加runOnInit参数：

MikroOrmModule.forRoot({
  // ...其他配置
  schemaGenerator: {
    createForeignKeyConstraints: false,
    runOnInit: true, // 应用启动时自动同步表结构
  },
})

方式二：使用CLI手动同步

执行CLI命令生成表结构：

npx mikro-orm schema:create --run

生产环境建议使用迁移脚本（mikro-orm migration:create）而非自动同步，避免误操作导致数据风险。

4. 移除自动加载实体的配置冲突 #

autoLoadEntities: true会自动加载通过MikroOrmModule.forFeature()注册的实体，此时可以移除手动指定的entities和entitiesTs配置，避免路径冲突：

MikroOrmModule.forRoot({
  // ...其他配置
  autoLoadEntities: true,
  // 移除 entities 和 entitiesTs 配置项
})

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