NestJS 中使用 TypeORM 事务的实践与对比

25 年 08 月 02日星期六 (已编辑)

作者：Cling.

Service# Nest.js 、小罗随笔

这篇文章最后修改于 2025年 08月 02日 11时35分部分内容可能已不适用如有疑问请联系作者.

NestJS 中使用 TypeORM 事务的实践与对比

在实际业务开发中，尤其是涉及到资金转账、库存修改等需要数据一致性的场景，事务是我们保障系统稳定性的重要手段。本文将通过一个账户余额转账的例子，来讲解 NestJS + TypeORM 中事务的使用方式，并与非事务的处理方式进行对比。

🧱 示例实体：账户表

我们先定义一个简单的实体类，用于表示账户信息：

ts 复制代码

import { Entity, Column, PrimaryGeneratedColumn } from typeorm;

// 测试事务一致性 - 账户
@Entity('custom_account')
export class CustromEntity {
  @PrimaryGeneratedColumn()
  id: number;

  @Column({ default: 0 })
  balance: number;
}

✅ 使用事务处理转账操作

ts 复制代码

async transfer(fromId: number, toId: number, amount: number): Promise<void> {
  await this.custromRepository.manager.transaction(async (transactionalEntityManager) => {
    const fromAccount = await transactionalEntityManager.findOneByOrFail(CustromEntity, { id: fromId });
    if (fromAccount.balance < amount) {
      throw new Error('Insufficient funds');
    }

    fromAccount.balance -= amount;
    await transactionalEntityManager.save(fromAccount);

    // 模拟中间可能出现的异常
    if (Math.random() > 0.5) {
      throw new Error('Network error occurred');
    }

    const toAccount = await transactionalEntityManager.findOneByOrFail(CustromEntity, { id: toId });
    toAccount.balance += amount;
    await transactionalEntityManager.save(toAccount);
  });
}

说明：

使用 manager.transaction() 执行数据库操作。
所有数据库操作在一个事务中执行，任意一步抛出异常，整个事务会回滚。
保障了“从账户扣钱”与“给账户加钱”这两个操作的原子性。

❌ 不使用事务处理转账操作

ts 复制代码

async unsafeTransfer(fromId: number, toId: number, amount: number): Promise<void> {
  const fromAccount = await this.custromRepository.findOneByOrFail({ id: fromId });
  if (fromAccount.balance < amount) {
    throw new Error('Insufficient funds');
  }

  fromAccount.balance -= amount;
  await this.custromRepository.save(fromAccount);

  // 模拟可能出现的错误
  if (Math.random() > 0.5) {
    throw new Error('Network error occurred');
  }

  const toAccount = await this.custromRepository.findOneByOrFail({ id: toId });
  toAccount.balance += amount;
  await this.custromRepository.save(toAccount);
}

风险点：

如果在两个数据库操作之间发生异常（如网络错误），前半段的数据已经提交，后半段数据未执行。
会导致资金丢失、不一致等严重问题。

📌 小结

场景	是否使用事务	数据一致性	报错回滚
使用事务转账	✅ 是	✅ 一致	✅ 支持
不使用事务转账	❌ 否	❌ 不一致	❌ 不支持

结论：在涉及多步数据库操作时，强烈建议使用事务来保证数据一致性。

💡 事务应用建议

金融类操作、库存管理等核心业务必须使用事务。
尽可能使用数据库层提供的原子操作（如事务、锁等）而非依赖应用层逻辑。
使用 transactionalEntityManager 处理所有涉及的数据表操作，避免直接操作 Repository。

🧩 typeorm-transactional：声明式事务管理方案

📌 简介

typeorm-transactional 是一个基于 CLS（Continuation Local Storage） 的库，它允许你在使用 TypeORM 时，通过装饰器的方式声明事务，并且能够在多个 service 之间自动传播事务上下文。

它的目标是：消除手动传递 EntityManager 的繁琐代码，提升事务处理的可维护性与可读性。

🌟 核心优势

特性	描述
✅ 装饰器支持	使用 `@Transactional()` 装饰器标注方法自动开启事务
✅ 自动事务传播	支持 service 间方法调用，事务上下文自动共享
✅ 兼容 TypeORM	与 NestJS + TypeORM 无缝集成
✅ 支持异步调用	基于 async_hooks 提供异步上下文隔离

📦 安装方式

bash 复制代码

npm install typeorm-transactional-cls-hooked

🚀 使用步骤

1️⃣ 设置 Transactional Context

在 main.ts 中初始化 CLS：

ts 复制代码

import { initializeTransactionalContext } from 'typeorm-transactional-cls-hooked';

async function bootstrap() {
  initializeTransactionalContext(); // 初始化 CLS 上下文
  await app.listen(3000);
}

2️⃣ 装饰需要事务的方法

ts 复制代码

import { Transactional } from 'typeorm-transactional-cls-hooked';

@Injectable()
export class AccountService {
  constructor(private readonly accountRepo: Repository<AccountEntity>) {}

  @Transactional()
  async transfer(fromId: number, toId: number, amount: number) {
    const from = await this.accountRepo.findOneByOrFail({ id: fromId });
    const to = await this.accountRepo.findOneByOrFail({ id: toId });

    from.balance -= amount;
    to.balance += amount;

    await this.accountRepo.save(from);
    await this.accountRepo.save(to);
  }
}

🔁 跨 service 调用也能共享事务

ts 复制代码

@Injectable()
export class LoggerService {
  @Transactional()
  async logTransfer(message: string) {
    // 此操作会复用 AccountService 中开启的事务
    await this.logRepo.save({ message });
  }
}

⚙️ 高级用法：手动使用事务 EntityManager

ts 复制代码

import { getEntityManagerOrTransactionManager } from 'typeorm-transactional-cls-hooked';

const manager = getEntityManagerOrTransactionManager();
await manager.save(...);

⚠️ 注意事项

方法中使用的 repository 必须是通过 @InjectRepository() 注入的。
避免在事务内部使用 Promise.all 并发操作。
暂不支持多数据源共享事务上下文。

✅ 总结

场景	说明
多 Service 嵌套调用	自动共享事务上下文
想简化事务逻辑的维护	使用装饰器声明即可
跨模块、异步方法中保证事务一致性	基于 CLS 持续跟踪

阅读进度： 0 %

返回顶部

文章标题：NestJS 中使用 TypeORM 事务的实践与对比

文章作者：Cling.

文章链接：[复制]

最后修改时间：2025年 08月 02日 11时12分

商业转载请联系站长获得授权，非商业转载请注明本文出处及文章链接，您可以自由地在任何媒体以任何形式复制和分发作品，也可以修改和创作，但是分发衍生作品时必须采用相同的许可协议。本文采用CC BY-NC-SA 4.0进行许可。

豫ICP备2022014268号-1

「每想拥抱你一次，天空飘落一片雪，至此雪花拥抱撒哈拉!」

本站已经艰难运行了661天