Nodejs Nestjs ORM框架nestjs-typeorm的使用

Nodejs Nestjs ORM框架nestjs-typeorm的使用
NestJS 是一个用于构建高效、可扩展的 Node.js 服务器端应用程序的框架。@nestjs/typeorm 是 NestJS 的一个模块，它集成了 TypeORM（一个 ORM 库），使得在 NestJS 项目中使用数据库变得更加简单。

下面是如何在 NestJS 项目中使用 @nestjs/typeorm 的基本步骤：

1. 安装必要的依赖

首先，你需要安装 NestJS、TypeORM 和相关的数据库驱动。以 MySQL 数据库为例：

npm install @nestjs/core @nestjs/common @nestjs/typeorm typeorm mysql2

如果你使用的是其他数据库（如 PostgreSQL 或 SQLite），请替换 mysql2 为相应的数据库驱动包（例如 pg 或 sqlite3）。

2. 配置 TypeORM

在你的 NestJS 项目中，你可以在 app.module.ts 文件中配置 TypeORM。这里是一个简单的例子：

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

@Module({
  imports: [
    TypeOrmModule.forRoot({
      type: 'mysql', // 数据库类型
      host: 'localhost',
      port: 3306,
      username: 'test',
      password: 'test',
      database: 'test',
      entities: [__dirname + '/**/*.entity{.ts,.js}'], // 实体类路径
      synchronize: true, // 自动同步数据库模式
    }),
  ],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

3. 创建实体类

在 NestJS 中，你可以通过创建 TypeScript 类来定义数据库表结构。这些类被称为“实体”。例如，创建一个名为 User 的实体：

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

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

  @Column()
  name: string;

  @Column()
  email: string;
}

4. 使用 Repository 进行数据库操作

在服务中，你可以通过注入 Repository 来进行数据库操作。例如：

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)
    private usersRepository: Repository<User>,
  ) {}

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

  findOne(id: number): Promise<User> {
    return this.usersRepository.findOneBy({ id });
  }

  async remove(id: number): Promise<void> {
    await this.usersRepository.delete(id);
  }
}

5. 控制器

最后，你可以创建控制器来处理 HTTP 请求，并调用服务中的方法：

import { Controller, Get, Param, Post, Body } from '@nestjs/common';
import { UsersService } from './users.service';
import { User } from './user.entity';

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

  @Get()
  findAll(): Promise<User[]> {
    return this.usersService.findAll();
  }

  @Get(':id')
  findOne(@Param('id') id: string): Promise<User> {
    return this.usersService.findOne(+id);
  }

  @Post()
  create(@Body() user: User): Promise<User> {
    return this.usersService.create(user);
  }
}

以上就是使用 @nestjs/typeorm 在 NestJS 项目中集成和使用 TypeORM 的基本流程。