SQL（Sequelize）

本章仅适用于 TypeScript

警告

在本文中，你将学习如何基于 Sequelize 包，通过自定义组件从零创建一个 DatabaseModule。因此，这种技术会包含较多额外负担，而这些内容其实可以通过现成可用的 @nestjs/sequelize 包避免掉。要了解更多内容，请参见这里。

Sequelize 是一个流行的对象关系映射器（ORM），它使用原生 JavaScript 编写；不过也有一个 sequelize-typescript TypeScript 封装，它为基础的 sequelize 提供了一组装饰器以及其他增强能力。

入门

要开始使用这个库，我们需要安装以下依赖：

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

第一步是通过向构造函数传入选项对象来创建一个 Sequelize 实例。此外，我们还需要添加所有模型（另一种做法是使用 modelPaths 属性），并对数据库表执行 sync()。

// database.providers.ts
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;
    },
  },
];

提示

遵循最佳实践，我们将自定义 provider 声明在一个独立文件中，并使用 *.providers.ts 后缀。

然后，我们需要导出这些 provider，以便应用的其他部分也能访问它们。

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

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

现在我们就可以使用 @Inject() 装饰器注入 Sequelize 对象。任何依赖 Sequelize 异步 provider 的类，都会等待对应的 Promise 被解析。

注入模型

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

// cat.entity.ts
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 provider 了：

// cats.providers.ts
import { Cat } from './cat.entity';

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

警告

在真实应用中，应避免使用魔法字符串。CATS_REPOSITORY 和 SEQUELIZE 都应该放在单独的 constants.ts 文件中。

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

现在我们就可以在 CatsService 中使用 @Inject() 装饰器注入 CATS_REPOSITORY：

// cats.service.ts
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 provider 会等待数据库连接完成，而 CatsService 也会延迟到 repository 准备就绪之后才实例化。整个应用会在所有类都完成实例化后再启动。

下面是最终的 CatsModule：

// cats.module.ts
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 {}

提示

别忘了在根 AppModule 中导入 CatsModule。