beego——ORM使用方法

先来看一个简单示例：

models.gp

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36

package main   import (     "github.com/astaxie/beego/orm" )   type User struct {     Id          int     Name        string     Profile     *Profile   `orm:"rel(one)"` // OneToOne relation     Post        []*Post `orm:"reverse(many)"` // 设置一对多的反向关系 }   type Profile struct {     Id          int     Age         int16     User        *User   `orm:"reverse(one)"` // 设置一对一反向关系(可选) }   type Post struct {     Id    int     Title string     User  *User  `orm:"rel(fk)"`    //设置一对多关系     Tags  []*Tag `orm:"rel(m2m)"` }   type Tag struct {     Id    int     Name  string     Posts []*Post `orm:"reverse(many)"` }   func init() {     // 需要在init中注册定义的model     orm.RegisterModel(new(User), new(Post), new(Profile), new(Tag)) }

main.go

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28

package main   import (     "fmt"     "github.com/astaxie/beego/orm"     _ "github.com/go-sql-driver/mysql" )   func init() {     orm.RegisterDriver("mysql", orm.DRMySQL)  //数据库类型设计       orm.RegisterDataBase("default", "mysql", "root:root@/orm_test?charset=utf8") }   func main() {     o := orm.NewOrm()     o.Using("default") // 默认使用 default，你可以指定为其他数据库       profile := new(Profile)     profile.Age = 30       user := new(User)     user.Profile = profile     user.Name = "slene"       fmt.Println(o.Insert(profile))     fmt.Println(o.Insert(user)) }

　

一、数据库的设置　

目前beego ORM支持三种数据库，已经经过基本测试。

?

1 2 3 4 5

import (     _ "github.com/go-sql-driver/mysql"     _ "github.com/lib/pq"     _ "github.com/mattn/go-sqlite3" )

　　

RegisterDriver

三种默认数据库类型的版本设置

?

1 2 3 4 5 6 7 8 9 10 11 12 13

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

　　

RegisterDataBase

ORM必须注册一个别名为default的数据库，作为默认使用。ORM使用golang自己的连接池。

?

1 2 3 4 5 6 7 8 9 10

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

 

SetMaxldelConns

根据数据库的别名，设置数据库的最大空闲连接，这个值也可以在RegisterDateBase中设置。

?

1	orm.SetMaxIdleConns("default", 30)

　　

SetMaxOpenConns

根据数据库的别名，设置数据库的最大数据库连接，这个值也可以在RegisterDateBase中设置。

?

1	orm.SetMaxOpenConns("default", 30)

　　

时区设置

ORM默认使用time.Local本地时区，用于ORM自动创建的时间，也可以是从数据库中取回的时间转换成ORM本地时间。

如果需要的话，可以进行更改：

?

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

　　

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

注意：

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

 

二、注册模型

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

反之，如果只使用Raw查询和map struct，是无需这一步的。

注册就是让ORM语句转化为sql语句并写进数据库。

RegisterModel

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

?

1 2 3 4 5 6 7 8 9 10 11 12

package main   import "github.com/astaxie/beego/orm"   type User struct {     Id   int     Name string }   func init(){     orm.RegisterModel(new(User)) }

RegisterModel也可以同时注册多个model。

?

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

　　

RegisterModelWithPrefix

使用表名前缀

?

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

创建后的表名为prefix_user.

 

NewOrmWithDB

有时候需要自行管理连接池与数据库连接（比如：go的链接池也无法让两次查询使用同一个链接的），但又想使用ORM的查询功能

?

1 2 3 4 5 6

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

　　

GetDB

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

?

1 2 3 4 5 6 7 8 9

db, err := orm.GetDB() if err != nil {     fmt.Println("get default DataBase") }   db, err := orm.GetDB("alias") if err != nil {     fmt.Println("get alias DataBase") }

　　

ResetModelCache

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

?

1	orm.ResetModelCache()

　　

 

三、ORM接口使用

使用ORM必然接触的Ormer接口

?

1 2 3

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

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

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

type Ormer interface {

• Read(interface{}, …string) error
• ReadOrCreate(interface{}, string, …string) (bool, int64, error)
• Insert(interface{}) (int64, error)
• InsertMulti(int, interface{}) (int64, error)
• Update(interface{}, …string) (int64, error)
• Delete(interface{}) (int64, error)
• LoadRelated(interface{}, string, …interface{}) (int64, error)
• QueryM2M(interface{}, string) QueryM2Mer
• QueryTable(interface{}) QuerySeter
• Using(string) error
• Begin() error
• Commit() error
• Rollback() error
• Raw(string, …interface{}) RawSeter
• Driver() Driver

}

 

QueryTable

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

?

1 2 3 4

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

　　

Using

切换为其它数据库

?

1 2 3 4 5 6 7 8 9 10 11

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

默认使用default数据库，需要调用Using。

 

Raw

使用sql语句直接进行操作

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

?

1 2 3

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

　　

Driver

返回当前ORM使用的db信息

?

1 2 3 4

type Driver interface {     Name() string     Type() DriverType }

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14

orm.RegisterDataBase("db1", "mysql", "root:root@/orm_db2?charset=utf8") orm.RegisterDataBase("db2", "sqlite3", "data.db")   o1 := orm.NewOrm() o1.Using("db1") dr := o1.Driver() fmt.Println(dr.Name() == "db1") // true fmt.Println(dr.Type() == orm.DRMySQL) // true   o2 := orm.NewOrm() o2.Using("db2") dr = o2.Driver() fmt.Println(dr.Name() == "db2") // true fmt.Println(dr.Type() == orm.DRSqlite) // true

　　

四、调试模式打印查询语句

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

?

1	orm.Debug = true

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

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

?

1 2 3 4 5

var w io.Writer ... // 设置为你的 io.Writer ... orm.DebugLog = orm.NewLog(w)

　

日志格式

?

1	[ORM] - 时间 - [Queries/数据库名] - [执行操作/执行时间] - [SQL语句] - 使用标点 `,` 分隔的参数列表 - 打印遇到的错误

输出示例：

?

1 2 3 4 5 6 7 8

[ORM] - 2013-08-09 13:18:16 - [Queries/default] - [    db.Exec /     0.4ms] - [INSERT INTO `user` (`name`) VALUES (?)] - `slene` [ORM] - 2013-08-09 13:18:16 - [Queries/default] - [    db.Exec /     0.5ms] - [UPDATE `user` SET `name` = ? WHERE `id` = ?] - `astaxie`, `14` [ORM] - 2013-08-09 13:18:16 - [Queries/default] - [db.QueryRow /     0.4ms] - [SELECT `id`, `name` FROM `user` WHERE `id` = ?] - `14` [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` [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` [ORM] - 2013-08-09 13:18:16 - [Queries/default] - [    db.Exec /     0.4ms] - [DELETE FROM `user` WHERE `id` = ?] - `14` [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` [ORM] - 2013-08-09 13:18:16 - [Queries/default] - [    db.Exec /     0.4ms] - [DELETE FROM `post` WHERE `id` IN (?)] - `68`

日志内容包括所有的数据库操作，事务，prepare等。