go - Golang 事务 API 设计
问题描述
我正在尝试使用 Go来遵循Clean Architecture 。该应用程序是一个简单的图像管理应用程序。
我想知道如何最好地为我的存储库层设计接口。我不想将所有存储库方法组合到一个大接口中,就像我发现的一些示例一样,我认为在 Go 中通常首选小接口。我不认为有关管理图像的用例代码需要知道存储库还存储用户。所以我想有UserReader
,UserWriter
和。复杂之处在于代码需要是事务性的。事务管理在 Clean Architecture 中的归属存在一些争论,但我认为用例层需要能够控制事务。我认为,属于单一交易的是业务规则而不是技术细节。ImageReader
ImageWriter
现在的问题是,如何构建接口?
功能方法
因此,在这种方法中,我打开一个事务,运行提供的函数并在没有错误的情况下提交。
type UserRepository interface {
func ReadTransaction(txFn func (UserReader) error) error
func WriteTransaction(txFn func (UserWriter) error) error
}
type ImageRepository interface {
func ReadTransaction(txFn func (ImageReader) error) error
func WriteTransaction(txFn func (ImageWriter) error) error
}
问题:不,我不能在单个事务中轻松编写用户和图像,我必须为此创建一个额外的UserImageRepository
接口并提供单独的实现。
事务作为存储库
type ImageRepository interface {
func Writer() ImageReadWriter
func Reader() ImageReader
}
我认为这与功能方法非常相似。它不会解决组合使用多个存储库的问题,但至少可以通过编写一个简单的包装器来实现。
一个实现可能如下所示:
type BoltDBRepository struct {}
type BoltDBTransaction struct { *bolt.Tx }
func (tx *BoltDBTransaction) WriteImage(i usecase.Image) error
func (tx *BoltDBTransaction) WriteUser(i usecase.User) error
....
不幸的是,如果我实现这样的事务方法:
func (r *BoltDBRepository) Writer() *BoltDBTransaction
func (r *BoltDBRepository) Reader() *BoltDBTransaction
因为这没有实现ImageRepository
接口,所以我需要一个简单的包装器
type ImageRepository struct { *BoltDBRepository }
func (ir *ImageRepository) Writer() usecase.ImageReadWriter
func (ir *ImageRepository) Reader() usecase.ImageReader
交易即价值
type ImageReader interface {
func WriteImage(tx Transaction, i Image) error
}
type Transaction interface {
func Commit() error
}
type Repository interface {
func BeginTransaction() (Transaction, error)
}
并且存储库实现看起来像这样
type BoltDBRepository struct {}
type BoltDBTransaction struct { *bolt.Tx }
// implement ImageWriter
func (repo *BoltDBRepository) WriteImage(tx usecase.Transaction, img usecase.Image) error {
boltTx := tx.(*BoltDBTransaction)
...
}
问题:虽然这可行,但我必须在每个存储库方法的开头键入断言,这似乎有点乏味。
所以这些是我能想出的方法。哪个最合适,或者有更好的解决方案?
解决方案
存储库是保存数据的地方的表示,架构元素也是如此。
事务是解决非功能性要求(原子操作)的技术细节,因此它必须像架构元素中的内部引用或私有功能一样使用。
在这种情况下,如果您的存储库是这样编写的:
type UserRepository interface {
func Keep(UserData) error
func Find(UUID) UserData
}
type ImageRepository interface {
func Keep(ImageData) error
func Find(UUID) ImageData
}
事务方法是一种实现细节,因此您可以创建 UserRepository 和 ImageRepository 的“实现”,就像内部参考一样使用。
type UserRepositoryImpl struct {
Tx Transaction
}
func (r UserRepository) func Keep(UserData) error { return r.Tx.On(...)}
func (r UserRepository) func Find(UUID) UserData { return r.Tx.WithResult(...)}
通过这种方式,您也可以将用户和图像保留在单个事务中。
例如,如果客户端引用了 userRepository 和 imageRepository,并且它负责 userData 和 imageData,并且还希望将这两个数据保存在单个事务中,那么:
//open transaction and set in participants
tx := openTransaction()
ur := NewUserRepository(tx)
ir := NewImageRepository(tx)
//keep user and image datas
err0 := ur.Keep(userData)
err1 := ir.Keep(imageData)
//decision
if err0 != nil || err1 != nil {
tx.Rollback()
return
}
tx.Commit()
这是干净、客观的,并且在洋葱架构、DDD 和 3 层架构中运行良好(Martin Fowler)!
在洋葱架构中:
- 实体:用户和图像(没有业务规则)
- 用例:存储库接口(应用程序规则:保留用户和图像)
- 控制器:A/N
- DB/Api:客户端、tx、存储库实现