name: ORM 使用

sort: 2

ORM 使用方法

beego/orm 的使用例子

后文例子如无特殊说明都以这个为基础。

models.go:
  1. package main
  2. import (
  3. "github.com/astaxie/beego/orm"
  4. )
  5. type User struct {
  6. Id int
  7. Name string
  8. Profile *Profile `orm:"rel(one)"` // OneToOne relation
  9. Post []*Post `orm:"reverse(many)"` // 设置一对多的反向关系
  10. }
  11. type Profile struct {
  12. Id int
  13. Age int16
  14. User *User `orm:"reverse(one)"` // 设置一对一反向关系(可选)
  15. }
  16. type Post struct {
  17. Id int
  18. Title string
  19. User *User `orm:"rel(fk)"` //设置一对多关系
  20. Tags []*Tag `orm:"rel(m2m)"`
  21. }
  22. type Tag struct {
  23. Id int
  24. Name string
  25. Posts []*Post `orm:"reverse(many)"` //设置多对多反向关系
  26. }
  27. func init() {
  28. // 需要在init中注册定义的model
  29. orm.RegisterModel(new(User), new(Post), new(Profile), new(Tag))
  30. }
main.go
  1. package main
  2. import (
  3. "fmt"
  4. "github.com/astaxie/beego/orm"
  5. _ "github.com/go-sql-driver/mysql"
  6. )
  7. func init() {
  8. orm.RegisterDriver("mysql", orm.DRMySQL)
  9. orm.RegisterDataBase("default", "mysql", "root:root@/orm_test?charset=utf8")
  10. }
  11. func main() {
  12. o := orm.NewOrm()
  13. o.Using("default") // 默认使用 default,你可以指定为其他数据库
  14. profile := new(Profile)
  15. profile.Age = 30
  16. user := new(User)
  17. user.Profile = profile
  18. user.Name = "slene"
  19. fmt.Println(o.Insert(profile))
  20. fmt.Println(o.Insert(user))
  21. }

数据库的设置

目前 ORM 支持三种数据库,以下为测试过的 driver

将你需要使用的 driver 加入 import 中

  1. import (
  2. _ "github.com/go-sql-driver/mysql"
  3. _ "github.com/lib/pq"
  4. _ "github.com/mattn/go-sqlite3"
  5. )

RegisterDriver

三种默认数据库类型

  1. // For version 1.6
  2. orm.DRMySQL
  3. orm.DRSqlite
  4. orm.DRPostgres
  5. // < 1.6
  6. orm.DR_MySQL
  7. orm.DR_Sqlite
  8. orm.DR_Postgres
  1. // 参数1 driverName
  2. // 参数2 数据库类型
  3. // 这个用来设置 driverName 对应的数据库类型
  4. // mysql / sqlite3 / postgres 这三种是默认已经注册过的,所以可以无需设置
  5. orm.RegisterDriver("mysql", orm.DRMySQL)

RegisterDataBase

ORM 必须注册一个别名为 default 的数据库,作为默认使用。

ORM 使用 golang 自己的连接池

  1. // 参数1 数据库的别名,用来在 ORM 中切换数据库使用
  2. // 参数2 driverName
  3. // 参数3 对应的链接字符串
  4. orm.RegisterDataBase("default", "mysql", "root:root@/orm_test?charset=utf8")
  5. // 参数4(可选) 设置最大空闲连接
  6. // 参数5(可选) 设置最大数据库连接 (go >= 1.2)
  7. maxIdle := 30
  8. maxConn := 30
  9. orm.RegisterDataBase("default", "mysql", "root:root@/orm_test?charset=utf8", maxIdle, maxConn)

SetMaxIdleConns

根据数据库的别名,设置数据库的最大空闲连接

  1. orm.SetMaxIdleConns("default", 30)

SetMaxOpenConns

根据数据库的别名,设置数据库的最大数据库连接 (go >= 1.2)

  1. orm.SetMaxOpenConns("default", 30)

