Nest.js 如何使用 TypeORM 定义实体？

推荐答案

在 Nest.js 中使用 TypeORM 定义实体时，通常需要以下步骤：

1. 安装依赖：首先确保安装了 typeorm 和 @nestjs/typeorm 包。

   npm install typeorm @nestjs/typeorm

2. 创建实体类：使用 TypeORM 的装饰器来定义实体类。实体类通常映射到数据库中的表。

   // www.javascriptcn.com code example
   import { Entity, PrimaryGeneratedColumn, Column } from 'typeorm';
   
   @Entity()
   export class User {
     @PrimaryGeneratedColumn()
     id: number;
   
     @Column()
     firstName: string;
   
     @Column()
     lastName: string;
   
     @Column({ default: true })
     isActive: boolean;
   }

3. 在模块中注册实体：在 Nest.js 的模块中，使用 TypeOrmModule.forFeature() 方法注册实体。

   import { Module } from '@nestjs/common';
   import { TypeOrmModule } from '@nestjs/typeorm';
   import { User } from './user.entity';
   
   @Module({
     imports: [TypeOrmModule.forFeature([User])],
   })
   export class UserModule {}

4. 在服务中使用实体：在服务中通过依赖注入的方式使用实体。

   // www.javascriptcn.com code example
   import { Injectable } from '@nestjs/common';
   import { InjectRepository } from '@nestjs/typeorm';
   import { Repository } from 'typeorm';
   import { User } from './user.entity';
   
   @Injectable()
   export class UserService {
     constructor(
       @InjectRepository(User)
       private readonly userRepository: Repository<User>,
     ) {}
   
     async findAll(): Promise<User[]> {
       return this.userRepository.find();
     }
   }

本题详细解读

1. 实体类的定义

在 TypeORM 中，实体类是通过装饰器来定义的。常用的装饰器包括：

• @Entity()：标记一个类为实体类，映射到数据库中的表。
• @PrimaryGeneratedColumn()：标记一个属性为主键，并且自动生成。
• @Column()：标记一个属性为表中的列。

2. 实体类的注册

在 Nest.js 中，实体类需要在模块中注册，以便 TypeORM 能够识别和管理这些实体。使用 TypeOrmModule.forFeature() 方法可以将实体类注册到当前模块中。

3. 实体的使用

在服务中，可以通过 @InjectRepository() 装饰器注入实体的 Repository，从而实现对数据库的操作。Repository 提供了多种方法，如 find()、save()、delete() 等，用于执行常见的数据库操作。

4. 数据库连接配置

除了定义实体类，还需要在应用的根模块中配置数据库连接。通常使用 TypeOrmModule.forRoot() 方法来配置数据库连接参数。

// www.javascriptcn.com code example
import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';

@Module({
  imports: [
    TypeOrmModule.forRoot({
      type: 'mysql',
      host: 'localhost',
      port: 3306,
      username: 'root',
      password: 'password',
      database: 'test',
      entities: [__dirname + '/**/*.entity{.ts,.js}'],
      synchronize: true,
    }),
  ],
})
export class AppModule {}

5. 实体的同步

在开发环境中，可以通过设置 synchronize: true 来自动同步数据库表结构。但在生产环境中，建议关闭此选项，并使用迁移工具来管理数据库结构的变化。

6. 实体的关系

TypeORM 支持多种实体关系，如一对一、一对多、多对多等。可以通过装饰器如 @OneToOne()、@OneToMany()、@ManyToOne()、@ManyToMany() 来定义实体之间的关系。

// www.javascriptcn.com code example
import { Entity, PrimaryGeneratedColumn, Column, OneToMany } from 'typeorm';
import { Photo } from './photo.entity';

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

  @Column()
  firstName: string;

  @Column()
  lastName: string;

  @OneToMany(() => Photo, photo => photo.user)
  photos: Photo[];
}

通过以上步骤，你可以在 Nest.js 中成功定义并使用 TypeORM 实体。