利用云函数的生命周期来管理数据库连接

在第一讲云函数的生命周期中，我们已经提到了在云函数 Mount 阶段创建数据库连接带来的两方面好处：

有效降低数据库连接数（每个请求创建一个连接 -> 每个实例创建一个连接）
性能优化（每个请求创建一个连接 -> 多个请求复用实例的连接）

我们再回顾一下示例代码：

import { Func } from '@faasjs/func'; // FaasJS 的云函数类
import { Sql } from '@faasjs/sql'; // FaasJS 的 Sql 插件

// 初始化数据库对象
const sql = new Sql();

// 返回云函数实例
export default new Func({
  plugins: [sql], // 插件管理，FaasJS 将自动管理插件的生命周期
  async handler(){ // 业务代码
    return await sql.query('SELECT * FROM users WHERE id = ?', [1]);
  }
});

FaasJS 的 Sql 插件支持 Mysql、PostgreSql 和 Sqlite 及支持这三类数据库协议的数据库，且已经内部封装了基于云函数生命周期机制的最佳实践，开发者只需直接使用即可。

使用 Knex、TypeScript 结合提升开发效率和质量

Knex 是一个 SQL 语句生成插件，并且可以与 TypeScript 结合，大幅简化开发者对数据库的操作。

我们直接看代码示例：

// user.func.ts
import { Func } from '@faasjs/func'; // FaasJS 的云函数类
import { Sql } from '@faasjs/sql'; // FaasJS 的 Sql 插件
import knex from 'knex';

// 使用 TypeScript 来定义用户表的结构
interface User {
  id: number;
  name: string;
}

// 初始化数据库对象
const sql = new Sql();

// 返回云函数实例
export default new Func({
  plugins: [sql], // 插件管理，FaasJS 将自动管理插件的生命周期
  async handler(){ // 业务代码
    const users = knex<User>({
        client: sql.adapterType
      }) // 告诉 Knex 返回的数据类型和数据库的类型
      .from('users') // 告诉 Knex 表名
      .connection(sql.adapter!.pool); // 复用 sql 插件自动维护的数据库连接
    
    return await users.where({ id: 1 }); // Knex 形式的数据库查询
  }
});

上面的代码中有两个要点：

Knex 支持使用 TypeScript 的 interface 作为返回数据类型
sql 插件需要把连接池注入到 Knex 中以利用云函数的生命周期来管理连接

按上面的写法，云函数本身的业务代码是没问题了，但 Knex 还支持建表之类的操作，对于自动化测试是非常有用的，所以我们再深入看一下自动化测试脚本怎么写更好：

// __tests__/user.test.ts
import { FuncWarpper } from '@faasjs/test'; // FaasJS 对云函数的测试用封装
import { Sql } from '@faasjs/sql'; // 引入 Sql 插件
import knex from 'knex'; // 引入 knex 插件

// FaasJS 使用 Jest 作为测试框架
describe('user', function () {
  let func: FuncWarpper;

  beforeEach(async function () {
    // 生成云函数
    func = new FuncWarpper(require.resolve('../user.func') as string);
    
    // 为了便于测试脚本中对数据库各种操作，我们把 sql 插件实例放个快捷方式在 func 对象上
    func.sql = func.plugins[0] as Sql;
    
    // 由于数据库连接是在 mount 阶段生成的，因此这里先 mount 一下
    await func.mountedHandler();
    
    // 建表
    await knex({
      client: func.sql.adapterType
    })
      .schema
      .connection(func.sql.adapter!.pool)
      .dropTableIfExists('users')
      .createTable('users', function (t) {
        t.integer('id').notNullable();
        t.string('name').notNullable();
      });
  });

  test('should work', async function () {
    // 插入假数据
    await knex({
        client: func.sql.adapterType
      })
      .from('users')
      .connection(func.sql.adapter!.pool)
      .insert({
        id: 1,
        name: 'hi'
      });
    
    // 调用云函数
    const res = await func.handler();
    
    // 检查返回结果是否符合预期
    expect(res.length).toEqual(1);
    expect(res[0].id).toEqual(1);
    expect(res[0].name).toEqual('hi');
  });
 });

这里留一个小问题：当多个云函数都需要调用这个数据表时，如何封装比较好呢？（答案见后文）。

适时分库，降低耦合

随着业务增长，必然会遇到数据种类和数量越来越多的情况，如果大量的云函数都连接到一个数据库，必然会对该数据库造成较大的压力，所以建议在开发到一定程度时，提前进行分库操作，对数据和代码进行解耦。

FaasJS 的文件夹结构天然支持分库，假设我们把 users 表和 orders 分拆为两个数据库，则只需将它们分别放在两个不同的文件夹里，每个文件夹里独自配置各自的 faas.yaml 即可。

我在 Github 上的示例代码包括了以下最佳实践示例：

基于 Knex 和 TypeScript 定义共用数据表
基于文件夹来分库分业务

点击链接前往： https://github.com/faasjs/examples/tree/master/knex

最后，在使用中遇到任何问题，欢迎关注微信公众号（寂静小站）反馈交流或加入 QQ 群（772109193）一起讨论交流：