beego的ORM使用

beego/orm 的使用例子

后文例子如無特殊說明都以這個為基礎(chǔ)。

models.go:

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)"` // 設(shè)置一對多的反向關(guān)系
}

type Profile struct {
    Id          int
    Age         int16
    User        *User   `orm:"reverse(one)"` // 設(shè)置一對一反向關(guān)系(可選)
}

type Post struct {
    Id    int
    Title string
    User  *User  `orm:"rel(fk)"`    //設(shè)置一對多關(guān)系
    Tags  []*Tag `orm:"rel(m2m)"`
}

type Tag struct {
    Id    int
    Name  string
    Posts []*Post `orm:"reverse(many)"` //設(shè)置多對多反向關(guān)系
}

func init() {
    // 需要在init中注冊定義的model
    orm.RegisterModel(new(User), new(Post), new(Profile), new(Tag))
}

main.go

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，你可以指定為其他數(shù)據(jù)庫

    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))
}

數(shù)據(jù)庫的設(shè)置

目前 ORM 支持三種數(shù)據(jù)庫，以下為測試過的 driver

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

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

RegisterDriver

三種默認數(shù)據(jù)庫類型

// For version 1.6
orm.DRMySQL
orm.DRSqlite
orm.DRPostgres

// < 1.6
orm.DR_MySQL
orm.DR_Sqlite
orm.DR_Postgres

// 參數(shù)1   driverName
// 參數(shù)2   數(shù)據(jù)庫類型
// 這個用來設(shè)置 driverName 對應(yīng)的數(shù)據(jù)庫類型
// mysql / sqlite3 / postgres 這三種是默認已經(jīng)注冊過的，所以可以無需設(shè)置
orm.RegisterDriver("mysql", orm.DRMySQL)

RegisterDataBase

ORM 必須注冊一個別名為 default 的數(shù)據(jù)庫，作為默認使用。

ORM 使用 golang 自己的連接池

// 參數(shù)1        數(shù)據(jù)庫的別名，用來在 ORM 中切換數(shù)據(jù)庫使用
// 參數(shù)2        driverName
// 參數(shù)3        對應(yīng)的鏈接字符串
orm.RegisterDataBase("default", "mysql", "root:root@/orm_test?charset=utf8")

// 參數(shù)4(可選)  設(shè)置最大空閑連接
// 參數(shù)5(可選)  設(shè)置最大數(shù)據(jù)庫連接 (go >= 1.2)
maxIdle := 30
maxConn := 30
orm.RegisterDataBase("default", "mysql", "root:root@/orm_test?charset=utf8", maxIdle, maxConn)

SetMaxIdleConns

根據(jù)數(shù)據(jù)庫的別名，設(shè)置數(shù)據(jù)庫的最大空閑連接

orm.SetMaxIdleConns("default", 30)

SetMaxOpenConns

根據(jù)數(shù)據(jù)庫的別名，設(shè)置數(shù)據(jù)庫的最大數(shù)據(jù)庫連接 (go >= 1.2)

orm.SetMaxOpenConns("default", 30)

時區(qū)設(shè)置

ORM 默認使用 time.Local 本地時區(qū)

• 作用于 ORM 自動創(chuàng)建的時間
• 從數(shù)據(jù)庫中取回的時間轉(zhuǎn)換成 ORM 本地時間

如果需要的話，你也可以進行更改

// 設(shè)置為 UTC 時間
orm.DefaultTimeLoc = time.UTC

ORM 在進行 RegisterDataBase 的同時，會獲取數(shù)據(jù)庫使用的時區(qū)，然后在 time.Time 類型存取時做相應(yīng)轉(zhuǎn)換，以匹配時間系統(tǒng)，從而保證時間不會出錯。

注意:

• 鑒于 Sqlite3 的設(shè)計，存取默認都為 UTC 時間
• 使用 go-sql-driver 驅(qū)動時，請注意參數(shù)設(shè)置 從某一版本開始，驅(qū)動默認使用 UTC 時間，而非本地時間，所以請指定時區(qū)參數(shù)或者全部以 UTC 時間存取 例如：root:root@/orm_test?charset=utf8&loc=Asia%2FShanghai 參見 loc / parseTime

