# 会话
GORM 提供了 `Session` 方法,这是一个 [`新建会话方法`](http://v2.gorm.io/zh_CN/docs/method_chaining.html),它允许创建带配置的新建会话模式:
```go
// 会话配置
type Session struct {
DryRun bool
PrepareStmt bool
WithConditions bool
Context context.Context
Logger logger.Interface
NowFunc func() time.Time
}
```
## DryRun
DarRun 模式会生成但不执行 `SQL`,可以用于准备或测试生成的 SQL,详情请参考 Session:
```go
// 新建会话模式
stmt := db.Session(&Session{DryRun: true}).First(&user, 1).Statement
stmt.SQL.String() //=> SELECT * FROM `users` WHERE `id` = $1 ORDER BY `id`
stmt.Vars //=> []interface{}{1}
// 全局 DryRun 模式
db, err := gorm.Open(sqlite.Open("gorm.db"), &gorm.Config{DryRun: true})
// 不同的数据库生成不同的 SQL
stmt := db.Find(&user, 1).Statement
stmt.SQL.String() //=> SELECT * FROM `users` WHERE `id` = $1 // PostgreSQL
stmt.SQL.String() //=> SELECT * FROM `users` WHERE `id` = ? // MySQL
stmt.Vars //=> []interface{}{1}
```
## PrepareStmt
`PreparedStmt` 在执行任何 SQL 时都会创建一个 prepared statement 并将其缓存,以提高后续的效率,例如:
```go
// 全局模式,所有 DB 操作都会 创建并缓存 prepared stmt
db, err := gorm.Open(sqlite.Open("gorm.db"), &gorm.Config{
PrepareStmt: true,
})
// 会话模式
tx := db.Session(&Session{PrepareStmt: true})
tx.First(&user, 1)
tx.Find(&users)
tx.Model(&user).Update("Age", 18)
// returns prepared statements manager
stmtManger, ok := tx.ConnPool.(*PreparedStmtDB)
// 关闭 *当前会话* 的 prepared statements
stmtManger.Close()
// 为 *当前会话* prepared SQL
stmtManger.PreparedSQL
// 开启当前数据库连接池(所有会话)的 prepared statements
stmtManger.Stmts // map[string]*sql.Stmt
for sql, stmt := range stmtManger.Stmts {
sql // prepared SQL
stmt // prepared statement
stmt.Close() // 关闭 prepared statement
}
```
## WithConditions
`WithCondition` 会共享 `*gorm.DB` 的条件,例如:
```go
tx := db.Where("name = ?", "jinzhu").Session(&gorm.Session{WithConditions: true})
tx.First(&user)
// SELECT * FROM users WHERE name = "jinzhu" ORDER BY id
tx.First(&user, "id = ?", 10)
// SELECT * FROM users WHERE name = "jinzhu" AND id = 10 ORDER BY id
// 不共享 `WithConditions`
tx2 := db.Where("name = ?", "jinzhu").Session(&gorm.Session{WithConditions: false})
tx2.First(&user)
// SELECT * FROM users ORDER BY id
```
## Context
`Context`,您可以通过 `Context` 来追踪 SQL 操作,例如:
```go
timeoutCtx, _ := context.WithTimeout(context.Background(), time.Second)
tx := db.Session(&Session{Context: timeoutCtx})
tx.First(&user) // 带 timeoutCtx 的查询
tx.Model(&user).Update("role", "admin") // 带 timeoutCtx 的更新
```
GORM 也提供快捷调用方法 `WithContext`,其实现如下:
```go
func (db *DB) WithContext(ctx context.Context) *DB {
return db.Session(&Session{WithConditions: true, Context: ctx})
}
```
## Logger
Gorm 允许使用 `Logger` 选项自定义内建 Logger,例如:
```go
newLogger := logger.New(log.New(os.Stdout, "\r\n", log.LstdFlags),
logger.Config{
SlowThreshold: time.Second,
LogLevel: logger.Silent,
Colorful: false,
})
db.Session(&Session{Logger: newLogger})
db.Session(&Session{Logger: logger.Default.LogMode(logger.Silent)})
```
查看 [Logger](http://v2.gorm.io/zh_CN/docs/logger.html) 获取详情
## NowFunc
`NowFunc` 允许改变 GORM 获取当前时间的实现,例如:
```go
db.Session(&Session{
NowFunc: func() time.Time {
return time.Now().Local()
},
})
```
## Debug
`Debug` 只是将会话的 `Logger` 修改为调试模式的快捷方法,其实现如下:
```go
func (db *DB) Debug() (tx *DB) {
return db.Session(&Session{
WithConditions: true,
Logger: db.Logger.LogMode(logger.Info),
})
}
```