时区设置

ORM 默认使用 time.Local 本地时区

  • 作用于 ORM 自动创建的时间
  • 从数据库中取回的时间转换成 ORM 本地时间

如果需要的话,你也可以进行更改

  1. // 设置为 UTC 时间
  2. orm.DefaultTimeLoc = time.UTC

ORM 在进行 RegisterDataBase 的同时,会获取数据库使用的时区,然后在 time.Time 类型存取时做相应转换,以匹配时间系统,从而保证时间不会出错。

注意:

  • 鉴于 Sqlite3 的设计,存取默认都为 UTC 时间
  • 使用 go-sql-driver 驱动时,请注意参数设置从某一版本开始,驱动默认使用 UTC 时间,而非本地时间,所以请指定时区参数或者全部以 UTC 时间存取例如:root:root@/orm_test?charset=utf8&loc=Asia%2FShanghai参见 loc / parseTime

注册模型

如果使用 orm.QuerySeter 进行高级查询的话,这个是必须的。

反之,如果只使用 Raw 查询和 map struct,是无需这一步的。您可以去查看 Raw SQL 查询

RegisterModel

将你定义的 Model 进行注册,最佳设计是有单独的 models.go 文件,在他的 init 函数中进行注册。

迷你版 models.go

  1. package main
  2. import "github.com/astaxie/beego/orm"
  3. type User struct {
  4. Id int
  5. Name string
  6. }
  7. func init(){
  8. orm.RegisterModel(new(User))
  9. }

RegisterModel 也可以同时注册多个 model

  1. orm.RegisterModel(new(User), new(Profile), new(Post))

详细的 struct 定义请查看文档 模型定义

RegisterModelWithPrefix

使用表名前缀

  1. orm.RegisterModelWithPrefix("prefix_", new(User))

创建后的表名为 prefix_user

NewOrmWithDB

有时候需要自行管理连接池与数据库链接(比如:go 的链接池无法让两次查询使用同一个链接的)

但又想使用 ORM 的查询功能

  1. var driverName, aliasName string
  2. // driverName 是驱动的名称
  3. // aliasName 是当前 db 的自定义别名
  4. var db *sql.DB
  5. ...
  6. o := orm.NewOrmWithDB(driverName, aliasName, db)

GetDB

从已注册的数据库返回 *sql.DB 对象,默认返回别名为 default 的数据库。

  1. db, err := orm.GetDB()
  2. if err != nil {
  3. fmt.Println("get default DataBase")
  4. }
  5. db, err := orm.GetDB("alias")
  6. if err != nil {
  7. fmt.Println("get alias DataBase")
  8. }

ResetModelCache

重置已经注册的模型 struct,一般用于编写测试用例

  1. orm.ResetModelCache()

ORM 接口使用

使用 ORM 必然接触的 Ormer 接口,我们来熟悉一下

  1. var o orm.Ormer
  2. o = orm.NewOrm() // 创建一个 Ormer
  3. // NewOrm 的同时会执行 orm.BootStrap (整个 app 只执行一次),用以验证模型之间的定义并缓存。

切换数据库,或者,进行事务处理,都会作用于这个 Ormer 对象,以及其进行的任何查询。

所以:需要 切换数据库事务处理 的话,不要使用全局保存的 Ormer 对象。

QueryTable

传入表名,或者 Model 对象,返回一个 QuerySeter

  1. o := orm.NewOrm()
  2. var qs orm.QuerySeter
  3. qs = o.QueryTable("user")
  4. // 如果表没有定义过,会立刻 panic

Using

切换为其他数据库

  1. orm.RegisterDataBase("db1", "mysql", "root:root@/orm_db2?charset=utf8")
  2. orm.RegisterDataBase("db2", "sqlite3", "data.db")
  3. o1 := orm.NewOrm()
  4. o1.Using("db1")
  5. o2 := orm.NewOrm()
  6. o2.Using("db2")
  7. // 切换为其他数据库以后
  8. // 这个 Ormer 对象的其下的 api 调用都将使用这个数据库

