GoFrame入门教程 GoFrame 数据库ORM-事务处理

2024-02-25 开发教程 GoFrame入门教程匿名 4℃

使用GoFrame ORM组件进行事务操作非常简便、安全，可以通过两种操作方式来实现。

常规操作：通过Begin开启事务之后会返回一个事务操作对象*gdb.TX，随后可以使用该对象进行如之前章节介绍的方法操作和链式操作。常规操作容易漏掉关闭事务，有一定的事务操作安全风险。
闭包操作：通过Transaction闭包方法的形式来操作事务，所有的事务逻辑在闭包中实现，闭包结束后自动关闭事务保障事务操作安全。并且闭包操作支持非常便捷的嵌套事务，嵌套事务在业务操作中透明无感知。

我们推荐事务操作均统一采用Transaction闭包方式实现。

接口文档： https://pkg.go.dev/github.com/gogf/gf/v2/database/gdb#TX

常规事务方法

常规的事务操作方法为Begin/Commit/Rollback，每一个方法指定特定的事务操作。开启事务操作可以通过执行db.Begin方法，该方法返回事务的操作对象，类型为*gdb.Tx，通过该对象执行后续的数据库操作，并可通过tx.Commit提交修改，或者通过tx.Rollback回滚修改。

常见问题注意：开启事务操作后，请务必在不需要使用该事务对象时，通过Commit/Rollback操作关闭掉该事务，建议充分利用好defer方法。如果事务使用后不关闭，在应用侧会引起goroutine不断激增泄露，在数据库侧会引起事务线程数量被打满，以至于后续的事务请求执行超时。此外，建议尽可能使用后续介绍的Transaction闭包方法来安全实现事务操作。

1. 开启事务操作

if tx, err := db.Begin(ctx); err == nil {
    fmt.Println("开启事务操作")
}

事务操作对象可以执行所有db对象的方法。

2. 事务回滚操作

if tx, err := db.Begin(ctx); err == nil {
    r, err := tx.Save("user", g.Map{
        "id"   :  1,
        "name" : "john",
    })
    if err != nil {
        tx.Rollback()
    }
    fmt.Println(r)
}

3. 事务提交操作

if tx, err := db.Begin(ctx); err == nil {
    r, err := tx.Save("user", g.Map{
        "id"   :  1,
        "name" : "john",
    })
    if err == nil {
       tx.Commit()
    }
    fmt.Println(r)
}

4. 事务链式操作

事务操作对象仍然可以通过tx.Model方法返回一个链式操作的对象，该对象与db.Model方法返回值相同，只不过数据库操作在事务上执行，可提交或回滚。

if tx, err := db.Begin(); err == nil {
    r, err := tx.Model("user").Data(g.Map{"id":1, "name": "john_1"}).Save()
    if err == nil {
       tx.Commit()
    }
    fmt.Println(r)
}

Transaction闭包操作

可以看到，通过常规的事务方法来管理事务有很多重复性的操作，并且存在遗忘提交/回滚操作来关闭事务的风险，因此为方便安全执行事务操作，ORM组件同样提供了事务的闭包操作，通过Transaction方法实现，该方法定义如下：

func (db DB) Transaction(ctx context.Context, f func(ctx context.Context, tx *TX) error) (err error)

当给定的闭包方法返回的error为nil时，那么闭包执行结束后当前事务自动执行Commit提交操作；否则自动执行Rollback回滚操作。闭包中的context.Context参数为goframe v1.16版本后新增的上下文变量，主要用于链路跟踪传递以及嵌套事务管理。由于上下文变量是嵌套事务管理的重要参数，因此上下文变量通过显示的参数传递定义。

如果闭包内部操作产生panic中断，该事务也将自动进行回滚，以保证操作安全。

使用示例：

