使用 goframe
的 ORM
组件进行事务操作比较简便,可以通过两种操作方式来实现。
- 一种是
Begin
开启事务之后会返回一个事务操作对象*gdb.TX
,随后可以使用该对象进行如之前章节介绍的方法操作和链式操作。 - 一种是以
Transaction
闭包方法的形式来操作事务,所有的事务逻辑在闭包中实现,并且支持非常便捷的嵌套事务,嵌套事务在业务操作中透明无感知。
我们推荐事务操作均统一采用 Transaction
闭包方式实现。
接口文档: https://godoc.org/github.com/gogf/gf/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(); err == nil {
fmt.Println("开启事务操作")
}
事务操作对象可以执行所有 db
对象的方法,具体请参考 API文档。
2. 事务回滚操作
if tx, err := db.Begin(); 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(); 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.Table("user").Data(g.Map{"id":1, "name": "john_1"}).Save()
if err == nil {
tx.Commit()
}
fmt.Println(r)
}
其他链式操作请参考 ORM链式操作(重点) 章节。
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
版本 v1.16
版本开始,提供了对数据库嵌套事务的支持。需要注意的是,数据库服务往往并不支持嵌套事务,而是依靠 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
,包含两个字段 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;
示例程序代码:
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
开始计算)。