NestJS 多租户模块最佳实践教程

1、项目介绍

NestJS Tenancy 是一个简单易用的多租户模块，专为 NestJS 和 Mongoose 设计。它支持将应用程序分割为多个租户，每个租户都有自己的数据库实例，实现了数据隔离和安全性。

2、项目快速启动

安装模块

首先，你需要安装 @needle-innovision/nestjs-tenancy 模块。根据你的 NestJS 版本选择合适的命令：

• NestJS v9.x: npm i --save @needle-innovision/nestjs-tenancy
• NestJS v8.x: npm i --save @needle-innovision/nestjs-tenancy@2.0.0
• NestJS v6.x 或 v7.x: npm i --save @needle-innovision/nestjs-tenancy@1.0.21

创建模块

在你的 NestJS 应用程序中，创建一个模块，例如 CatModule。然后，导入 TenancyModule 并使用 forFeature 方法注册该模块。

import { Module } from '@nestjs/common';
import { TenancyModule } from '@needle-innovision/nestjs-tenancy';
import { CatsController } from './cats.controller';
import { CatsService } from './cats.service';
import { Cat, CatSchema } from './schemas/cat.schema';

@Module({
  imports: [TenancyModule.forFeature([{ name: Cat.name, schema: CatSchema }])],
  controllers: [CatsController],
  providers: [CatsService],
})
export class CatsModule {}

创建模型

创建一个模型，例如 Cat，描述你的数据结构。然后，使用 SchemaFactory.createForClass 方法生成 Mongoose 模型。

import { Prop, Schema, SchemaFactory } from '@nestjs/mongoose';
import { Document } from 'mongoose';

@Schema()
export class Cat extends Document {
  @Prop()
  name: string;

  @Prop()
  age: number;

  @Prop()
  breed: string;
}

export const CatSchema = SchemaFactory.createForClass(Cat);

创建服务

创建一个服务，例如 CatsService，用于操作模型。在构造函数中，使用 InjectTenancyModel 装饰器注入模型。

import { Injectable } from '@nestjs/common';
import { InjectTenancyModel } from '@needle-innovision/nestjs-tenancy';
import { Model } from 'mongoose';
import { CreateCatDto } from './dto/create-cat.dto';
import { Cat } from './schemas/cat.schema';

@Injectable()
export class CatsService {
  constructor(
    @InjectTenancyModel(Cat.name)
    private readonly catModel: Model<Cat>
  ) {}

  async create(createCatDto: CreateCatDto): Promise<Cat> {
    const createdCat = new this.catModel(createCatDto);
    return createdCat.save();
  }

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

创建控制器

创建一个控制器，例如 CatsController，用于处理 HTTP 请求。在构造函数中，注入服务。

import { Body, Controller, Get, Post } from '@nestjs/common';
import { CatsService } from './cats.service';
import { CreateCatDto } from './dto/create-cat.dto';
import { Cat } from './schemas/cat.schema';

@Controller('cats')
export class CatsController {
  constructor(private readonly catsService: CatsService) {}

  @Post()
  async create(@Body() createCatDto: CreateCatDto) {
    return this.catsService.create(createCatDto);
  }

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

3、应用案例和最佳实践

NestJS Tenancy 可以应用于各种场景，例如：

• SaaS 应用程序
• 企业内部管理系统
• 多租户数据库管理系统

最佳实践：

• 使用 TenancyValidator 接口实现自定义租户验证逻辑。
• 使用环境变量配置数据库连接信息。
• 为每个租户创建单独的数据库用户和密码，确保安全性。

4、典型生态项目

目前，NestJS Tenancy 仅支持 Mongoose。但是，它可以与其他 NestJS 生态系统项目一起使用，例如：

• NestJS Guard：用于身份验证和授权。
• NestJS JWT：用于生成和验证 JWT 令牌。

通过遵循以上最佳实践，你可以轻松地实现一个安全、可靠的多租户应用程序。希望这个教程能帮助你入门 NestJS Tenancy！