注冊模型

如果使用 orm.QuerySeter 進行高級查詢的話，這個是必須的。

反之，如果只使用 Raw 查詢和 map struct，是無需這一步的。您可以去查看 Raw SQL 查詢

RegisterModel

將你定義的 Model 進行注冊，最佳設(shè)計是有單獨的 models.go 文件，在他的 init 函數(shù)中進行注冊。

迷你版 models.go

package main

import "github.com/astaxie/beego/orm"

type User struct {
    Id   int
    Name string
}

func init(){
    orm.RegisterModel(new(User))
}

RegisterModel 也可以同時注冊多個 model

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

詳細的 struct 定義請查看文檔 模型定義

RegisterModelWithPrefix

使用表名前綴

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

創(chuàng)建后的表名為 prefix_user

NewOrmWithDB

有時候需要自行管理連接池與數(shù)據(jù)庫鏈接（比如：go 的鏈接池?zé)o法讓兩次查詢使用同一個鏈接的）

但又想使用 ORM 的查詢功能

var driverName, aliasName string
// driverName 是驅(qū)動的名稱
// aliasName 是當(dāng)前 db 的自定義別名
var db *sql.DB
...
o := orm.NewOrmWithDB(driverName, aliasName, db)

GetDB

從已注冊的數(shù)據(jù)庫返回 *sql.DB 對象，默認返回別名為 default 的數(shù)據(jù)庫。

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

重置已經(jīng)注冊的模型 struct，一般用于編寫測試用例

orm.ResetModelCache()

ORM 接口使用

使用 ORM 必然接觸的 Ormer 接口，我們來熟悉一下

var o orm.Ormer
o = orm.NewOrm() // 創(chuàng)建一個 Ormer
// NewOrm 的同時會執(zhí)行 orm.BootStrap (整個 app 只執(zhí)行一次)，用以驗證模型之間的定義并緩存。

切換數(shù)據(jù)庫，或者，進行事務(wù)處理，都會作用于這個 Ormer 對象，以及其進行的任何查詢。

所以：需要 切換數(shù)據(jù)庫 和 事務(wù)處理 的話，不要使用全局保存的 Ormer 對象。

• type Ormer interface {Read(interface{}, ...string) errorReadOrCreate(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) QueryM2MerQueryTable(interface{}) QuerySeterUsing(string) errorBegin() errorCommit() errorRollback() errorRaw(string, ...interface{}) RawSeterDriver() Driver
• }

QueryTable

傳入表名，或者 Model 對象，返回一個 QuerySeter

o := orm.NewOrm()
var qs orm.QuerySeter
qs = o.QueryTable("user")
// 如果表沒有定義過，會立刻 panic

Using

切換為其他數(shù)據(jù)庫

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")

// 切換為其他數(shù)據(jù)庫以后
// 這個 Ormer 對象的其下的 api 調(diào)用都將使用這個數(shù)據(jù)庫

默認使用 default 數(shù)據(jù)庫，無需調(diào)用 Using

Raw

使用 sql 語句直接進行操作

Raw 函數(shù)，返回一個 RawSeter 用以對設(shè)置的 sql 語句和參數(shù)進行操作

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

Driver

返回當(dāng)前 ORM 使用的 db 信息

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

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

調(diào)試模式打印查詢語句

簡單的設(shè)置 Debug 為 true 打印查詢的語句

可能存在性能問題，不建議使用在生產(chǎn)模式

func main() {
    orm.Debug = true
...

默認使用 os.Stderr 輸出日志信息

改變輸出到你自己的 io.Writer

var w io.Writer
...
// 設(shè)置為你的 io.Writer
...
orm.DebugLog = orm.NewLog(w)

日志格式

[ORM] - 時間 - [Queries/數(shù)據(jù)庫名] - [執(zhí)行操作/執(zhí)行時間] - [SQL語句] - 使用標點 `,` 分隔的參數(shù)列表 - 打印遇到的錯誤

[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`

日志內(nèi)容包括 所有的數(shù)據(jù)庫操作，事務(wù)，Prepare，等