编写数据库支持

TIP

Koishi v3 已经进入 LTS 阶段，这意味着它不会有最新的功能与支持。如果你对编写数据库支持感兴趣，推荐向 Koishi v4open in new window 提供数据库支持。

最后，让我们介绍一下如何编写一个数据库支持。由于数据库支持往往要被其他插件或用户所使用，有一个好的类型标注是非常重要的。因此这里我们就只提供 TypeScript 的范例了。

与上面介绍的方法类似，我们也采用注入的方式，不过这次我们需要先实现一个类。我们用 mysql 来举个最小的支持范例：

import { createPool, Pool, PoolConfig } from 'mysql'
import { Database } from 'koishi-core'

// 类型注入
declare module 'koishi-core' {
  namespace Database {
    interface Statics {
      // 别忘了加 typeof，不然就不对了
      'koishi-plugin-mysql': typeof MysqlDatabase
    }
  }
}

// 防止下面产生类型报错
interface MysqlDatabase extends Database {}

class MysqlDatabase {
  private pool: Pool

  constructor(config: PoolConfig = {}) {
    this.pool = createPool(config)
  }

  query(sql: string, values?: any): Promise<any> {
    return new Promise((resolve, reject) => {
      this.pool.query(sql, values, (error, results, fields) => {
        if (error) {
          reject(error)
        } else {
          resolve(results)
        }
      })
    })
  }
}

// Database.extend 方法也可以直接传入一个数据库类
Database.extend(MysqlDatabase, {
  // 提供内置方法的实现（参见“使用数据库”一节中的“扩展数据库方法”）
})

export default MysqlDatabase

export const name = 'mysql'

export function apply(ctx: Context, config: PoolConfig = {}) {
  const db = new MysqlDatabase(ctx.app, config)
  ctx.database = db
}

当然，真正的 koishi-plugin-mysql 要比上面的例子复杂得多，我们还需要处理有关数据库的更多细节：

数据库的生命周期
更多的 ORM 类型
更多的标准方法
与 ORM API 之间的对接

等等。

你可以在这里open in new window 看到完整的源代码。

# 编写数据库支持

编写数据库支持