ZenWeb Tenant module

ZenWeb

多租户多数据库支持

安装

1yarn add @zenweb/tenant

配置

编辑项目入口代码 src/index.ts

1import { create } from 'zenweb';
2import modTenant, { Tenant } from '@zenweb/tenant';
3
4export const app = create();
5
6/**
7 * 租户配置信息（代码演示）
8 */
9const tenantsConfig: { [id: string]: Tenant } = {
10  'a.demo.com': {
11    server: 'S1',
12    database: 'db_1',
13  },
14  'b.demo.com': {
15    server: 'S2',
16    database: 'db_2',
17  },
18};
19
20app.setup(modTenant({
21  tenantGetter: ctx => {
22    const tenant = tenantsConfig[ctx.host];
23    if (!tenant) {
24      throw new Error('Tennat not exists: ' + ctx.host);
25    }
26    return tenant;
27  },
28  pools: {
29    S1: { // 数据库服务器名称
30      MASTER: { // 主库
31        host: '127.0.0.1',
32        port: 3306,
33        user: 'root',
34        password: '123456',
35        charset: 'utf8mb4',
36        timezone: '+08:00',
37        connectionLimit: 100,
38      },
39      // 从库配置
40      // SLAVES: []
41    },
42    S2: {
43      MASTER: {
44        host: '127.0.0.1',
45        port: 3306,
46        user: 'root',
47        password: '',
48        charset: 'utf8mb4',
49        timezone: '+08:00',
50        connectionLimit: 100,
51      },
52    },
53  },
54}));

代码中调用

使用 MySQL 原生查询

1import { mapping, Context } from 'zenweb';
2
3export class TestController {
4  @mappping()
5  dbtest(ctx: Context) {
6    // 默认使用主库 MASTER
7    await ctx.mysql.query("SELECT 1+1");
8    // 指定使用主库
9    await ctx.mysql.of("MASTER").query("SELECT 1+1");
10    // 指定使用从库 - 对于没有配置从库的会自动切换成主库 MASTER
11    await ctx.mysql.of("SLAVE*").query("SELECT 1+1");
12  }
13}

[可选] 集成 ZenORM

安装

1# 生产依赖
2yarn add zenorm
3
4# 开发依赖
5yarn add --dev @zenorm/generate @zenorm/generate-mysql

配置

在 package.json 的 scripts 中增加如下代码，用于执行 dbgen 命令

1{
2  "scripts": {
3    "dbgen": "zenorm-generate .dbgen.js"
4  }
5}

创建文件 .dbgen.js 用于生成数据库结构代码时连接到指定数据库

提示：运行时并不使用此配置

1/** @type {import("@zenorm/generate").GenerateConfig} */
2module.exports = {
3  host: "localhost",
4  port: 3306,
5  user: "root",
6  password: "",
7  database: "zenorm_test",
8  outputDir: "./model",
9  bindQuery: true,
10};

生成数据库结构代码

运行命令开始生成数据库结构代码

1yarn dbgen

配置项目代码

编辑项目入口代码 src/index.ts

1// 导入 ORM 生成的 bindQuery 方法
2import { bindQuery } from './model';
3
4// 修改配置好的 modTenant
5// 集成 ZenORM
6app.setup(modTenant({
7  // ... modTenant 配置
8  bindQuery, // ORM 查询绑定
9});

代码中调用 ORM 模型

1import { mapping } from 'zenweb';
2import { User } from '../model';
3
4export class TestController {
5  @mapping()
6  orm() {
7    return User.find({ id: 1 }).get();
8  }
9}