Sequelize 与 NestJS 集成教程

Sequelize 与 NestJS 集成教程

sequelizeSequelize module for Nest framework (node.js) 🍈项目地址:https://gitcode.com/gh_mirrors/seq/sequelize

项目介绍

Sequelize 是一个基于 Promise 的 Node.js ORM，支持多种数据库如 Postgres, MySQL, MariaDB, SQLite 和 Microsoft SQL Server。它提供了强大的事务支持、关联关系、预读和延迟加载等功能。NestJS 是一个用于构建高效、可靠和可扩展的服务器端应用程序的框架。本教程将指导如何在 NestJS 项目中集成和使用 Sequelize。

项目快速启动

安装依赖

首先，确保你已经安装了 NestJS CLI，然后创建一个新的 NestJS 项目：

npm i -g @nestjs/cli
nest new my-sequelize-app
cd my-sequelize-app

接下来，安装 Sequelize 和所需的数据库驱动：

npm install --save @nestjs/sequelize sequelize sequelize-typescript mysql2

配置 Sequelize

在 app.module.ts 中配置 Sequelize：

import { Module } from '@nestjs/common';
import { SequelizeModule } from '@nestjs/sequelize';

@Module({
  imports: [
    SequelizeModule.forRoot({
      dialect: 'mysql',
      host: 'localhost',
      port: 3306,
      username: 'root',
      password: 'password',
      database: 'test',
      models: [],
    }),
  ],
})
export class AppModule {}

创建模型

创建一个简单的用户模型 user.model.ts：

import { Table, Column, Model } from 'sequelize-typescript';

@Table
export class User extends Model<User> {
  @Column
  name: string;

  @Column
  email: string;
}

在 app.module.ts 中引入该模型：

import { User } from './user.model';

@Module({
  imports: [
    SequelizeModule.forRoot({
      // ...其他配置
      models: [User],
    }),
  ],
})
export class AppModule {}

使用模型

创建一个用户服务 user.service.ts：

import { Injectable } from '@nestjs/common';
import { InjectModel } from '@nestjs/sequelize';
import { User } from './user.model';

@Injectable()
export class UserService {
  constructor(
    @InjectModel(User)
    private userModel: typeof User,
  ) {}

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

  async create(user: User): Promise<User> {
    return this.userModel.create(user);
  }
}

在 app.module.ts 中引入用户服务：

import { UserService } from './user.service';

@Module({
  imports: [
    // ...其他配置
  ],
  providers: [UserService],
})
export class AppModule {}

应用案例和最佳实践

案例：用户管理系统

一个常见的应用案例是构建一个用户管理系统。使用 Sequelize 和 NestJS，你可以轻松实现用户的增删改查功能。以下是一个简单的用户控制器 user.controller.ts：

import { Controller, Get, Post, Body } from '@nestjs/common';
import { UserService } from './user.service';
import { User } from './user.model';

@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. 模型设计：合理设计数据库模型，确保数据的一致性和完整性。
2. 事务管理：在需要保证数据一致性的操作中使用事务。
3. 错误处理：合理处理数据库操作中的异常，提供

sequelizeSequelize module for Nest framework (node.js) 🍈项目地址:https://gitcode.com/gh_mirrors/seq/sequelize