db.Transaction(context.TODO(), func(ctx context.Context, tx *gdb.TX) error {
	// user
	result, err := tx.Ctx(ctx).Insert("user", g.Map{
		"passport": "john",
		"password": "12345678",
		"nickname": "JohnGuo",
	})
	if err != nil {
		return err
	}
	// user_detail
	id, err := result.LastInsertId()
	if err != nil {
		return err
	}
	_, err = tx.Ctx(ctx).Insert("user_detail", g.Map{
		"uid":       id,
		"site":      "https://johng.cn",
		"true_name": "GuoQiang",
	})
	if err != nil {
		return err
	}
	return nil
})

Transaction嵌套事务

从GoFrame ORM支持数据库嵌套事务。需要注意的是，数据库服务往往并不支持嵌套事务，而是依靠ORM组件层通过Transaction Save Point特性实现的。相关方法：

// Begin starts a nested transaction procedure.
func (tx *TX) Begin() error
// Commit commits current transaction.
// Note that it releases previous saved transaction point if it's in a nested transaction procedure,
// or else it commits the hole transaction.
func (tx *TX) Commit() error
// Rollback aborts current transaction.
// Note that it aborts current transaction if it's in a nested transaction procedure,
// or else it aborts the hole transaction.
func (tx *TX) Rollback() error
// SavePoint performs `SAVEPOINT xxx` SQL statement that saves transaction at current point.
// The parameter `point` specifies the point name that will be saved to server.
func (tx *TX) SavePoint(point string) error
// RollbackTo performs `ROLLBACK TO SAVEPOINT xxx` SQL statement that rollbacks to specified saved transaction.
// The parameter `point` specifies the point name that was saved previously.
func (tx *TX) RollbackTo(point string) error
// Transaction wraps the transaction logic using function `f`.
// It rollbacks the transaction and returns the error from function `f` if
// it returns non-nil error. It commits the transaction and returns nil if
// function `f` returns nil.
//
// Note that, you should not Commit or Rollback the transaction in function `f`
// as it is automatically handled by this function.
func (tx *TX) Transaction(ctx context.Context, f func(ctx context.Context, tx *TX) error) (err error)

同样的，我们推荐使用Transaction闭包方法来实现嵌套事务操作。为了保证文档的完整性，因此我们这里仍然从最基本的事务操作方法开始来介绍嵌套事务操作。

1. 示例SQL

一个简单的示例SQL，包含两个字段id和name：

