使用这个model操作数据库，一爽到底

在前一篇文章中，我们简要介绍了Vonajs的核心功能。在这里，我们再来看看Vonajs提供的Model能力，可以让我们用简洁、优雅的代码全方位操作数据库，比如，动态分表、软删除、多租户、动态数据源、二级缓存，等等

创建Model

比如，我们在模块 demo-student 中创建一个 Model: student

1. Cli命令

$ vona :create:bean model student --module=demo-student

2. 菜单命令

使用菜单命令可以显著提升开发体验，减少心智负担

右键菜单 - [模块路径]: `Vona Create/Model`

Model定义

import { BeanModelBase, Model } from 'vona-module-a-database';
import { EntityStudent } from '../entity/student.ts';

@Model({ entity: EntityStudent })
export class ModelStudent extends BeanModelBase<EntityStudent> {}

• 继承自 BeanModelBase 基类
• 使用 Model 装饰器
• 设置对应的 entity

使用Model

在 Vona 中使用 Model，支持依赖注入和依赖查找。推荐使用依赖查找，因为依赖查找可以让代码更加简洁、直观

1. 本模块查找

class ServiceStudent {
  async findAll(): Promise<EntityStudent[]> {
    return await this.scope.model.student.select();
  }
}

• this.scope：当前模块的scope对象
• this.scope.model.student：从scope中直接获取student model实例

2. 跨模块查找

class ServiceStudent {
  async findAll(): Promise<EntityStudent[]> {
    return await this.$scope.demoStudent.model.student.select();
  }
}

• this.$scope.demoStudent：获取指定模块的scope对象
• this.$scope.demoStudent.model.student：从scope中直接获取student model实例

CRUD

在这里，我们仅介绍基本的 CRUD 操作

1. Create

class ServiceStudent {
  async create(student: DtoStudentCreate): Promise<EntityStudent> {
    return await this.scope.model.student.insert(student);
  }
}

2. Read

class ServiceStudent {
  async findAll(): Promise<EntityStudent[]> {
    return await this.scope.model.student.select();
  }

  async findOne(id: TableIdentity): Promise<EntityStudent | undefined> {
    return await this.scope.model.student.get({ id });
  }
}

• id: 类型为TableIdentity，支持number和bignumber两种字段类型

3. Update

class ServiceStudent {
  async update(id: TableIdentity, student: DtoStudentUpdate) {
    return await this.scope.model.student.update({
      ...student,
      id,
    });
  }
}

4. Delete

class ServiceStudent {
  async remove(id: TableIdentity) {
    return await this.scope.model.student.delete({ id });
  }
}

Knex Query Builder

Vona Model 底层使用的是knex。因此，也支持 knex 提供的Query Builder

1. builder

调用 model 的 builder 方法获取 knex query builder 的实例

class ServiceStudent {
  async findAll(): Promise<EntityStudent[]> {
    return await this.scope.model.student.builder().where('name', 'tom').orderBy('name');
  }
}

2. builderSelect

builderSelect 方法也是获取 knex query builder 的实例，与 builder 不同的是，builderSelect 支持软删除和多实例/多租户

class ServiceStudent {
  async findAll(): Promise<EntityStudent[]> {
    return await this.scope.model.student.builderSelect().where('name', 'tom').orderBy('name');
  }
}

Model Options

名称	说明
entity	model对应的entity
table	model对应的表名
disableDeleted	是否禁用软删除，默认为false
disableInstance	是否禁用多实例/多租户，默认为false
clientName	指定数据源名称
cacheOptions	配置缓存参数，默认启用基于redis的缓存

• table:
  • 如果为空，则从 entity 获取表名
  • 可以指定函数，实现动态分表的能力

App config配置

如果通过@Model装饰器设置的Model options不符合业务需要，我们还可以在 App config 中修改 Model options的配置。比如，设置缓存参数

src/backend/config/config/config.dev.ts

// onions
config.onions = {
  model: {
    'demo-student:student': {
      disableDeleted: true,   // 禁用软删除
      disableInstance: true,  // 禁用多实例/多租户
      cacheOptions: false,    // 禁用缓存
      clientName: 'mysql',    // 使用数据源：mysql
    },
  },
};

• demo-student:student：模块名称+model名称