默认使用 default 数据库,无需调用 Using

Raw

使用 sql 语句直接进行操作

Raw 函数,返回一个 RawSeter 用以对设置的 sql 语句和参数进行操作

  1. o := orm.NewOrm()
  2. var r orm.RawSeter
  3. r = o.Raw("UPDATE user SET name = ? WHERE name = ?", "testing", "slene")

Driver

返回当前 ORM 使用的 db 信息

  1. type Driver interface {
  2. Name() string
  3. Type() DriverType
  4. }
  1. orm.RegisterDataBase("db1", "mysql", "root:root@/orm_db2?charset=utf8")
  2. orm.RegisterDataBase("db2", "sqlite3", "data.db")
  3. o1 := orm.NewOrm()
  4. o1.Using("db1")
  5. dr := o1.Driver()
  6. fmt.Println(dr.Name() == "db1") // true
  7. fmt.Println(dr.Type() == orm.DRMySQL) // true
  8. o2 := orm.NewOrm()
  9. o2.Using("db2")
  10. dr = o2.Driver()
  11. fmt.Println(dr.Name() == "db2") // true
  12. fmt.Println(dr.Type() == orm.DRSqlite) // true

调试模式打印查询语句

简单的设置 Debug 为 true 打印查询的语句

可能存在性能问题,不建议使用在生产模式

  1. func main() {
  2. orm.Debug = true
  3. ...

默认使用 os.Stderr 输出日志信息

改变输出到你自己的 io.Writer

  1. var w io.Writer
  2. ...
  3. // 设置为你的 io.Writer
  4. ...
  5. orm.DebugLog = orm.NewLog(w)

日志格式

  1. [ORM] - 时间 - [Queries/数据库名] - [执行操作/执行时间] - [SQL语句] - 使用标点 `,` 分隔的参数列表 - 打印遇到的错误
  1. [ORM] - 2013-08-09 13:18:16 - [Queries/default] - [ db.Exec / 0.4ms] - [INSERT INTO `user` (`name`) VALUES (?)] - `slene`
  2. [ORM] - 2013-08-09 13:18:16 - [Queries/default] - [ db.Exec / 0.5ms] - [UPDATE `user` SET `name` = ? WHERE `id` = ?] - `astaxie`, `14`
  3. [ORM] - 2013-08-09 13:18:16 - [Queries/default] - [db.QueryRow / 0.4ms] - [SELECT `id`, `name` FROM `user` WHERE `id` = ?] - `14`
  4. [ORM] - 2013-08-09 13:18:16 - [Queries/default] - [ db.Exec / 0.4ms] - [INSERT INTO `post` (`user_id`,`title`,`content`) VALUES (?, ?, ?)] - `14`, `beego orm`, `powerful amazing`
  5. [ORM] - 2013-08-09 13:18:16 - [Queries/default] - [ db.Query / 0.4ms] - [SELECT T1.`name` `User__Name`, T0.`user_id` `User`, T1.`id` `User__Id` FROM `post` T0 INNER JOIN `user` T1 ON T1.`id` = T0.`user_id` WHERE T0.`id` = ? LIMIT 1000] - `68`
  6. [ORM] - 2013-08-09 13:18:16 - [Queries/default] - [ db.Exec / 0.4ms] - [DELETE FROM `user` WHERE `id` = ?] - `14`
  7. [ORM] - 2013-08-09 13:18:16 - [Queries/default] - [ db.Query / 0.3ms] - [SELECT T0.`id` FROM `post` T0 WHERE T0.`user_id` IN (?) ] - `14`
  8. [ORM] - 2013-08-09 13:18:16 - [Queries/default] - [ db.Exec / 0.4ms] - [DELETE FROM `post` WHERE `id` IN (?)] - `68`

日志内容包括 所有的数据库操作,事务,Prepare,等