Cursor rule

1---
2description: 多租户(Tenant)
3globs: 
4---
5# 多租户（v8.0新增）
6 
7多租户（Multi-tenancy）是一种软件架构模式，允许单个应用实例服务多个租户（客户组织）。每个租户的数据是相互隔离的，但共享同一个应用程序代码和基础设施。
8 
9 
10## 主要特点
11 
12- **数据隔离**: 确保不同租户之间的数据严格分离，互不可见
13- **资源共享**: 多个租户共享同一套应用程序代码和基础设施
14- **独立配置**: 每个租户可以有自己的个性化配置和定制化需求
15- **成本优化**: 通过资源共享降低运营和维护成本
16 
17## 实现
18 
19### 1、数据隔离
20 
21多租户的数据隔离有许多种方案，但最为常见的是以列进行隔离的方式。Cool Admin 通过在`BaseEntity`中加入指定的列（租户ID `tenantId`）对数据进行隔离。
22 
23::: tip 小贴士
24 
25v8.0之后，`BaseEntity`已经从`cool-midway/core`中移动至`src/modules/base/entity/base.ts`，方便开发者扩展定制
26 
27:::
28 
29 
30`src/modules/base/entity/base.ts`
31```ts
32import {
33  Index,
34  UpdateDateColumn,
35  CreateDateColumn,
36  PrimaryGeneratedColumn,
37  Column,
38} from 'typeorm';
39import { CoolBaseEntity } from '@cool-midway/core';
40 
41/**
42 * 实体基类
43 */
44export abstract class BaseEntity extends CoolBaseEntity {
45  // 默认自增
46  @PrimaryGeneratedColumn('increment', {
47    comment: 'ID',
48  })
49  id: number;
50 
51  @Index()
52  @CreateDateColumn({ comment: '创建时间' })
53  createTime: Date;
54 
55  @Index()
56  @UpdateDateColumn({ comment: '更新时间' })
57  updateTime: Date;
58 
59  @Index()
60  @Column({ comment: '租户ID', nullable: true })
61  tenantId: number;
62}
63 
64```
65 
66### 2、条件注入
67 
68Cool 改造了 `typeorm`的 `Subscriber`，新增了以下四种监听：
69 
70```ts
71/**
72 * 当进行select的QueryBuilder构建之后触发
73 */
74afterSelectQueryBuilder?(queryBuilder: SelectQueryBuilder<any>): void;
75 
76/**
77 * 当进行insert的QueryBuilder构建之后触发
78 */
79afterInsertQueryBuilder?(queryBuilder: InsertQueryBuilder<any>): void;
80 
81/**
82 * 当进行update的QueryBuilder构建之后触发
83 */
84afterUpdateQueryBuilder?(queryBuilder: UpdateQueryBuilder<any>): void;
85 
86/**
87 * 当进行delete的QueryBuilder构建之后触发
88 */
89afterDeleteQueryBuilder?(queryBuilder: DeleteQueryBuilder<any>): void;
90```
91 
92在`src/modules/base/db/tenant.ts`中，通过`tenantId`进行条件注入，从而实现数据隔离。
93 
94## 使用
95 
96### 1、开启多租户
97 
98框架默认关闭多租户，需要手动开启，在`src/config/config.default.ts`中开启多租户
99 
100```ts
101cool: {
102    // 是否开启多租户
103    tenant: {
104      // 是否开启多租户
105      enable: true,
106      // 需要过滤多租户的url， 支持通配符，如/admin/**/* 表示admin模块下的所有接口都进行多租户过滤
107      urls: [],
108    },
109  }
110```
111tenant
112### 2、代码中使用
113 
114只要开启了多租户，并配置了`urls`，那么框架会自动注入`tenantId`，开发者原本的代码不需要做任何修改，框架会自动进行数据隔离。
115 
116#### Controller
117 
118@CoolController的`add`、`delete`、`update`、`info`、`list`、`page`方法都支持过滤多租户。
119 
120 
121#### Service
122 
123`Service`中使用多租户，以下是一个完整的示例，包含有效和无效的情况，开发者需要结合实际业务进行选择。
124 
125```ts
126import { Inject, Provide } from '@midwayjs/core';
127import { BaseService } from '@cool-midway/core';
128import { InjectEntityModel } from '@midwayjs/typeorm';
129import { Repository } from 'typeorm';
130import { DemoGoodsEntity } from '../entity/goods';
131import { UserInfoEntity } from '../../user/entity/info';
132import { noTenant } from '../../base/db/tenant';
133 
134/**
135 * 商品服务
136 */
137@Provide()
138export class DemoTenantService extends BaseService {
139  @InjectEntityModel(DemoGoodsEntity)
140  demoGoodsEntity: Repository<DemoGoodsEntity>;
141 
142  @Inject()
143  ctx;
144 
145  /**
146   * 使用多租户
147   */
148  async use() {
149    await this.demoGoodsEntity.createQueryBuilder().getMany();
150    await this.demoGoodsEntity.find();
151  }
152 
153  /**
154   * 不使用多租户(局部不使用)
155   */
156  async noUse() {
157    // 过滤多租户
158    await this.demoGoodsEntity.createQueryBuilder().getMany();
159    // 被noTenant包裹，不会过滤多租户
160    await noTenant(this.ctx, async () => {
161      return await this.demoGoodsEntity.createQueryBuilder().getMany();
162    });
163    // 过滤多租户
164    await this.demoGoodsEntity.find();
165  }
166 
167  /**
168   * 无效多租户
169   */
170  async invalid() {
171    // 自定义sql，不进行多租户过滤
172    await this.nativeQuery('select * from demo_goods');
173    // 自定义分页sql，进行多租户过滤
174    await this.sqlRenderPage('select * from demo_goods', {});
175  }
176}
177 
178```