动态分表

Model 支持动态分表的能力。比如，我们对 Order 进行分表处理，将每天的订单存入order_YYYYMMDD格式的数据表中

@Model({ table: (ctx: VonaContext, defaultTable: keyof ITableRecord) => {
  return `${defaultTable}_${moment().format('YYYYMMDD')}`;
} })
class ModelOrder {}

• ctx: 可以基于当前请求的上下文来动态生成表名
• defaultTable: 默认的表名，从entity中获取

软删除, 多实例/多租户

Model 默认自动启用软删除，当删除一条数据时，并不进行物理删除，而是设置字段 deleted 的值为 true

Model 默认支持多实例/多租户。对数据进行 CRUD 操作时，自动从 Request 上下文获取实例Id，并传入 sql 语句中

比如，执行model.student.select()，那么生成的 sql 如下：

select "demoStudent"."id" from "demoStudent"
  where "demoStudent"."iid" = 1 and "demoStudent"."deleted" = false

• iid：实例 Id
• deleted：软删除

临时禁用软删除

我们也可以在执行 model 方法时临时指定软删除参数

class ServiceStudent {
  async findAll(): Promise<EntityStudent[]> {
    return await this.scope.model.student.select({}, { disableDeleted: true });
  }
}

数据源

Vona 支持多数据库、多数据源。可以针对任何一个数据源调用 Model 的方法

1. 默认数据源

在默认情况下，Model 使用的是系统设置的缺省数据源

env/.env

DATABASE_DEFAULT_CLIENT = 'pg' # pg/mysql

• 系统当前默认使用的是pg数据源

2. 静态数据源

• 在 Model options 中指定数据源

@Model({ clientName: 'mysql' })
class ModelBook {}

• clientName：需要指定的数据源名称

• 在 App config 中指定数据源

src/backend/config/config/config.dev.ts

// onions
config.onions = {
  model: {
    'demo-student:student': {
      clientName: 'mysql',    // 使用数据源：mysql
    },
  },
};

3. 动态数据源

我们还可以在代码中动态指定数据源

class ServiceStudent {
  async findAll(): Promise<EntityStudent[]> {
    const modelMysql = this.scope.model.student.newInstance('mysql');
    return await modelMysql.select();
  }
}

• newInstance: 传入数据源名称，既可创建新的model实例

缓存

Vona Model 默认启用了缓存，从而使系统在默认情况下就具备非常高的性能

Model 支持二级缓存/mem缓存/redis缓存。默认使用的是redis缓存。因为redis缓存可以在分布式场景下保持数据的一致性，而mem缓存在分布式场景下同步数据有延时。如果业务数据变更不频繁，可以使用mem缓存或者二级缓存，从而获得更高性能

如何设置缓存配置：

1. 禁用缓存

@Model({ cacheOptions: false })
class ModelStudent {}

2. 在 Model options 中配置缓存

@Model({ cacheOptions: {
  mode: 'all', // all/mem/redis
  mem: {
    max: 500,
    ttl: 5 * 1000, // 5s
  },
  redis: {
    ttl: 5 * 1000, // 5s
  },
} })
class ModelStudent {}

• mode：缓存模式：支持二级缓存/mem缓存/redis缓存
• mem：mem缓存配置
• redis：redis缓存配置

3. 在 App config 中配置缓存

我们也可以在App config中根据业务需要修改Model的缓存配置

src/backend/config/config/config.dev.ts

// onions
config.onions = {
  model: {
    'demo-student:student': {
      cacheOptions: {
        mode: 'all', // all/mem/redis
        mem: {
          max: 500,
          ttl: 5 * 1000, // 5s
        },
        redis: {
          ttl: 5 * 1000, // 5s
        },
      }
    },
  },
};

结语

Vonajs已开源：https://github.com/vonajs/vona

Vonajs作者正在B站直播撰写技术文档，工作日每晚8:30，欢迎围观：濮水代码

开发一个功能完备的Nodejs框架固然费时费力，但是撰写技术文档更加费尽心思。写文档的过程同时也是再次梳理思路的过程，即便是围观，也有利于加深对框架设计的理解，探索不一样的架构设计路径。目前已完成部分文档，更多精彩正在逐步展开，欢迎参与