事务

概述

事务确保一组数据库操作要么全部成功，要么全部失败回滚。Leoric 通过 Bone.transaction() 和 realm.transaction() 支持事务，同时兼容异步函数和生成器函数。

基本用法

使用异步函数

最常见的事务用法是传入异步函数。如果函数正常完成，事务会自动提交；如果抛出异常，事务会自动回滚。

import { Bone } from 'leoric';

await Bone.transaction(async ({ connection }) => {
  const post = await Post.create({ title: '新文章' }, { connection });
  await Comment.create({ postId: post.id, content: '沙发！' }, { connection });
});

重要：在事务内的每个查询都必须传入 { connection }，以确保它们使用同一个数据库连接。否则查询会在事务之外执行。

使用生成器函数

生成器函数提供了一种更便捷的方式，连接会自动传递给 yield 的 Spell 查询：

await Bone.transaction(function* () {
  const post = yield Post.create({ title: '新文章' });
  yield Comment.create({ postId: post.id, content: '沙发！' });
});

使用生成器函数时，Leoric 会自动拦截 yield 的 Spell 实例，并将事务连接赋给它们。这样就无需手动给每个查询传递 { connection }。

使用 `realm.transaction()`

如果你有 Realm 实例，也可以通过它来开启事务：

const realm = new Realm({ /* 配置项 */ });
await realm.connect();

await realm.transaction(async ({ connection }) => {
  await Post.create({ title: '你好' }, { connection });
  await User.update({ id: 1 }, { lastPostAt: new Date() }, { connection });
});

错误处理与回滚

如果事务回调内抛出任何异常，整个事务将自动回滚：

try {
  await Bone.transaction(async ({ connection }) => {
    await Post.create({ title: '新文章' }, { connection });

    // 这将导致整个事务回滚
    throw new Error('出了点问题');
  });
} catch (err) {
  console.error('事务失败:', err.message);
  // Post 和其他操作都不会被创建
}

手动提交和回滚

事务回调还接收 commit 和 rollback 函数，用于高级控制：

await Bone.transaction(async ({ connection, commit, rollback }) => {
  await Post.create({ title: '新文章' }, { connection });

  const result = await someExternalService();
  if (!result.ok) {
    await rollback();
    return;
  }

  // 如果没有手动提交或回滚，函数结束时仍会自动提交
});

事务与钩子

模型钩子（如 beforeCreate、afterUpdate）在事务内触发时，会在同一个连接上下文中执行。这确保了钩子中的数据库操作也是同一事务的一部分。

class Post extends Bone {
  static afterCreate(post, result) {
    // 如果 Post.create 是在事务内调用的，这里也在事务内执行
    return AuditLog.create({
      action: 'create',
      modelName: 'Post',
      modelId: post.id,
    });
  }
}

最佳实践

使用异步函数时务必传递 connection。不传的话查询会在事务之外运行。
优先使用生成器函数——当所有操作都是 Leoric 查询时，代码更简洁。
保持事务简短。长时间运行的事务可能导致锁竞争和性能问题。
妥善处理错误。需要优雅处理失败时，用 try-catch 包裹事务。
避免嵌套事务。Leoric 目前不支持 savepoint。如果需要嵌套事务行为，请重构代码使用单个事务。

站点开源，修改页面。

事务

目录

概述