Kisley Kanel: pasangan yang sempurna

Saya seorang yang, sejak saya mula membangunkan projek pertama saya (Pokemon OT saya dan tapak web pertama saya untuk Habbo), saya sentiasa memilih SQL Mentah. Secara jujur, saya masih sangat seronok menulis pertanyaan saya sendiri dan mempunyai kawalan yang lebih tepat ke atas lapisan "tahap rendah" ini. ORM tidak membuatkan saya selesa sepenuhnya, kerana saya telah menghabiskan masa berhari-hari menganalisis log untuk mengenal pasti dan mengoptimumkan pertanyaan yang tidak cekap.

Walau bagaimanapun, dalam banyak pangkalan kod tempat saya bekerja dengan Raw SQL, sebahagian besarnya tidak mempunyai kawalan penghijrahan dan pangkalan data juga tidak dipantau. Semuanya berfungsi secara improvisasi: "Adakah anda memerlukan medan baharu? Jalankan ALTER JADUAL dan tambah lajur baharu." Pendekatan ini sangat berbahaya dalam semua senario, beberapa soalan timbul, seperti: "Lajur yang manakah harus kita naikkan dalam persekitaran pengeluaran?", "Apakah entiti baharu yang dicipta?", "Adakah persekitaran disegerakkan?" — dan banyak lagi masalah serupa.

Penyelesaian kepada masalah saya

Menghadapi semua masalah ini, saya memutuskan untuk menggunakan alat baharu untuk menjadikan rutin saya dan pasukan yang bekerja dengan saya lebih sihat. Saya tidak mahu melepaskan fleksibiliti yang saya ada, tetapi saya juga mahu mengawal darjah kebebasan aplikasi dengan lebih baik. Selepas banyak penyelidikan, saya menemui alat yang saya anggap paling lengkap untuk menyelesaikan masalah ini: Kysely, ia adalah pembina pertanyaan untuk TypeScript yang, sebagai tambahan kepada praktikal, selamat jenis sepenuhnya — satu perkara yang sangat penting bagi saya. Lib ini menarik perhatian saya sehingga saya mula menyumbang secara aktif kepada komuniti, secara langsung dan tidak langsung, mencipta pemalam untuk perpustakaan sumber terbuka lain yang disepadukan dengan Kysely.

Namun, salah satu kesukaran terbesar apabila bekerja dengan Kysely ialah, tidak seperti ORM, ia tidak mempunyai entiti atau penjanaan jenis/antara muka automatik. Semua kerja ini perlu dilakukan secara manual, yang boleh menjadi agak meletihkan. Semasa penyelidikan saya untuk penyelesaian, saya menemui alat yang akhirnya saya pakai dalam semua projek saya yang melibatkan PostgreSQL: Kanel. Kanel menjana penaipan pangkalan data secara automatik, melengkapkan Kysely dengan sempurna.

Selain itu, Kanel mempunyai ciri tambahan untuk kegunaan langsung dengan Kysely: Kanel-Kysely. Saya telah menyumbang secara aktif kepada repositori ini, membantu membangunkan ciri baharu, seperti penapis jenis untuk jadual migrasi dan penukaran objek Zod kepada camelCase.

Mengkonfigurasi Kysely

Saya akan menggunakan NestJS untuk menggambarkan contoh berikut. Jadi, jika anda tidak memahami beberapa sintaks atau sesuatu dalam kod, saya cadangkan membaca dokumentasi NestJS. Pada pendapat saya, ia adalah rangka kerja JavaScript terbaik — terutamanya jika anda ingin "melarikan diri" JavaScript. Tetapi itu topik untuk catatan saya yang lain.

Sebelumnya, anda perlu mempunyai repositori dengan NestJS yang dimulakan, jika anda ingin mengikuti contoh kepada surat itu. Walau bagaimanapun, anda juga boleh membangunkan kod anda sendiri.

Pada mulanya, kita perlu memasang Kysely itu sendiri, CLI dan modul PostgreSQL untuk Node.js.

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

Seterusnya, kita perlu mencipta fail konfigurasi dalam akar projek untuk Kysely. Saya juga akan menggunakan awalan Knex untuk migrasi dan fail benih kami.

// 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,
  },
});

Seterusnya, kami akan menjalankan arahan npx kysely migrate make create_user_table dalam terminal kami. Ia akan bertanggungjawab untuk mencipta penghijrahan pertama kami. Seterusnya, kami akan mencipta jadual pengguna baharu dan, setelah selesai, kami akan menjalankan migrasi ini dalam pangkalan data kami dengan arahan npx kysely migrate latest.

// 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();
}
</void></any></void></any>

Dengan semua langkah ini selesai, mari buat modul untuk pangkalan data kami. Juga perhatikan bahawa saya menggunakan pemalam Kysely untuk menukar lajur kami kepada camelCase.

// 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 {}

Mengkonfigurasi Kanel

Mari kita mulakan dengan memasang kebergantungan kita.

npm i kanel kanel-kysely --save-dev

Seterusnya, mari buat fail konfigurasi kami untuk Kanel mula melakukan kerjanya. Ambil perhatian bahawa saya akan menggunakan beberapa pemalam, seperti camelCaseHook (untuk mengubah antara muka kami menjadi camelCase) dan kyselyTypeFilter (untuk mengecualikan jadual penghijrahan Kysely), salah satu daripada ciri ini saya berbesar hati kerana dapat menyumbang dan membuat kerja yang kami ada. lebih mudah .

// .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],
};

Setelah fail dibuat, kami akan menjalankan arahan npx kanel di terminal kami. Ambil perhatian bahawa direktori telah dibuat dalam laluan yang ditentukan dalam fail konfigurasi. Direktori ini sepadan dengan nama skema anda, dalam kes kami, Awam, dan di dalamnya kami mempunyai dua fail baharu: PublicSchema.ts dan User.ts . User.ts anda mungkin akan kelihatan seperti ini:

// @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>;

  name: ColumnType<string string>;

  email: ColumnType<string string>;

  password: ColumnType<string string>;

  createdAt: ColumnType<date date string undefined>;
}

export type User = Selectable<usertable>;

export type NewUser = Insertable<usertable>;

export type UserUpdate = Updateable<usertable>;

</usertable></usertable></usertable></date></string></string></string></userid>

Namun, perkara yang paling penting ialah fail di luar direktori ini Awam, fail Pangkalan Data.ts, kerana ini yang akan kami sampaikan supaya Kysely dapat memahami keseluruhan struktur pangkalan data kami. Di dalam fail app.service.ts kami, kami akan menyuntik penyedia DatabaseModule kami dan menyerahkan jenis Pangkalan Data kami.
kepada Kysely

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

Perhatikan bahawa penaipan yang dijana Kanel berfungsi dengan betul, kerana editor kod kami akan mencadangkan dengan tepat lajur yang kami buat dalam penghijrahan pertama kami.

Pertimbangan akhir

Ini adalah duo yang saya sangat suka gunakan dalam projek peribadi saya dan juga di tempat kerja (apabila saya mempunyai kebebasan untuk berbuat demikian). Pembina pertanyaan ialah alat penting untuk semua orang yang menyukai fleksibiliti yang ditawarkan oleh Raw SQL, tetapi juga memilih laluan "lebih selamat". Kanel juga telah menjimatkan banyak jam menyahpepijat dan mencipta penaipan baharu. Saya amat mengesyorkan anda membuat projek dengan kedua-dua ini, anda pasti tidak akan menyesal.

Pautan Repositori: frankenstein-nodejs

Atas ialah kandungan terperinci Kisley Kanel: pasangan yang sempurna. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!