How to set autoLoadEntities: true in connecting Nest js with typeorm

在使用NestJS结合TypeORM时，autoLoadEntities: true 的设置可以简化实体的注册过程。这个选项允许你自动将所有通过@Module装饰器或在模块内导入的实体添加到TypeORM的数据库连接中。下面是如何配置这个选项的具体步骤：

步骤 1: 安装必要的包

首先，确保你已经安装了NestJS和TypeORM相关的包。如果没有安装，可以通过以下命令进行安装：

bash
npm install @nestjs/typeorm typeorm

步骤 2: 配置TypeORMModule

在你的NestJS应用中，你需要在根模块或者任何特定的模块中导入TypeORMModule。这里是如何在根模块中使用autoLoadEntities: true进行配置的例子：

typescript
import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';

@Module({
  imports: [
    TypeOrmModule.forRoot({
      type: 'postgres', // 选择数据库类型，例如：'postgres', 'mysql'等
      host: 'localhost',
      port: 5432,
      username: 'your_username',
      password: 'your_password',
      database: 'your_database',
      autoLoadEntities: true, // 启用自动加载实体
      synchronize: true, // 根据实体自动创建数据库表，仅在开发环境中建议开启
    }),
  ],
})
export class AppModule {}

步骤 3: 添加实体

现在，你可以在应用中创建实体，并且不需要显式地将每个实体添加到entities数组中。只需要通过@Entity()装饰器标记类，TypeORM会自动识别并加载这些实体。以下是一个实体的示例：

typescript
import { Entity, PrimaryGeneratedColumn, Column } from 'typeorm';

@Entity()
export class User {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  name: string;
}

步骤 4: 验证配置

启动你的NestJS应用，并检查数据库，看看相应的表是否根据实体自动创建。如果autoLoadEntities配置正确，你应该能看到对应实体的数据库表已经被创建。

总结

通过设置autoLoadEntities: true，你可以省去手动注册每个实体的步骤，使得项目的数据库管理更为简洁和高效。这在大型项目中尤其有用，因为随着实体数量的增加，手动管理这些实体会变得越来越复杂。