gorm 数据库解析器——迹忆客-ag捕鱼王app官网

dbresolver 为 gorm 提供了多个数据库支持，支持以下功能：

• 支持多个 sources、replicas
• 读写分离
• 根据工作表、struct 自动切换连接
• 手动切换连接
• sources/replicas 负载均衡
• 适用于原生 sql
• 事务

用法

import (
  "gorm.io/gorm"
  "gorm.io/plugin/dbresolver"
  "gorm.io/driver/mysql"
)
db, err := gorm.open(mysql.open("db1_dsn"), &gorm.config{})
db.use(dbresolver.register(dbresolver.config{
  // `db2` 作为 sources，`db3`、`db4` 作为 replicas
  sources:  []gorm.dialector{mysql.open("db2_dsn")},
  replicas: []gorm.dialector{mysql.open("db3_dsn"), mysql.open("db4_dsn")},
  // sources/replicas 负载均衡策略
  policy: dbresolver.randompolicy{},
}).register(dbresolver.config{
  // `db1` 作为 sources（db 的默认连接），对于 `user`、`address` 使用 `db5` 作为 replicas
  replicas: []gorm.dialector{mysql.open("db5_dsn")},
}, &user{}, &address{}).register(dbresolver.config{
  // `db6`、`db7` 作为 sources，对于 `orders`、`product` 使用 `db8` 作为 replicas
  sources:  []gorm.dialector{mysql.open("db6_dsn"), mysql.open("db7_dsn")},
  replicas: []gorm.dialector{mysql.open("db8_dsn")},
}, "orders", &product{}, "secondary"))

自动切换连接

dbresolver 会根据工作表、struct 自动切换连接

对于原生 sql，dbresolver 会从 sql 中提取表名以匹配 resolver，除非 sql 开头为 select（select for update 除外），否则 dbresolver 总是会使用 sources ，例如：

// `user` resolver 示例
db.table("users").rows() // replicas `db5`
db.model(&user{}).find(&advanceduser{}) // replicas `db5`
db.exec("update users set name = ?", "jinzhu") // sources `db1`
db.raw("select name from users").row().scan(&name) // replicas `db5`
db.create(&user) // sources `db1`
db.delete(&user{}, "name = ?", "jinzhu") // sources `db1`
db.table("users").update("name", "jinzhu") // sources `db1`
// global resolver 示例
db.find(&pet{}) // replicas `db3`/`db4`
db.save(&pet{}) // sources `db2`
// orders resolver 示例
db.find(&order{}) // replicas `db8`
db.table("orders").find(&report{}) // replicas `db8`

读写分离

dbresolver 的读写分离目前是基于 gorm callback 实现的。

对于 query、row callback，如果手动指定为 write 模式，此时会使用 sources，否则使用 replicas。 对于 raw callback，如果 sql 是以 select 开头，语句会被认为是只读的，会使用 replicas，否则会使用 sources。

手动切换连接

// 使用 write 模式：从 sources db `db1` 读取 user
db.clauses(dbresolver.write).first(&user)
// 指定 resolver：从 `secondary` 的 replicas db `db8` 读取 user
db.clauses(dbresolver.use("secondary")).first(&user)
// 指定 resolver 和 write 模式：从 `secondary` 的 sources db `db6` 或 `db7` 读取 user
db.clauses(dbresolver.use("secondary"), dbresolver.write).first(&user)

事务

使用事务时，dbresolver 也会保持使用一个事务，且不会根据配置切换 sources/replicas 连接

但我们可以在事务开始之前指定使用哪个数据库，例如：

// 通过默认 replicas db 开始事务
tx := db.clauses(dbresolver.read).begin()
// 通过默认 sources db 开始事务
tx := db.clauses(dbresolver.write).begin()
// 通过 `secondary` 的 sources db 开始事务
tx := db.clauses(dbresolver.use("secondary"), dbresolver.write).begin()

负载均衡

gorm 支持基于策略的 sources/replicas 负载均衡，自定义策略应该是一个实现了以下接口的 struct：

type policy interface {
    resolve([]gorm.connpool) gorm.connpool
}

当前只实现了一个 randompolicy 策略，如果没有指定其它策略，它就是默认策略。

连接池

db.use(
  dbresolver.register(dbresolver.config{ /* xxx */ }).
  setconnmaxidletime(time.hour).
  setconnmaxlifetime(24 * time.hour).
  setmaxidleconns(100).
  setmaxopenconns(200)
)