![頭圖.png](https://ucc.alicdn.com/pic/developer-ecology/1e903557140d42f1a532b439b0e39910.png)

作者 | 劉曉敏  GitHub ID：dk-lockdown
來源 | [阿里巴巴雲原生公眾號](https://mp.weixin.qq.com/s/CB6BCai1k2tCJBOWJ9o1_g)

# 背景

2020 年 4 月，我們開始嘗試實現 go 語言的分散式事務框架 [Seata-Golang](https://github.com/opentrx/seata-golang)。眾所周知，Seata AT 模式以無業務程式碼侵入的特點，被廣大開發者推崇。Java 版 Seata AT 模式透過對 DataSource 資料來源進行代理，在 sql 語句執行時，對 sql 攔截解析，獲取資料庫對應資料在 sql 語句執行前後的副本，序列化後儲存起來，在 TC 協調回滾時用來回滾對應資料。實現 go 版本 client 的 AT 模式時，怎樣對業務開發者更友好，入侵更少，成了首要考慮的目標。

![1.png](https://ucc.alicdn.com/pic/developer-ecology/4a04feba009244f9bfaf85fee77591a2.png)

使用 go 運算元據庫時，我們會使用到 go 語言的官方庫 `database/sql`，透過 `sql.Open("mysql", ${dsn})` 獲取一個資料來源操作物件 db。開啟事務時，使用 `db.Begin()` 或 `db.BeginTx(ctx, &sql.TxOptions{})` 獲得事務操作物件 tx，執行 sql 查詢使用 `tx.Query`；執行 sql 新增、修改、刪除，使用 `tx.Exec`；最後使用 `tx.Commit()` 提交或使用 `tx.Rollback()` 回滾。

go 語言官方庫 `database/sql` 提供了一個標準抽象層，透過實現不同的 driver 一套標準的抽象 API 可以操作不同的資料庫。開發 Go 版本的 AT 模式，必然要相容 `database/sql`。透過研究 `database/sql` 的 api，建立資料來源操作物件，資料庫有關的配置必須透過 Data Source Name (DSN) 抽象傳遞進去，下面是 DSN 的定義：

`[username[:password]@][protocol[(address)]]/dbname[?param1=value1&...&paramN=valueN]`

實現 AT 模式對資料來源代理是需要和事務協調器 TC 進行互動的，如果將 AT 模式實現在 driver 層，那麼和 TC 互動的一些引數必須要透過 DSN 傳遞到 driver，這樣有些破壞它的設計。所以，最後採取了一種折中方案，在 `database/sql` 層之上實現 AT 模式，代理 `database/sql` 建立出來的資料來源操作物件。資料來源代理物件實現 `database/sql` 庫定義的 Tx 介面，另外再提供一個開啟事務的方法：`Begin()`，雖然沒有完全相容 `database/sql` 的 api，但是關鍵介面和它的定義成一樣，勉強還能接受。到此，Seata-Golang 專案核心功能的開發已完成。

```
type Tx interface {
	Commit() error
	Rollback() error
}
```

# 轉折

Seata-Golang  開源後，逐漸被一些開發者瞭解和接觸，社群也對 Seata-Golang 發出了一些反饋的聲音，不少開發者並不習慣寫原生 sql，他們希望將 Seata-Golang 整合到 ORM 框架，因為當時的設計沒有完全相容 `database/sql` 導致整合上遇到一些困難。隨著社群的熱切呼喚，且得益於前期對 driver 的一些研究，念念不忘必有迴響，今年 3 月突然靈感迸發：為什麼引數一定要透過 DSN 傳遞？Seata-Golang Client 初始化後，在需要時透過 Client 端的 API `config.GetATConfig()` 直接獲取使用不就可以了。

![2.png](https://ucc.alicdn.com/pic/developer-ecology/62de43ca6f7249e7bcdbf44fa712ac57.png)

於是工作之餘，歷時 2 周開發，第一個整合 Seata-Golang 的完全相容 `database/sql` 的 mysql driver 被開發出來，專案開源在 https://github.com/opentrx/mysql，現處於 beta 狀態，希望社群開發者使用後能有一些反饋，可透過例子：[https://github.com/opentrx/seata-go-samples](https://mp.weixin.qq.com/s?__biz=MzUzNzYxNjAzMg==&mid=2247502784&idx=1&sn=6d2a90ba50b3bb025bf0f4f4fea7a848&chksm=fae6c00fcd91491924525f152ab388bf94a01c5e945292063ab218eec9419eff7443cfd0dde5&token=1233080785&lang=zh_CN)，檢視使用方式並進行測試。

# driver 的一些細節

- **使用該 driver 進行分散式事務操作時，不能在 dsn 中設定 interpolateParams 引數為 true**。

這涉及到 mysql 的兩個協議：Text 協議和 Binary 協議。有關兩個協議的區別，可以在文末參考文件找到資料。實現該 driver 只對 binary 協議進行了處理，開啟 interpolateParams 會使用 text 協議執行 sql。

- **使用該 driver 在需要加入全域性事務組和 tc 進行互動時，需要使用 `db.BeginTx(ctx context.Context, opts driver.TxOptions)` 方法，並在 ctx 中加入 `XID` 全域性事務 id 的值**。

```
ctx := context.WithValue(context.Background(), mysql.XID, c.Request.Header.Get("XID"))
tx, err := dao.BeginTx(ctx, &sql.TxOptions{
		Isolation: sql.LevelDefault,
		ReadOnly:  false,
	})
```

XID 傳遞到 driver 層，會儲存在 &mysqlConn 連線物件中，在和 TC 互動時用到。

- **使用該 driver 的分散式事務功能前需要先初始化 seata-golang client 和 mysql driver**：

```
  config.InitConf(configPath)
  client.NewRpcClient()
  mysql.InitDataResourceManager()
  mysql.RegisterResource(config.GetATConfig().DSN)
```

具體可參考 [seata-go-samples](https://github.com/opentrx/seata-go-samples)。

## 寄語

此專案開源到今年 4 月即滿一年，透過本文中的 mysql driver，希望能降低使用門檻，讓大家真正用起來，大家在選擇微服務開發技術棧時也不用擔心 go 語言沒有分散式事務處理方案。另外，此專案還很年輕，仍有許多需要完善的地方，希望感興趣的朋友一起參與到社群來對它進行完善！希望聽到社群更多使用者的反饋！
如果你有任何疑問，歡迎釘釘掃碼加入交流群【釘釘群號 33069364】

## 作者簡介

劉曉敏 (GitHubID dk-lockdown)，目前就職於 h3c 成都分公司，擅長使用 Java/Go 語言，在雲原生和微服務相關技術方向均有涉獵，目前專攻分散式事務。

## 參考資料

- [seata 官方](https://seata.io/)

- [java 版 seata](https://github.com/seata/seata)

- [seata-golang 專案地址](https://github.com/transaction-wg/seata-golang)

- [driver 地址](https://github.com/opentrx/mysql)

- [seata-golang go 夜讀 b站分享](https://www.bilibili.com/video/BV1oz411e72T)

- [基於 getty 的 seata-golang 通訊模型詳解](http://seata.io/zh-cn/blog/seata-golang-communication-mode.html)

- [seata-golang 接入指南](https://mp.weixin.qq.com/s/EYtPycuqIlKi5KJ_hzZPVA)

- [mysql protocol](https://dev.mysql.com/doc/internals/en/client-server-protocol.html)

Go Mysql Driver 整合 Seata-Golang 解決分散式事務問題

相關文章