如何在 NestJS 中使用 TypeORM 实现多数据库配置

乐闻

2024年01月06日 08:58· 阅读 1964

前言

当你打算在一个 NestJS 应用中操作多个数据库时，TypeORM 提供了优雅而强大的解决方案。在本教程中，我们将一步步了解如何在 NestJS 项目中配置 TypeORM 以使用多个数据库。

实现步骤

一、创建 NestJS 项目

如果你还没有一个 NestJS 项目，请使用以下命令创建一个新项目：

shell
nest new multi-database-app

进入项目后，我们准备好基础设施。

二、安装 TypeORM 和数据库驱动

请确保你已安装了 TypeORM 并添加了对你将使用的数据库的支持。例如，如果你使用 MySQL 和 PostgreSQL，则需要安装它们的驱动：

shell
npm install @nestjs/typeorm typeorm mysql pg

三、创建数据库配置文件

在项目的根目录下，创建两个配置文件 ormconfig.mysql.json 和 ormconfig.postgres.json，用于存放两个不同数据库的配置。

ormconfig.mysql.json 示例：

json
{
  "name": "mysqlConnection",
  "type": "mysql",
  "host": "localhost",
  "port": 3306,
  "username": "your_mysql_username",
  "password": "your_mysql_password",
  "database": "your_mysql_db",
  "entities": ["dist/**/*.entity{.ts,.js}"],
  "synchronize": true
}

ormconfig.postgres.json 示例：

json
{
  "name": "postgresConnection",
  "type": "postgres",
  "host": "localhost",
  "port": 5432,
  "username": "your_postgres_username",
  "password": "your_postgres_password",
  "database": "your_postgres_db",
  "entities": ["dist/**/*.entity{.ts,.js}"],
  "synchronize": true
}

确保配置文件对应到正确的数据库和认证信息。entities 配置了实体位置，方便 TypeORM 自动加载。

四、设置多个数据库连接

修改 app.module.ts 来包含多个数据库连接：

typescript
import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
import * as mysqlConfig from './ormconfig.mysql.json';
import * as postgresConfig from './ormconfig.postgres.json';

@Module({
  imports: [
    TypeOrmModule.forRoot(mysqlConfig),
    TypeOrmModule.forRoot(postgresConfig)
  ],
})
export class AppModule {}

我们使用 TypeOrmModule.forRoot() 方法两次，分别传入两个数据库的配置。

五、创建数据库实体

根据你的业务需求为每个数据库创建实体类。这里我们假设 MySQl 用于存储 User 实体，而 PostgreSQL 存储 Post 实体。

在 src 目录下创建 user.entity.ts：

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

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

  @Column()
  name: string;
}

在 src 目录下创建 post.entity.ts：

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

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

  @Column()
  title: string;

  @Column()
  content: string;
}

确保这些实体类遵循 TypeORM 的装饰器模式进行定义。

六、在服务中注入并使用多个数据库连接

要在服务中使用不同的数据库连接，我们需要为每个数据库创建一个特殊的符号，让 NestJS 可以识别并注入正确的 Repository。

首先，创建两个服务类，users.service.ts（用于操作 MySQL 数据库的 User 实体）和 posts.service.ts（用于操作 PostgreSQL 数据库的 Post 实体）。

UsersService - 使用 MySQL

在 src 目录下创建 users.service.ts：

typescript
import { Injectable } from '@nestjs/common';
import { InjectRepository } from '@nestjs/typeorm';
import { User } from './user.entity';
import { Repository } from 'typeorm';

@Injectable()
export class UsersService {
  constructor(
    @InjectRepository(User, 'mysqlConnection')
    private readonly userRepository: Repository<User>,
  ) {}

  // 添加用户的逻辑
  async createUser(userInfo: CreateUserDto): Promise<User> {
    const user = this.userRepository.create(userInfo);
    return this.userRepository.save(user);
  }

  // 其他 CRUD 操作...
}

这里使用 InjectRepository 装饰器和连接名 mysqlConnection 来注入特定的 Repository。

PostsService - 使用 PostgreSQL

在 src 目录下创建 posts.service.ts：

typescript
import { Injectable } from '@nestjs/common';
import { InjectRepository } from '@nestjs/typeorm';
import { Post } from './post.entity';
import { Repository } from 'typeorm';

@Injectable()
export class PostsService {
  constructor(
    @InjectRepository(Post, 'postgresConnection')
    private readonly postRepository: Repository<Post>,
  ) {}

  // 添加文章的逻辑
  async createPost(postData: CreatePostDto): Promise<Post> {
    const post = this.postRepository.create(postData);
    return this.postRepository.save(post);
  }

  // 其他 CRUD 操作...
}

类似地，这里使用 InjectRepository 装饰器和连接名 postgresConnection 来注入 Post 的 Repository。

七、实现服务逻辑和 CRUD 示例

现在我们已经有了操作两个数据库的服务，我们可以在每个服务类中添加 CRUD 方法，实现数据的增删改查。

创建 DTOs (Data Transfer Objects)

对于每个 CRUD 操作，建议使用 DTOs 来传递数据。在 src 目录下创建 create-user.dto.ts 和 create-post.dto.ts 文件定义 DTOs。

create-user.dto.ts 示例：
```
typescript
export class CreateUserDto {
  readonly name: string;
}
```
create-post.dto.ts 示例：
```
typescript
export class CreatePostDto {
  readonly title: string;
  readonly content: string;
}
```
完成 CRUD 操作

在 UsersService 和 PostsService 服务中定义 CRUD 操作。我们已经为 UsersService 定义了 createUser 方法，现在让我们添加查询所有用户的方法：
```
typescript
// users.service.ts

async getUsers(): Promise<User[]> {
  return this.userRepository.find();
}
```
类似地，在 PostsService 添加查询所有文章的方法：
```
typescript
// posts.service.ts

async getPosts(): Promise<Post[]> {
  return this.postRepository.find();
}
```

结语

现在你已经了解了在 NestJS 应用中使用 TypeORM 设置和操作多个数据库的完整流程。通过上述步骤，你不仅可以连接单一数据库，而且还能够灵活地同步操作多个数据库。

我们鼓励你根据自己的项目需求进一步探索 TypeORM 的高级特性，例如实体关系、事务管理、订阅功能和更多数据持久化的策略，从而充分利用异构数据库环境带来的优势。这将大大提升你的 NestJS 应用程序的可扩展性和健壮性。

标签：

NestJS