Nest.js 如何使用 TypeORM 操作数据库？

推荐答案

在 Nest.js 中使用 TypeORM 操作数据库的步骤如下：

1. 安装依赖： 首先需要安装 @nestjs/typeorm 和 typeorm 依赖包。

   npm install @nestjs/typeorm typeorm mysql2

2. 配置数据库连接： 在 app.module.ts 中配置 TypeORM 模块，并指定数据库连接信息。

   // 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 {}

3. 创建实体： 定义一个实体类来表示数据库中的表结构。

   // www.javascriptcn.com code example
   import { Entity, Column, PrimaryGeneratedColumn } from 'typeorm';
   
   @Entity()
   export class User {
     @PrimaryGeneratedColumn()
     id: number;
   
     @Column()
     name: string;
   
     @Column()
     age: number;
   }

4. 创建 Repository： 在服务层中使用 TypeOrmModule.forFeature() 来注入实体对应的 Repository。

   // 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();
     }
   
     async create(user: User): Promise<User> {
       return this.userRepository.save(user);
     }
   }

5. 在控制器中使用服务： 在控制器中注入服务，并调用服务层的方法来操作数据库。

   // www.javascriptcn.com code example
   import { Controller, Get, Post, Body } from '@nestjs/common';
   import { UserService } from './user.service';
   import { User } from './user.entity';
   
   @Controller('users')
   export class UserController {
     constructor(private readonly userService: UserService) {}
   
     @Get()
     async findAll(): Promise<User[]> {
       return this.userService.findAll();
     }
   
     @Post()
     async create(@Body() user: User): Promise<User> {
       return this.userService.create(user);
     }
   }

本题详细解读

1. TypeORM 简介

TypeORM 是一个基于 TypeScript 的 ORM（对象关系映射）框架，它允许开发者通过面向对象的方式来操作数据库。TypeORM 支持多种数据库，如 MySQL、PostgreSQL、SQLite 等。

2. Nest.js 与 TypeORM 的集成

Nest.js 提供了 @nestjs/typeorm 模块，使得 TypeORM 可以无缝集成到 Nest.js 应用中。通过 TypeOrmModule.forRoot() 方法，可以配置数据库连接信息，并通过 TypeOrmModule.forFeature() 方法在服务层中注入实体对应的 Repository。

3. 实体与 Repository

实体是 TypeORM 中的核心概念，它代表了数据库中的一张表。通过装饰器（如 @Entity、@Column 等）可以定义表的结构。Repository 是 TypeORM 提供的一个接口，用于操作实体对应的数据库表。

4. 数据库操作

在服务层中，可以通过注入的 Repository 对象来执行各种数据库操作，如查询、插入、更新、删除等。这些操作都是通过 TypeORM 提供的 API 来实现的。

5. 控制器与服务层的交互

控制器负责处理 HTTP 请求，并将请求转发给服务层。服务层则负责具体的业务逻辑和数据库操作。通过这种分层架构，可以使得代码更加清晰和易于维护。

6. 同步数据库结构

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

通过以上步骤，你可以在 Nest.js 中轻松地使用 TypeORM 来操作数据库。