TypeScript でトランザクション データベース呼び出しを記述する方法

Web サービスを作成する場合、データベースを操作する可能性があります。場合によっては、アトミックに適用する必要がある変更を加える必要があります。すべてが成功するか、どれも成功しないかのどちらかです。ここでトランザクションが登場します。この記事では、漏れやすい抽象化の問題を回避するために、コードにトランザクションを実装する方法を説明します。

例

一般的な例は支払いの処理です:

• ユーザーの残高を取得して、それが十分であるかどうかを確認する必要があります。
• 次に、残高を更新して保存します。

構造

通常、アプリケーションにはビジネス ロジックをデータベース関連のコードから分離するために 2 つのモジュールがあります。

リポジトリモジュール

このモジュールは、SQL クエリなどのデータベース関連のすべての操作を処理します。以下では、2 つの関数を定義します:

• get_balance — データベースからユーザーの残高を取得します。
• set_balance — ユーザーの残高を更新します。

import { Injectable } from '@nestjs/common';
import postgres from 'postgres';

@Injectable()
export class BillingRepository {
  constructor(
    private readonly db_connection: postgres.Sql,
  ) {}

  async get_balance(customer_id: string): Promise<number | null> {
    const rows = await this.db_connection`
      SELECT amount FROM balances
      WHERE customer_id=${customer_id}
    `;
    return (rows[0]?.amount) ?? null;
  }

  async set_balance(customer_id: string, amount: number): Promise<void> {
    await this.db_connection`
      UPDATE balances
      SET amount=${amount}
      WHERE customer_id=${customer_id}
    `;
  }
}

サービスモジュール

サービス モジュールには、残高の取得、検証、更新された残高の保存などのビジネス ロジックが含まれています。

import { Injectable } from '@nestjs/common';
import { BillingRepository } from 'src/billing/billing.repository';

@Injectable()
export class BillingService {
  constructor(
    private readonly billing_repository: BillingRepository,
  ) {}

  async bill_customer(customer_id: string, amount: number) {
    const balance = await this.billing_repository.get_balance(customer_id);

    // The balance may change between the time of this check and the update.
    if (balance === null || balance < amount) {
      return new Error('Insufficient funds');
    }

    await this.billing_repository.set_balance(customer_id, balance - amount);
  }
}

bil_customer 関数では、まず get_balance を使用してユーザーの残高を取得します。次に、残高が十分であるかどうかを確認し、set_balance で更新します。

トランザクション

上記のコードの問題は、コードがフェッチされてから更新されるまでの間にバランスが変化する可能性があることです。これを回避するには、トランザクションを使用する必要があります。これは 2 つの方法で処理できます:

• リポジトリ モジュールにビジネス ロジックを埋め込む: このアプローチでは、ビジネス ルールとデータベース操作が結合され、テストが難しくなります。
• サービス モジュールでトランザクションを使用する: サービス モジュールはデータベース セッションを明示的に管理する必要があるため、抽象化に漏れが生じる可能性があります。

代わりに、よりクリーンなアプローチをお勧めします。

トランザクションコード

トランザクションを処理する良い方法は、トランザクション内でコールバックをラップする関数を作成することです。この関数は、不必要な内部詳細を公開しないセッション オブジェクトを提供し、抽象化の漏れを防ぎます。セッション オブジェクトは、トランザクション内のすべてのデータベース関連関数に渡されます。

実装方法は次のとおりです:

import { Injectable } from '@nestjs/common';
import postgres, { TransactionSql } from 'postgres';

export type SessionObject = TransactionSql<Record<string, unknown>>;

@Injectable()
export class BillingRepository {
  constructor(
    private readonly db_connection: postgres.Sql,
  ) {}

  async run_in_session<T>(cb: (sql: SessionObject) => T | Promise<T>) {
    return await this.db_connection.begin((session) => cb(session));
  }

  async get_balance(
    customer_id: string,
    session: postgres.TransactionSql | postgres.Sql = this.db_connection
  ): Promise<number | null> {
    const rows = await session`
      SELECT amount FROM balances
      WHERE customer_id=${customer_id}
    `;
    return (rows[0]?.amount) ?? null;
  }

  async set_balance(
    customer_id: string,
    amount: number,
    session: postgres.TransactionSql | postgres.Sql = this.db_connection
  ): Promise<void> {
    await session`
      UPDATE balances
      SET amount=${amount}
      WHERE customer_id=${customer_id}
    `;
  }
}

この例では、run_in_session 関数がトランザクションを開始し、その中でコールバックを実行します。 SessionObject 型はデータベース セッションを抽象化し、内部詳細の漏洩を防ぎます。すべてのデータベース関連関数がセッション オブジェクトを受け入れるようになり、同じトランザクションに確実に参加できるようになりました。

更新されたサービスモジュール

トランザクションを活用するためにサービス モジュールが更新されました。これは次のようになります:

import { Injectable } from '@nestjs/common';
import postgres from 'postgres';

@Injectable()
export class BillingRepository {
  constructor(
    private readonly db_connection: postgres.Sql,
  ) {}

  async get_balance(customer_id: string): Promise<number | null> {
    const rows = await this.db_connection`
      SELECT amount FROM balances
      WHERE customer_id=${customer_id}
    `;
    return (rows[0]?.amount) ?? null;
  }

  async set_balance(customer_id: string, amount: number): Promise<void> {
    await this.db_connection`
      UPDATE balances
      SET amount=${amount}
      WHERE customer_id=${customer_id}
    `;
  }
}

bil_customer_transactional 関数では、run_in_session を呼び出し、パラメータとしてセッション オブジェクトを使用してコールバックを渡し、このパラメータを呼び出すリポジトリのすべての関数に渡します。これにより、get_balance と set_balance の両方が同じトランザクション内で実行されるようになります。 2 つの呼び出しの間で残高が変化すると、トランザクションは失敗し、データの整合性が維持されます。

結論

トランザクションを効果的に使用すると、特に複数のステップが関係する場合に、データベース操作の一貫性が保たれます。ここで概説したアプローチは、抽象化を漏らすことなくトランザクションを管理するのに役立ち、コードの保守性が向上します。ロジックをクリーンに保ち、データを安全に保つために、次のプロジェクトにこのパターンを実装してみてください!

---

読んでいただきありがとうございます!

?記事が気に入ったら「いいね」を忘れないでください?

連絡先
この記事が気に入ったら、遠慮せずに LinkedIn でつながり、Twitter で私をフォローしてください。

私のメーリングリストに登録してください: https://sergedevs.com

ぜひ「いいね！」してフォローしてください?

以上がTypeScript でトランザクション データベース呼び出しを記述する方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。