Kisley Kanel: 완벽한 듀오

저는 첫 프로젝트(OT 포켓몬과 Habbo의 첫 웹사이트)를 개발하기 시작한 이래로 항상 Raw SQL을 선택해 온 사람입니다. 솔직히 말해서, 나는 여전히 나만의 쿼리를 작성하고 이 "낮은 수준" 레이어를 보다 정확하게 제어하는 ​​것을 정말 좋아합니다. 비효율적인 쿼리를 식별하고 최적화하기 위해 로그를 분석하는 데 이미 며칠을 보냈기 때문에 ORM은 나를 완전히 편안하게 만들지 않습니다.

그러나 제가 Raw SQL로 작업한 많은 코드베이스에서는 대다수가 마이그레이션 제어 기능이 없었고 데이터베이스도 모니터링되지 않았습니다. 모든 것이 즉흥적으로 진행되었습니다. "새 필드가 필요합니까? ALTER TABLE을 실행하고 새 열을 추가하세요." 이 접근 방식은 모든 시나리오에서 매우 해로웠으며 "프로덕션 환경에서 어떤 열로 이동해야 합니까?", "어떤 새 엔터티가 생성되었습니까?", "환경이 동기화됩니까?"와 같은 몇 가지 질문이 생겼습니다. — 그리고 기타 유사한 문제가 많이 있습니다.

내 문제에 대한 해결책

이 모든 문제에 직면한 저는 나와 함께 일하는 팀의 일상을 더 건강하게 만들기 위해 새로운 도구를 채택하기로 결정했습니다. 제가 갖고 있는 유연성을 포기하고 싶지 않았지만, 애플리케이션의 자유도를 더 잘 제어하고 싶었습니다. 많은 연구 끝에 저는 이러한 문제를 해결하는 데 가장 완벽하다고 생각되는 도구를 찾았습니다. Kysely는 실용적일 뿐만 아니라 완전히 유형에 안전한 TypeScript용 쿼리 빌더입니다. 나에게는 매우 중요한 포인트입니다. 이 lib가 너무 많은 관심을 끌었기 때문에 Kysely와 통합된 다른 오픈 소스 라이브러리용 플러그인을 만드는 등 직간접적으로 커뮤니티에 적극적으로 기여하기 시작했습니다.

그러나 Kysely로 작업할 때 가장 큰 어려움 중 하나는 ORM과 달리 엔터티가 없거나 유형/인터페이스의 자동 생성이 없다는 것입니다. 이 모든 작업은 수동으로 수행해야 하므로 약간 피곤할 수 있습니다. 솔루션을 검색하는 동안 PostgreSQL과 관련된 모든 프로젝트에서 채택하게 된 도구인 Kanel을 발견했습니다. Kanel은 자동으로 데이터베이스 유형을 생성하여 Kysely를 완벽하게 보완합니다.

또한 Kanel에는 Kysely와 함께 직접 사용할 수 있는 추가 기능이 있습니다: Kanel-Kysely. 저는 이 저장소에 적극적으로 기여하여 마이그레이션 테이블용 유형 필터, Zod 객체를 camelCase로 변환하는 등의 새로운 기능 개발을 도왔습니다.

Kysely 구성

다음 예를 설명하기 위해 NestJS를 사용하겠습니다. 따라서 코드의 일부 구문이나 내용을 이해하지 못하는 경우 NestJS 설명서를 읽는 것이 좋습니다. 제 생각에는 이것이 최고의 JavaScript 프레임워크입니다. 특히 JavaScript를 "탈출"하려는 경우에는 더욱 그렇습니다. 하지만 그것은 내 다른 게시물의 주제입니다.

예제를 그대로 따르려면 사전에 NestJS가 초기화된 저장소가 있어야 합니다. 그러나 자신만의 코드를 개발할 수도 있습니다.

먼저 Kysely 자체와 CLI, Node.js용 PostgreSQL 모듈을 설치해야 합니다.

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

다음으로 Kysely 프로젝트 루트에 구성 파일을 생성해야 합니다. 마이그레이션 및 시드 파일에도 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,
  },
});

다음으로 터미널에서 npx kysely migration make create_user_table 명령을 실행하겠습니다. 첫 번째 마이그레이션 생성을 담당합니다. 다음으로, 새로운 사용자 테이블을 생성하고 완료되면 npx kysely migration late 명령을 사용하여 데이터베이스에서 이 마이그레이션을 실행합니다.

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

이 모든 단계가 완료되었으면 데이터베이스용 모듈을 만들어 보겠습니다. 또한 Kysely 플러그인을 사용하여 열을 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 {}

카넬 구성

종속성 설치부터 시작하겠습니다.

npm i kanel kanel-kysely --save-dev

다음으로 Kanel이 작업을 시작할 수 있도록 구성 파일을 만들어 보겠습니다. 나는 camelCaseHook(인터페이스를 camelCase로 변환하기 위해) 및 kyselyTypeFilter(Kysely의 마이그레이션 테이블을 제외하기 위해)와 같은 일부 플러그인을 사용할 것입니다. 이러한 기능 중 하나는 제가 기여하고 우리가 했던 작업을 만들 수 있어서 기뻤습니다. 더 쉬워요.

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

파일이 생성되면 터미널에서 npx kanel 명령을 실행합니다. 구성 파일에 지정된 경로에 디렉터리가 생성되었습니다. 이 디렉터리는 스키마 이름에 해당하며, 이 경우에는 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가 이해할 수 있도록 이 파일을 전달할 것이기 때문입니다. 우리 데이터베이스의 전체 구조. app.service.ts 파일 안에 DatabaseModule 공급자를 삽입하고 Database.
유형을 Kysely에 전달합니다.

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

Kanel이 생성한 입력이 올바르게 작동하는지 확인하세요. 코드 편집기가 첫 번째 마이그레이션에서 생성한 열을 정확하게 제안하기 때문입니다.

최종 고려사항

개인 프로젝트는 물론 직장에서도(자유가 있을 때) 정말 사용하고 싶은 듀오입니다. 쿼리 빌더는 원시 SQL이 제공하는 유연성을 좋아하지만 "더 안전한" 경로를 선택하는 모든 사람을 위한 필수 도구입니다. Kanel 덕분에 디버깅하고 새로운 타이핑을 작성하는 데 많은 시간을 절약할 수 있었습니다. 이 두 가지로 프로젝트를 만들어 보시는 것을 강력히 추천드리며, 절대 후회하지 않으실 겁니다.

저장소 링크: Frankenstein-nodejs

위 내용은 Kisley Kanel: 완벽한 듀오의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!