NestJS 中文文档

SQL (Sequelize)

本章仅适用于 TypeScript

警告本文中，您将学习如何基于 Sequelize 包使用自定义组件从零开始创建 DatabaseModule。因此，该技术包含许多额外工作，您可以通过使用开箱即用的专用 @nestjs/sequelize 包来避免。了解更多信息，请参阅此处。

Sequelize 是一个用原生 JavaScript 编写的流行对象关系映射器(ORM)，但有一个 sequelize-typescript TypeScript 包装器，为基础 sequelize 提供了一系列装饰器和其他附加功能。

快速开始

要开始使用这个库的冒险之旅，我们需要先安装以下依赖项：

$ npm install --save sequelize sequelize-typescript mysql2
$ npm install --save-dev @types/sequelize

第一步是创建一个带有选项对象的 Sequelize 实例，并将其传入构造函数。此外，我们需要添加所有模型（另一种方法是使用 modelPaths 属性）并 sync() 我们的数据库表。

@@filename(database.providers)
import { Sequelize } from 'sequelize-typescript';
import { Cat } from '../cats/cat.entity';

export const databaseProviders = [
  {
    provide: 'SEQUELIZE',
    useFactory: async () => {
      const sequelize = new Sequelize({
        dialect: 'mysql',
        host: 'localhost',
        port: 3306,
        username: 'root',
        password: 'password',
        database: 'nest',
      });
      sequelize.addModels([Cat]);
      await sequelize.sync();
      return sequelize;
    },
  },
];

提示遵循最佳实践，我们在单独的文件中声明了自定义提供者，该文件具有 *.providers.ts 后缀。

然后，我们需要导出这些提供者，使它们对应用程序的其余部分可访问 。

import { Module } from '@nestjs/common';
import { databaseProviders } from './database.providers';

@Module({
  providers: [...databaseProviders],
  exports: [...databaseProviders],
})
export class DatabaseModule {}

现在我们可以使用 @Inject() 装饰器注入 Sequelize 对象。每个依赖 Sequelize 异步提供者的类都将等待 Promise 解析完成。

模型注入

在 Sequelize 中，Model 定义了数据库中的一张表。该类的实例代表数据库中的一行记录。首先，我们至少需要一个实体：

@@filename(cat.entity)
import { Table, Column, Model } from 'sequelize-typescript';

@Table
export class Cat extends Model {
  @Column
  name: string;

  @Column
  age: number;

  @Column
  breed: string;
}

Cat 实体属于 cats 目录，该目录代表 CatsModule 模块。现在该创建一个 Repository 提供者了：

@@filename(cats.providers)
import { Cat } from './cat.entity';

export const catsProviders = [
  {
    provide: 'CATS_REPOSITORY',
    useValue: Cat,
  },
];

warning 注意在实际应用中应避免使用 魔法字符串 。建议将 CATS_REPOSITORY 和 SEQUELIZE 都存放在独立的 constants.ts 文件中。

在 Sequelize 中，我们使用静态方法来操作数据，因此这里创建了一个别名。

现在我们可以通过 @Inject() 装饰器将 CATS_REPOSITORY 注入到 CatsService 中：

@@filename(cats.service)
import { Injectable, Inject } from '@nestjs/common';
import { CreateCatDto } from './dto/create-cat.dto';
import { Cat } from './cat.entity';

@Injectable()
export class CatsService {
  constructor(
    @Inject('CATS_REPOSITORY')
    private catsRepository: typeof Cat
  ) {}

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

数据库连接是异步的 ，但 Nest 使这个过程对终端用户完全透明。CATS_REPOSITORY 提供者会等待数据库连接完成，而 CatsService 会延迟到存储库准备就绪。整个应用会在所有类实例化完成后启动。

以下是最终的 CatsModule：

@@filename(cats.module)
import { Module } from '@nestjs/common';
import { CatsController } from './cats.controller';
import { CatsService } from './cats.service';
import { catsProviders } from './cats.providers';
import { DatabaseModule } from '../database/database.module';

@Module({
  imports: [DatabaseModule],
  controllers: [CatsController],
  providers: [
    CatsService,
    ...catsProviders,
  ],
})
export class CatsModule {}

提示不要忘记将 CatsModule 导入根模块 AppModule。

ON THIS PAGE

SQL (Sequelize)#

本章仅适用于 TypeScript#

快速开始#

模型注入#

SQL (Sequelize)

本章仅适用于 TypeScript

快速开始

模型注入