从 0 到 1 学习 NestJS (四) - 数据库集成 (TypeORM + PostgreSQL)

前言

在前面的文章中，我们学习了 NestJS 的核心概念，包括模块、控制器、服务、请求处理、响应处理、DTO 和验证。本篇将深入探讨如何在 NestJS 应用中集成数据库，我们将使用 TypeORM 作为 ORM (Object-Relational Mapping) 工具，并以 PostgreSQL 作为数据库示例。

1. 安装必要的依赖

首先，我们需要安装 TypeORM 和 PostgreSQL 的相关依赖：

1
2
3

npm install @nestjs/typeorm typeorm pg
# 或者
yarn add @nestjs/typeorm typeorm pg

@nestjs/typeorm: NestJS 官方提供的 TypeORM 集成模块。
typeorm: TypeORM 本身。
pg: PostgreSQL 数据库驱动。

配置 TypeORM

创建 ormconfig.js 文件

在项目根目录下创建一个名为 ormconfig.js 的文件，并添加以下配置：

module.exports = {
  type: 'postgres',
  host: 'localhost', // 数据库主机地址
  port: 5432,        // 数据库端口
  username: 'your_username', // 数据库用户名
  password: 'your_password', // 数据库密码
  database: 'your_database', // 数据库名称
  entities: ['dist/**/*.entity.js'], // 实体文件路径
  synchronize: true,  // 自动同步数据库结构 (开发环境建议开启)
};

请将 your_username, your_password 和 your_database 替换成你实际的 PostgreSQL 数据库信息。

注意: synchronize: true 会在每次应用启动时自动同步数据库结构，在生产环境中不建议开启，应该使用数据库迁移。

配置 TypeOrmModule

在 app.module.ts 中，引入并配置 TypeOrmModule：

// src/app.module.ts
import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { UsersModule } from './users/users.module';

@Module({
  imports: [
    TypeOrmModule.forRoot(), // 使用默认配置加载 ormconfig.js
    UsersModule,
  ],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

TypeOrmModule.forRoot() 会读取 ormconfig.js 文件中的配置信息，并初始化 TypeORM。

创建实体 (Entity)

实体是 TypeORM 中用于映射数据库表的类。

创建 user.entity.ts 文件

在 src/users 目录下创建一个 user.entity.ts 文件，并添加以下内容：

// src/users/user.entity.ts
import { Entity, PrimaryGeneratedColumn, Column } from 'typeorm';

@Entity('users') // 指定表名为 'users'
export class User {
  @PrimaryGeneratedColumn() // 主键，自动生成
  id: number;

  @Column() // 普通列
  name: string;

  @Column()
  email: string;
}

@Entity('users'): 将 User 类映射到名为 users 的数据库表。
@PrimaryGeneratedColumn(): 定义 id 列为主键，并且自动生成。
@Column(): 定义 name 和 email 列为普通列。

将实体添加到模块

在 users.module.ts 中，引入并配置 TypeOrmModule.forFeature():

// src/users/users.module.ts
import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
import { UsersController } from './users.controller';
import { UsersService } from './users.service';
import { User } from './user.entity';

@Module({
  imports: [TypeOrmModule.forFeature([User])], // 注册 User 实体
  controllers: [UsersController],
  providers: [UsersService],
})
export class UsersModule {}

TypeOrmModule.forFeature([User]) 会将 User 实体注册到当前模块中。

在服务中使用 TypeORM

注入 Repository

在 users.service.ts 中，注入 Repository：

// src/users/users.service.ts
import { Injectable } from '@nestjs/common';
import { InjectRepository } from '@nestjs/typeorm';
import { Repository } from 'typeorm';
import { User } from './user.entity';

@Injectable()
export class UsersService {
  constructor(
    @InjectRepository(User) // 注入 User 实体对应的 Repository
    private usersRepository: Repository<User>,
  ) {}

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

  async create(user: Partial<User>): Promise<User> {
    const newUser = this.usersRepository.create(user);
    return await this.usersRepository.save(newUser);
  }
}

@InjectRepository(User): 注入 User 实体对应的 Repository。
this.usersRepository.find(): 查询所有用户。
this.usersRepository.create(user): 创建一个新的用户实体。
this.usersRepository.save(newUser): 将新用户保存到数据库。

修改控制器

修改 users.controller.ts，使用服务中的方法：

// src/users/users.controller.ts
import { Controller, Get, Post, Body } from '@nestjs/common';
import { UsersService } from './users.service';
import { CreateUserDto } from './dto/create-user.dto'; // 假设你创建了一个 DTO

@Controller('users')
export class UsersController {
  constructor(private readonly usersService: UsersService) {}

  @Get()
  async findAll() {
    return await this.usersService.findAll();
  }

  @Post()
  async create(@Body() createUserDto: CreateUserDto) {
    return await this.usersService.create(createUserDto);
  }
}

测试

现在，你可以运行 npm run start:dev 或 yarn start:dev，然后使用 Postman 或其他工具测试 API：

GET /users: 获取所有用户。
POST /users: 创建一个新的用户（请求体格式：{"name": "John Doe", "email": "john.doe@example.com"}）。

总结

在本篇文章中，我们学习了如何在 NestJS 应用中集成数据库，使用 TypeORM 和 PostgreSQL。我们了解了如何配置 TypeORM、创建实体、使用 Repository 进行数据库操作。现在，你可以使用 NestJS 构建具有数据持久化的应用程序了。

在下一篇文章中，我们将学习如何使用 NestJS 进行身份验证和授权。

说明:

详细步骤: 文档包含了安装依赖、配置 TypeORM、创建实体、使用 Repository 以及测试 API 的详细步骤。
代码示例: 提供了大量的代码示例，方便理解。
概念解释: 对 TypeORM 和 Entity 进行了详细的解释。
实践操作: 提供了完整的实例，可以实际操作并验证。
结构清晰: 使用了 Markdown 语法，结构清晰，易于阅读。
实用性强: 文章内容实用，可以帮助你构建具有数据持久化的 NestJS 应用。