自從我開始開發(fā)我的第一個項目（我的 OT Pokémon 和 Habbo 的第一個網(wǎng)站）以來，我一直選擇 Raw SQL。老實(shí)說，我仍然非常喜歡編寫自己的查詢并更精確地控制這個“低級”層。 ORM 并不讓我完全放心，因為我已經(jīng)花了幾天時間分析日志來識別和優(yōu)化低效查詢。

但是，在我使用 Raw SQL 的許多代碼庫中，絕大多數(shù)沒有遷移控制，并且數(shù)據(jù)庫也沒有受到監(jiān)控。一切都在即興創(chuàng)作的基礎(chǔ)上進(jìn)行：“您需要一個新字段嗎？運(yùn)行 ALTER TABLE 并添加一個新列?！边@種方法在所有場景下都是極其有害的，出現(xiàn)了幾個問題，例如：“我們應(yīng)該在生產(chǎn)環(huán)境中上哪些列？”，“創(chuàng)建了哪些新實(shí)體？”，“環(huán)境是否同步？” - 以及許多其他類似的問題。

我的問題的解決方案

面對所有這些問題，我決定采用新的工具來讓我和與我一起工作的團(tuán)隊的日常工作變得更健康。我不想放棄我所擁有的靈活性，但我也想更好地控制應(yīng)用程序的自由度。經(jīng)過大量研究，我發(fā)現(xiàn)了一個我認(rèn)為最完整的解決這些問題的工具：Kysely，它是 TypeScript 的查詢構(gòu)建器，除了實(shí)用之外，還是完全類型安全的 —對我來說非常重要的一點(diǎn)。這個庫引起了我的注意，以至于我開始直接和間接地積極為社區(qū)做出貢獻(xiàn)，為與 Kysely 集成的其他開源庫創(chuàng)建插件。

然而，使用 Kysely 時最大的困難之一是，與 ORM 不同，它沒有實(shí)體或自動生成類型/接口。所有這些工作都需要手動完成，這可能有點(diǎn)累人。在研究解決方案的過程中，我發(fā)現(xiàn)了一個最終在涉及 PostgreSQL 的所有項目中采用的工具：Kanel。 Kanel 自動生成數(shù)據(jù)庫類型，完美補(bǔ)充了 Kysely。

此外，Kanel 還有一個可以直接與 Kysely 一起使用的附加功能：Kanel-Kysely。我一直在積極為這個存儲庫做出貢獻(xiàn)，幫助開發(fā)新功能，例如遷移表的類型過濾器以及 Zod 對象到駝峰命名法的轉(zhuǎn)換。

配置 Kysely

我將使用 NestJS 來說明以下示例。因此，如果您不理解某些語法或代碼中的某些內(nèi)容，我建議您閱讀 NestJS 文檔。在我看來，它是最好的 JavaScript 框架——特別是如果你想“逃避”JavaScript。但這是我另一篇文章的主題。

如果您想嚴(yán)格遵循示例，您需要先初始化一個帶有 NestJS 的存儲庫。不過，您也可以開發(fā)自己的代碼。

首先，我們需要安裝 Kysely 本身、它的 CLI 和 Node.js 的 PostgreSQL 模塊。

npm i kysely pg && npm i kysely-ctl --save-dev

接下來，我們需要在項目的根目錄中為 Kysely 創(chuàng)建一個配置文件。我還將為我們的遷移和種子文件使用 Knex 前綴。

// kysely.config.ts

import "dotenv/config";

import { defineConfig, getKnexTimestampPrefix } from "kysely-ctl";
import { Pool } from "pg";

export default defineConfig({
  dialect: "pg",
  dialectConfig: {
    pool: new Pool({ connectionString: process.env.DATABASE_URL }),
  },
  migrations: {
    migrationFolder: "src/database/migrations",
    getMigrationPrefix: getKnexTimestampPrefix,
  },
  seeds: {
    seedFolder: "src/database/seeds",
    getSeedPrefix: getKnexTimestampPrefix,
  },
});

接下來，我們將在終端中運(yùn)行命令 npx kysely migrate make create_user_table。它將負(fù)責(zé)創(chuàng)建我們的第一個遷移。接下來，我們將創(chuàng)建一個新的用戶表，完成后，我們將使用命令 npx kysely migratelatest.
在數(shù)據(jù)庫中運(yùn)行此遷移

// 20241225222128_create_user_table.ts

import { sql, type Kysely } from 'kysely'


export async function up(db: Kysely<any>): Promise<void> {
  await db.schema
  .createTable("user")
  .addColumn("id", "serial", (col) => col.primaryKey())
  .addColumn("name", "text", (col) => col.notNull())
  .addColumn("email", "text", (col) => col.unique().notNull())
  .addColumn("password", "text", (col) => col.notNull())
  .addColumn("created_at", "timestamp", (col) =>
    col.defaultTo(sql`now()`).notNull(),
  )
  .execute();
}