CREATE TABLE `user` (
  `id` int(10) unsigned NOT NULL COMMENT '用户ID',
  `name` varchar(45) NOT NULL COMMENT '用户名称',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

2. 常规操作

tx, err := db.Begin()
if err != nil {
	panic(err)
}
if err = tx.Begin(); err != nil {
	panic(err)
}
_, err = tx.Model(table).Data(g.Map{"id": 1, "name": "john"}).Insert()
if err = tx.Rollback(); err != nil {
	panic(err)
}
_, err = tx.Model(table).Data(g.Map{"id": 2, "name": "smith"}).Insert()
if err = tx.Commit(); err != nil {
	panic(err)
}

db.Begin与tx.Begin

可以看到，在我们的嵌套事务中出现了db.Begin和tx.Begin两种事务开启方式，两者有什么区别呢？db.Begin是在数据库服务上真正开启一个事务操作，并返回一个事务操作对象tx，随后所有的事务操作都是通过该tx事务对象来操作管理。tx.Begin表示在当前事务操作中开启嵌套事务，默认情况下会对嵌套事务的SavePoint采用自动命名，命名格式为transactionN，其中的N表示嵌套的层级数量，如果您看到日志中出现SAVEPOINT `transaction1`表示当前嵌套层级为2（从0开始计算）。

更详细的日志

goframe的ORM拥有相当完善的日志记录机制，如果您打开SQL日志，那么将会看到以下日志信息，展示了整个数据库请求的详细执行流程：

2021-05-22 21:12:10.776 [DEBU] [  4 ms] [default] [txid:1] BEGIN
2021-05-22 21:12:10.776 [DEBU] [  0 ms] [default] [txid:1] SAVEPOINT `transaction0`
2021-05-22 21:12:10.789 [DEBU] [ 13 ms] [default] [txid:1] SHOW FULL COLUMNS FROM `user`
2021-05-22 21:12:10.790 [DEBU] [  1 ms] [default] [txid:1] INSERT INTO `user`(`id`,`name`) VALUES(1,'john')
2021-05-22 21:12:10.791 [DEBU] [  1 ms] [default] [txid:1] ROLLBACK TO SAVEPOINT `transaction0`
2021-05-22 21:12:10.791 [DEBU] [  0 ms] [default] [txid:1] INSERT INTO `user`(`id`,`name`) VALUES(2,'smith')
2021-05-22 21:12:10.792 [DEBU] [  1 ms] [default] [txid:1] COMMIT

其中的[txid:1]表示ORM组件记录的事务ID，多个真实的事务同时操作时，每个事务的ID将会不同。在同一个真实事务下的嵌套事务的事务ID是一样的。

执行后查询数据库结果：

mysql> select * from `user`;
+----+-------+
| id | name  |
+----+-------+
|  2 | smith |
+----+-------+
1 row in set (0.00 sec)

可以看到第一个操作被成功回滚，只有第二个操作执行并提交成功。

3. 闭包操作(推荐)

我们也可以通过闭包操作来实现嵌套事务，同样也是通过Transaction方法实现。

db.Transaction(ctx, func(ctx context.Context, tx *gdb.TX) error {
	// Nested transaction 1.
	if err := tx.Transaction(ctx, func(ctx context.Context, tx *gdb.TX) error {
		_, err := tx.Model(table).Ctx(ctx).Data(g.Map{"id": 1, "name": "john"}).Insert()
		return err
	}); err != nil {
		return err
	}
	// Nested transaction 2, panic.
	if err := tx.Transaction(ctx, func(ctx context.Context, tx *gdb.TX) error {
		_, err := tx.Model(table).Ctx(ctx).Data(g.Map{"id": 2, "name": "smith"}).Insert()
		// Create a panic that can make this transaction rollback automatically.
		panic("error")
		return err
	}); err != nil {
		return err
	}
	return nil
})

嵌套事务的闭包嵌套中也可以不使用其中的tx对象，而是直接使用db对象或者dao包，这种方式更常见一些。特别是在方法层级调用时，使得对于开发者来说并不用关心tx对象的传递，也并不用关心当前事务是否需要嵌套执行，一切都由组件自动维护，极大减少开发者的心智负担。但是务必记得将ctx上下文变量层层传递下去哦。例如：

db.Transaction(ctx, func(ctx context.Context, tx *gdb.TX) error {
	// Nested transaction 1.
	if err := db.Transaction(ctx, func(ctx context.Context, tx *gdb.TX) error {
		_, err := db.Model(table).Ctx(ctx).Data(g.Map{"id": 1, "name": "john"}).Insert()
		return err
	}); err != nil {
		return err
	}
	// Nested transaction 2, panic.
	if err := db.Transaction(ctx, func(ctx context.Context, tx *gdb.TX) error {
		_, err := db.Model(table).Ctx(ctx).Data(g.Map{"id": 2, "name": "smith"}).Insert()
		// Create a panic that can make this transaction rollback automatically.
		panic("error")
		return err
	}); err != nil {
		return err
	}
	return nil
})

如果您打开SQL日志，那么执行后将会看到以下日志信息，展示了整个数据库请求的详细执行流程：

2021-05-22 21:18:46.672 [DEBU] [  2 ms] [default] [txid:1] BEGIN
2021-05-22 21:18:46.672 [DEBU] [  0 ms] [default] [txid:1] SAVEPOINT `transaction0`
2021-05-22 21:18:46.673 [DEBU] [  0 ms] [default] [txid:1] SHOW FULL COLUMNS FROM `user`
2021-05-22 21:18:46.674 [DEBU] [  0 ms] [default] [txid:1] INSERT INTO `user`(`id`,`name`) VALUES(1,'john')
2021-05-22 21:18:46.674 [DEBU] [  0 ms] [default] [txid:1] RELEASE SAVEPOINT `transaction0`
2021-05-22 21:18:46.675 [DEBU] [  1 ms] [default] [txid:1] SAVEPOINT `transaction0`
2021-05-22 21:18:46.675 [DEBU] [  0 ms] [default] [txid:1] INSERT INTO `user`(`name`,`id`) VALUES('smith',2)
2021-05-22 21:18:46.675 [DEBU] [  0 ms] [default] [txid:1] ROLLBACK TO SAVEPOINT `transaction0`
2021-05-22 21:18:46.676 [DEBU] [  1 ms] [default] [txid:1] ROLLBACK

假如ctx上下文变量没有层层传递下去，那么嵌套事务将会失败，我们来看一个错误的例子：

db.Transaction(ctx, func(ctx context.Context, tx *gdb.TX) error {
	// Nested transaction 1.
	if err := db.Transaction(ctx, func(ctx context.Context, tx *gdb.TX) error {
		_, err := db.Model(table).Ctx(ctx).Data(g.Map{"id": 1, "name": "john"}).Insert()
		return err
	}); err != nil {
		return err
	}
	// Nested transaction 2, panic.
	if err := db.Transaction(ctx, func(ctx context.Context, tx *gdb.TX) error {
		_, err := db.Model(table).Data(g.Map{"id": 2, "name": "smith"}).Insert()
		// Create a panic that can make this transaction rollback automatically.
		panic("error")
		return err
	}); err != nil {
		return err
	}
	return nil
})

打开SQL执行日志，执行后，您将会看到以下日志内容：

2021-05-22 21:29:38.841 [DEBU] [  3 ms] [default] [txid:1] BEGIN
2021-05-22 21:29:38.842 [DEBU] [  1 ms] [default] [txid:1] SAVEPOINT `transaction0`
2021-05-22 21:29:38.843 [DEBU] [  1 ms] [default] [txid:1] SHOW FULL COLUMNS FROM `user`
2021-05-22 21:29:38.845 [DEBU] [  2 ms] [default] [txid:1] INSERT INTO `user`(`id`,`name`) VALUES(1,'john')
2021-05-22 21:29:38.845 [DEBU] [  0 ms] [default] [txid:1] RELEASE SAVEPOINT `transaction0`
2021-05-22 21:29:38.846 [DEBU] [  1 ms] [default] [txid:1] SAVEPOINT `transaction0`
2021-05-22 21:29:38.847 [DEBU] [  1 ms] [default] INSERT INTO `user`(`id`,`name`) VALUES(2,'smith')
2021-05-22 21:29:38.848 [DEBU] [  0 ms] [default] [txid:1] ROLLBACK TO SAVEPOINT `transaction0`
2021-05-22 21:29:38.848 [DEBU] [  0 ms] [default] [txid:1] ROLLBACK

可以看到，第二条INSERT操作INSERT INTO `user`(`id`,`name`) VALUES(2,'smith') 没有事务ID打印，表示没有使用到事务，那么该操作将会被真正提交到数据库执行，并不能被回滚。

4. SavePoint/RollbackTo

开发者也可以灵活使用Transaction Save Point特性，并实现自定义的SavePoint命名以及指定Point回滚操作。

tx, err := db.Begin()
if err != nil {
	panic(err)
}
defer func() {
	if err := recover(); err != nil {
		_ = tx.Rollback()
	}
}()
if _, err = tx.Model(table).Data(g.Map{"id": 1, "name": "john"}).Insert(); err != nil {
	panic(err)
}
if err = tx.SavePoint("MyPoint"); err != nil {
	panic(err)
}
if _, err = tx.Model(table).Data(g.Map{"id": 2, "name": "smith"}).Insert(); err != nil {
	panic(err)
}
if _, err = tx.Model(table).Data(g.Map{"id": 3, "name": "green"}).Insert(); err != nil {
	panic(err)
}
if err = tx.RollbackTo("MyPoint"); err != nil {
	panic(err)
}
if err = tx.Commit(); err != nil {
	panic(err)
}

如果您打开SQL日志，那么将会看到以下日志信息，展示了整个数据库请求的详细执行流程：

2021-05-22 21:38:51.992 [DEBU] [  3 ms] [default] [txid:1] BEGIN
2021-05-22 21:38:52.002 [DEBU] [  9 ms] [default] [txid:1] SHOW FULL COLUMNS FROM `user`
2021-05-22 21:38:52.002 [DEBU] [  0 ms] [default] [txid:1] INSERT INTO `user`(`id`,`name`) VALUES(1,'john')
2021-05-22 21:38:52.003 [DEBU] [  1 ms] [default] [txid:1] SAVEPOINT `MyPoint`
2021-05-22 21:38:52.004 [DEBU] [  1 ms] [default] [txid:1] INSERT INTO `user`(`id`,`name`) VALUES(2,'smith')
2021-05-22 21:38:52.005 [DEBU] [  1 ms] [default] [txid:1] INSERT INTO `user`(`id`,`name`) VALUES(3,'green')
2021-05-22 21:38:52.006 [DEBU] [  0 ms] [default] [txid:1] ROLLBACK TO SAVEPOINT `MyPoint`
2021-05-22 21:38:52.006 [DEBU] [  0 ms] [default] [txid:1] COMMIT

执行后查询数据库结果：

mysql> select * from `user`;
+----+------+
| id | name |
+----+------+
|  1 | john |
+----+------+
1 row in set (0.00 sec)

可以看到，通过在第一个Insert操作后保存了一个SavePoint名称MyPoint，随后的几次操作都通过RollbackTo方法被回滚掉了，因此只有第一次Insert操作被成功提交执行。

嵌套事务在工程中的参考示例

为了简化示例，我们还是使用用户模块相关的示例，例如用户注册，通过事务操作保存用户基本信息(user)、详细信息(user_detail)两个表，任一个表操作失败整个注册操作都将失败。为展示嵌套事务效果，我们将用户基本信息管理和用户详细信息管理划分为了两个dao对象。

假如我们的项目按照goframe标准项目工程化分为三层api-service-dao，那么我们的嵌套事务操作可能是这样的。

controller

// 用户注册HTTP接口
func (*cUser) Signup(r *ghttp.Request) {
	// ....
	service.User().Signup(r.Context(), userServiceSignupReq)
	// ...
}

承接HTTP请求，并且将Context上下文边变量传递给后续的流程。

service

// 用户注册业务逻辑处理
func (*userService) Signup(ctx context.Context, r *model.UserServiceSignupReq) {
	// ....
	dao.User.Transaction(ctx, func(ctx context.Context, tx *gdb.TX) error {
		err := dao.User.Ctx(ctx).Save(r.UserInfo)
		if err != nil {
			return err
		}
		err := dao.UserDetail.Ctx(ctx).Save(r.UserDetail)
		if err != nil {
			return err
		}
		return nil
	})
	// ...
}

可以看到，内部的user表和user_detail表使用了嵌套事务来统一执行事务操作。注意在闭包内部需要通过Ctx方法将上下文变量传递给下一层级。假如在闭包中存在对其他service对象的调用，那么也需要将ctx变量传递过去，例如：

func (*userService) Signup(ctx context.Context, r *model.UserServiceSignupReq) {
	// ....
	dao.User.Transaction(ctx, func(ctx context.Context, tx *gdb.TX) (err error) {
		if err = dao.User.Ctx(ctx).Save(r.UserInfo); err != nil {
			return err
		}
		if err = dao.UserDetail.Ctx(ctx).Save(r.UserDetail); err != nil {
			return err
		}
		if err = service.XXXA().Call(ctx, ...); err != nil {
			return err
		}
		if err = service.XXXB().Call(ctx, ...); err != nil {
			return err
		}
		if err = service.XXXC().Call(ctx, ...); err != nil {
			return err
		}
        // ...
		return nil
	})
	// ...
}

dao

dao层的代码由goframe cli工具全自动化生成及维护即可。

上一节： GoFrame 数据库ORM-方法操作

下一节： GoFrame 数据库ORM-结果处理

"GoFrame入门教程"的目录