Go Mysql Driver 集成 Seata-Golang 解決分布式事務問題

簡介： 2020 年 4 月，我們開始嘗試實現 go 語言的分布式事務框架 Seata-Golang。眾所周知，Seata AT 模式以無業務代碼侵入的特點，被廣大開發者推崇。Java 版 Seata AT 模式通過對 DataSource 數據源進行代理，在 sql 語句執行時，對 sql 攔截解析，獲取數據庫對應數據在 sql 語句執行前后的副本，序列化后保存起來，在 TC 協調回滾時用來回滾對應數據。實現 go 版本 client 的 AT 模式時，怎樣對業務開發者更友好，入侵更少，成了首要考慮的目標。

作者 | 劉曉敏  GitHub ID：dk-lockdown
來源 | 阿里巴巴雲原生公眾號

背景

2020 年 4 月，我們開始嘗試實現 go 語言的分布式事務框架 Seata-Golang。眾所周知，Seata AT 模式以無業務代碼侵入的特點，被廣大開發者推崇。Java 版 Seata AT 模式通過對 DataSource 數據源進行代理，在 sql 語句執行時，對 sql 攔截解析，獲取數據庫對應數據在 sql 語句執行前后的副本，序列化后保存起來，在 TC 協調回滾時用來回滾對應數據。實現 go 版本 client 的 AT 模式時，怎樣對業務開發者更友好，入侵更少，成了首要考慮的目標。

使用 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 周開發，第一個集成 Seata-Golang 的完全兼容 database/sql 的 mysql driver 被開發出來，項目開源在 https://github.com/opentrx/mysql，現處於 beta 狀態，希望社區開發者使用后能有一些反饋，可通過例子：https://github.com/opentrx/seata-go-samples，查看使用方式並進行測試。

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。

寄語

此項目開源到今年 4 月即滿一年，通過本文中的 mysql driver，希望能降低使用門檻，讓大家真正用起來，大家在選擇微服務開發技術棧時也不用擔心 go 語言沒有分布式事務處理方案。

本文為阿里雲原創內容，未經允許不得轉載。