export async function down(db: Kysely<any>): Promise<void> {
  await db.schema.dropTable("user").execute();
}

完成所有這些步驟后，讓我們?yōu)槲覀兊臄?shù)據(jù)庫創(chuàng)建一個模塊。另請注意，我正在使用 Kysely 插件將我們的列轉(zhuǎn)換為駝峰命名法。

// src/database/database.module.ts

import { EnvService } from "@/env/env.service";
import { Global, Logger, Module } from "@nestjs/common";
import { CamelCasePlugin, Kysely, PostgresDialect } from "kysely";
import { Pool } from "pg";

export const DATABASE_CONNECTION = "DATABASE_CONNECTION";

@Global()
@Module({
  providers: [
    {
      provide: DATABASE_CONNECTION,
      useFactory: async (envService: EnvService) => {
        const dialect = new PostgresDialect({
          pool: new Pool({
            connectionString: envService.get("DATABASE_URL"),
          }),
        });

        const nodeEnv = envService.get("NODE_ENV");

        const db = new Kysely({
          dialect,
          plugins: [new CamelCasePlugin()],
          log: nodeEnv === "dev" ? ["query", "error"] : ["error"],
        });

        const logger = new Logger("DatabaseModule");

        logger.log("Successfully connected to database");

        return db;
      },
      inject: [EnvService],
    },
  ],
  exports: [DATABASE_CONNECTION],
})
export class DatabaseModule {}

配置 Kanel

讓我們從安裝依賴項開始。

npm i kanel kanel-kysely --save-dev

接下來，讓我們?yōu)?Kanel 創(chuàng)建配置文件以開始工作。請注意，我將使用一些插件，例如camelCaseHook（將我們的接口轉(zhuǎn)換為camelCase）和kyselyTypeFilter（以排除Kysely的遷移表），我很高興能夠貢獻(xiàn)這些功能之一，并使我們的工作甚至更容易。

// .kanelrc.js

require("dotenv/config");

const { kyselyCamelCaseHook, makeKyselyHook, kyselyTypeFilter } = require("kanel-kysely");

/** @type {import('kanel').Config} */
module.exports = {
  connection: {
    connectionString: process.env.DATABASE_URL,
  },
  typeFilter: kyselyTypeFilter,
  preDeleteOutputFolder: true,
  outputPath: "./src/database/schema",
  preRenderHooks: [makeKyselyHook(), kyselyCamelCaseHook],
};

創(chuàng)建文件后，我們將在終端中運(yùn)行命令 npx kanel。請注意，在配置文件中指定的路徑中創(chuàng)建了一個目錄。此目錄對應(yīng)于您的架構(gòu)的名稱，在我們的示例中為 Public，其中我們有兩個新文件：PublicSchema.ts 和 User.ts 。您的 User.ts 可能看起來完全像這樣：

// @generated
// This file is automatically generated by Kanel. Do not modify manually.

import type { ColumnType, Selectable, Insertable, Updateable } from 'kysely';

/** Identifier type for public.user */
export type UserId = number & { __brand: 'UserId' };

/** Represents the table public.user */
export default interface UserTable {
  id: ColumnType<UserId, UserId | undefined, UserId>;

  name: ColumnType<string, string, string>;

  email: ColumnType<string, string, string>;

  password: ColumnType<string, string, string>;

  createdAt: ColumnType<Date, Date | string | undefined, Date | string>;
}

export type User = Selectable<UserTable>;

export type NewUser = Insertable<UserTable>;

export type UserUpdate = Updateable<UserTable>;

不過，最重要的是這個目錄之外的文件Public，文件Database.ts，因為我們要傳遞的正是這個，以便Kysely能夠理解我們數(shù)據(jù)庫的整個結(jié)構(gòu)。在我們的文件 app.service.ts 中，我們將注入 DatabaseModule 提供程序并將我們的類型 Database.
傳遞給 Kysely

npm i kysely pg && npm i kysely-ctl --save-dev

請注意，Kanel 生成的類型工作正常，因為我們的代碼編輯器將準(zhǔn)確建議我們在第一次遷移中創(chuàng)建的列。

最后的考慮因素

這是我非常喜歡在我的個人項目甚至工作中使用的組合（當(dāng)我有自由這樣做時）。對于喜歡原始 SQL 提供的靈活性但也選擇“更安全”路徑的每個人來說，查詢生成器都是必不可少的工具。 Kanel 還為我節(jié)省了許多時間的調(diào)試和創(chuàng)建新類型的時間。我強(qiáng)烈建議你用這兩個創(chuàng)建一個項目，你絕對不會后悔的。

存儲庫鏈接： Frankenstein-nodejs

以上是基斯利·卡內(nèi)爾 (Kisley Kanel)：完美二人組的詳細(xì)內(nèi)容。更多信息請關(guān)注PHP中文網(wǎng)其他相關(guān)文章！