NestJS多租户模块最佳实践

NestJS多租户模块最佳实践

nestjs-tenancy Multi-tenancy approach for nestjs - currently supported only for mongodb with mongoose 项目地址: https://gitcode.com/gh_mirrors/ne/nestjs-tenancy

本文档将详细介绍如何在NestJS项目中集成和使用nestjs-tenancy模块，以实现多租户架构。我们将涵盖项目介绍、快速启动、应用案例和最佳实践以及典型生态项目。

项目介绍

nestjs-tenancy是一个简单易用的多租户模块，用于NestJS和Mongoose。它允许您为每个租户提供独立的数据库实例，从而实现数据隔离和安全性。该模块目前仅支持Mongodb和Mongoose。

项目快速启动

1. 安装

首先，您需要将nestjs-tenancy模块安装到您的NestJS项目中。您可以使用以下命令：

npm install @needle-innovision/nestjs-tenancy

2. 配置

在app.module.ts文件中，导入TenancyModule并使用forRoot方法进行配置。您需要指定租户标识符和数据库URI生成逻辑。

import { Module } from '@nestjs/common';
import { TenancyModule } from '@needle-innovision/nestjs-tenancy';
import { CatsModule } from './cat.module';

@Module({
  imports: [
    TenancyModule.forRoot({
      tenantIdentifier: 'X-TENANT-ID',
      options: () => ({}),
      uri: (tenantId: string) => `mongodb://localhost/test-tenant-${tenantId}`,
    }),
    CatsModule,
  ],
})
export class AppModule {}

3. 创建租户模型

在cat.model.ts文件中，定义您的租户模型并使用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);

4. 创建租户模块

在cat.module.ts文件中，导入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 {}

5. 创建控制器和服务

在cats.service.ts文件中，导入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();
  }
}

在cats.controller.ts文件中，创建您的控制器并使用服务方法。

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();
  }
}

应用案例和最佳实践

应用案例

假设您正在构建一个多租户SaaS应用程序，每个租户都有自己的数据和权限。使用nestjs-tenancy模块，您可以轻松地为每个租户提供独立的数据库实例，从而确保数据隔离和安全。

最佳实践

1. 为每个租户创建独立的数据库实例。
2. 使用租户标识符来区分不同租户的数据。
3. 使用自定义验证器来验证租户是否存在。
4. 使用租户模型和服务来操作租户数据。

典型生态项目

1. nestjs: NestJS是一个强大的Node.js框架，用于构建高效、可扩展的服务端应用程序。
2. mongoose: Mongoose是一个流行的Node.js ODM库，用于与MongoDB数据库进行交互。
3. @nestjs/mongoose: NestJS的Mongoose模块，用于将Mongoose集成到NestJS项目中。

通过集成和使用nestjs-tenancy模块，您可以轻松地为您的NestJS项目添加多租户功能，从而构建可扩展、安全的SaaS应用程序。

nestjs-tenancy Multi-tenancy approach for nestjs - currently supported only for mongodb with mongoose 项目地址: https://gitcode.com/gh_mirrors/ne/nestjs-tenancy