# DBResolver
DBResolver 为 GORM 提供了多个数据库支持，支持以下功能：
- 支持多个 sources、replicas
- 读写分离
- 根据工作表、struct 自动切换连接
- 手动切换连接
- Sources/Replicas 负载均衡
- 适用于原生 SQL
https://github.com/go-gorm/dbresolver
## 用法
```go
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"))
```
## 事务
使用 transaction 时，DBResolver 也会使用一个事务，且不会切换 sources/replicas 连接
## 自动切换连接
DBResolver 会根据工作表、struct 自动切换连接
对于原生 SQL，DBResolver 会从 SQL 中提取表名以匹配 Resolver，除非 SQL 开头为 `SELECT`，否则 DBResolver 总是会使用 `sources`，例如：
```go
// `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`
// 全局 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](https://gorm.io/docs/write_plugins.html) 实现的。
对于 `Query`、`Row` callback，如果手动指定为 `Write` 模式，此时会使用 `sources`，否则使用 `replicas`。 对于 `Raw` callback，如果 SQL 是以 `SELECT` 开头，语句会被认为是只读的，会使用 `replicas`，否则会使用 `sources`。
## 手动切换连接
```go
// 使用 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)
```
## 负载均衡
GORM 支持基于策略的 sources/replicas 负载均衡，自定义策略需实现以下接口：
```go
type Policy interface {
Resolve([]gorm.ConnPool) gorm.ConnPool
}
```
当前只实现了一个 `RandomPolicy` 策略，如果没有指定策略，它就是默认策略。
## 连接池
```go
DB.Use(
dbresolver.Register(dbresolver.Config{ /* xxx */ }).
SetConnMaxIdleTime(time.Hour).
SetConnMaxLifetime(24 * time.Hour).
SetMaxIdleConns(100).
SetMaxOpenConns(200)
)
```
