How use external entities in nestjs project with typeorm?

在NestJS项目中使用TypeORM来处理外部实体主要涉及几个主要步骤，这些步骤确保你能有效地整合和使用这些实体，无论它们是定义在同一个项目中还是一个外部库中。下面我将详细阐述这一过程：

步骤 1: 安装和配置TypeORM

首先，确保你的NestJS项目已经安装了TypeORM。可以通过以下命令安装：

bash
npm install --save @nestjs/typeorm typeorm

接着，在你的app.module.ts或相关模块文件中引入TypeOrmModule：

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

@Module({
  imports: [
    TypeOrmModule.forRoot({
      type: '数据库类型, 如postgres',
      host: 'localhost',
      port: 5432,
      username: 'user',
      password: 'password',
      database: 'db',
      autoLoadEntities: true,
      synchronize: true,
    }),
  ],
})
export class AppModule {}

步骤 2: 引入外部实体

假设你有一个外部npm包，比如my-external-models，里面定义了一些你想在项目中使用的实体。首先需要安装这个包：

bash
npm install my-external-models

然后，你可以在任何需要的模块中导入这些实体，并在TypeOrmModule.forFeature()方法中注册它们：

typescript
import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
import { ExternalEntity } from 'my-external-models';

@Module({
  imports: [
    TypeOrmModule.forFeature([ExternalEntity])
  ],
})
export class SomeModule {}

步骤 3: 使用实体

现在，你可以在服务中注入这些实体的repository，并进行数据库操作：

typescript
import { Injectable } from '@nestjs/common';
import { InjectRepository } from '@nestjs/typeorm';
import { Repository } from 'typeorm';
import { ExternalEntity } from 'my-external-models';

@Injectable()
export class SomeService {
  constructor(
    @InjectRepository(ExternalEntity)
    private externalEntityRepository: Repository<ExternalEntity>,
  ) {}

  async findAll(): Promise<ExternalEntity[]> {
    return await this.externalEntityRepository.find();
  }
}

示例：处理外部定义的实体

假设有一个外部定义的实体User，你需要在你的NestJS应用中增加一个功能，比如根据用户名查找用户。你可以像上面那样引入并使用这个实体：

typescript
// User.service.ts
import { Injectable } from '@nestjs/common';
import { InjectRepository } from '@nestjs/typeorm';
import { User } from 'external-user-model';
import { Repository } from 'typeorm';

@Injectable()
export class UserService {
  constructor(
    @InjectRepository(User)
    private userRepository: Repository<User>,
  ) {}

  async findUserByUsername(username: string): Promise<User | undefined> {
    return this.userRepository.findOne({ where: { username } });
  }
}

这是一个基本的流程，通过这种方式可以有效地在NestJS项目中整合和使用外部定义的typeorm实体。