首页  >  文章  >  web前端  >  如何在 TypeScript 中编写事务数据库调用

如何在 TypeScript 中编写事务数据库调用

DDD
DDD原创
2024-11-06 19:25:03959浏览

How To Write Transactional Database Calls in TypeScript

如果您编写 Web 服务,您很可能会与数据库进行交互。有时,您需要进行必须以原子方式应用的更改 - 要么全部成功,要么全部失败。这就是事务的用武之地。在本文中,我将向您展示如何在代码中实现事务,以避免抽象泄漏问题。

例子

一个常见的例子是处理付款:

  • 您需要获取用户的余额并检查是否足够。
  • 然后,您更新余额并保存。

结构

通常,您的应用程序将有两个模块来将业务逻辑与数据库相关代码分开。

存储库模块

该模块处理所有与数据库相关的操作,例如 SQL 查询。下面,我们定义两个函数:

  • 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);
  }
}

在 bill_customer 函数中,我们首先使用 get_balance 检索用户的余额。然后,我们检查余额是否足够并使用 set_balance 更新它。

交易

上述代码的问题在于,在获取和更新时间之间的余额可能会发生变化。为了避免这种情况,我们需要使用交易。您可以通过两种方式处理这个问题:

  • 在存储库模块中嵌入业务逻辑:这种方法将业务规则与数据库操作耦合在一起,使测试变得更加困难。
  • 在服务模块中使用事务:这可能会导致抽象泄漏,因为服务模块需要显式管理数据库会话。

相反,我建议采用更干净的方法。

交易代码

处理事务的一个好方法是创建一个在事务中包装回调的函数。此函数提供了一个会话对象,该对象不会暴露不必要的内部细节,从而防止泄漏抽象。会话对象被传递给事务中所有与数据库相关的函数。

实现方法如下:

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}
    `;
  }
}

在 bill_customer_transactional 函数中,我们调用 run_in_session 并以会话对象作为参数传递回调,然后将此参数传递给我们调用的存储库的每个函数。这可确保 get_balance 和 set_balance 在同一事务中运行。如果两次调用之间的余额发生变化,交易将失败,从而保持数据完整性。

结论

使用事务有效地确保您的数据库操作保持一致,尤其是在涉及多个步骤时。我概述的方法可以帮助您在不泄漏抽象的情况下管理事务,从而使您的代码更易于维护。尝试在您的下一个项目中实现此模式,以保持逻辑清晰和数据安全!


感谢您的阅读!

?喜欢这篇文章别忘了点赞吗?

联系方式
如果您喜欢这篇文章,请随时在 LinkedIn 上联系并在 Twitter 上关注我。

订阅我的邮件列表:https://sergedevs.com

一定要喜欢并关注吗?

以上是如何在 TypeScript 中编写事务数据库调用的详细内容。更多信息请关注PHP中文网其他相关文章!

声明:
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn