Beego --- Orm

0. 基本介绍

beego ORM 是一个强大的 Go 语言 ORM 框架。她的灵感主要来自 Django ORM 和 SQLAlchemy。

目前该框架仍处于开发阶段，可能发生任何导致不兼容的改动。

已支持数据库驱动：

MySQL：github.com/go-sql-driver/mysql
PostgreSQL：github.com/lib/pq
Sqlite3：github.com/mattn/go-sqlite3

ORM 特性：

支持 Go 的所有类型存储
轻松上手，采用简单的 CRUD 风格
自动 Join 关联表
跨数据库兼容查询
允许直接使用 SQL 查询／映射
严格完整的测试保证 ORM 的稳定与健壮

1. 模块下载

go get github.com/astaxie/beego/orm

2. 基础设置

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

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

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

1. 驱动

三种默认数据库类型

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

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

// 参数1   driverName
// 参数2   数据库类型
// 这个用来设置 driverName 对应的数据库类型
// mysql / sqlite3 / postgres 这三种是默认已经注册过的，所以可以无需设置
orm.RegisterDriver("mysql", orm.DRMySQL)

2. 注册数据库

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

ORM 使用 golang 自己的连接池

// 参数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)

3. 最大空闲连接

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

orm.SetMaxIdleConns("default", 30)

4. 最大连接数

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

orm.SetMaxOpenConns("default", 30)

5. 时区

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

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

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

// 设置为 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 参见 loc / parseTime

3. 常用 API

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

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
}

8.1 QueryTable

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

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

8.2 Using

切换为其他数据库

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

8.3 Raw

使用 sql 语句直接进行操作

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

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

8.4 Driver

返回当前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

4. 创建模型

建表的字段属性限制

int类型

Id int `orm:"pk;auto"`  // 主键并自增
Gender int `orm:"default(1)"` // 默认值为1

时间类型

CreateTime time.Time `orm:"auto_now_add;type(datatime)"`   // auto_now_add 第一次保存时才设置时间
ChangeTime time.Time `orm:"auto_now;type(date)"` // date类型时间,auto_now表示每次model保存时都会对时间自动更新

字符串类型

Name string `orm:"size(10);null"`  // 最大长度,null表示可以为空,默认所有字段不允许为空

浮点数类型

Money float `orm:"digits(12);decimals(4)"` // 总长度为12,小数部分为4

5. 注册模型

如果使用 orm.QuerySeter 进行高级查询的话，这个是必须的。反之，如果只使用 Raw 查询和 map struct，是无需这一步的。您可以去查看 Raw SQL 查询

7.1 RegisterModel

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

迷你版 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 定义请查看文档模型定义

7.2 RegisterModelWithPrefix

使用表名前缀

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

创建后的表名为 prefix_user

7.3 NewOrmWithDB

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

但又想使用 ORM 的查询功能

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

7.4 GetDB

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

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

7.5 ResetModelCache

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

orm.ResetModelCache()

6. 单表

1. 模型创建

package main

import (
    "fmt"
    "github.com/astaxie/beego/orm"
    _ "github.com/go-sql-driver/mysql" // import your used driver
)

// Model Struct
type User struct {
    Id   int
    Name string `orm:"size(100)"`
}

func init() {
    // set default database
    orm.RegisterDataBase("default", "mysql", "username:password@tcp(127.0.0.1:3306)/db_name?charset=utf8", 30)

    // register model
    orm.RegisterModel(new(User))

    // create table
    orm.RunSyncdb("default", false, true)
}

2. 新增

func main() {
    o := orm.NewOrm()

    user := User{Name: "slene"}
    // insert
    id, err := o.Insert(&user)
    fmt.Printf("ID: %d, ERR: %v\n", id, err)
}

3. 更新

func main() {
    o := orm.NewOrm()
    
    // 需要更新的那行数据,将其Name 给成astaxie
    user := User{Id:2}
    // update
    user.Name = "astaxie"
    num, err := o.Update(&user)
    fmt.Printf("NUM: %d, ERR: %v\n", num, err)
}

    // read one
    u := User{Id: user.Id}
    err = o.Read(&u)
    fmt.Printf("ERR: %v\n", err)

    // delete
    num, err = o.Delete(&u)
    fmt.Printf("NUM: %d, ERR: %v\n", num, err)

3. 查询

func main(){
    u := models.User{Id: 2}
    err := o.Read(&u)
    if err != nil{
        fmt.Println(err)
    }else {
          fmt.Println(&u)
          this.Ctx.WriteString("查询到的数据")
    }
}

4. 删除

func main(){
    u := models.User{Id: 2}
    num,err := o.Delete(&u)
    if err != nil{
          fmt.Println(err)
    }else{
          if num == 1{
	      this.Ctx.WriteString("删除成功")
          }
          this.Ctx.WriteString("ID 不存在 或 已被删除")
}
}

7. 一对多

1. 模型创建

type User struct {
	Id int
	Name string `orm:"size(100)"`
}

type Post struct {
	Id    int    `orm:"auto"`
	Title string `orm:"size(100)"`
	User  *User  `orm:"rel(fk)"`  // 创建关联关系表
}

将Post 模型注册到ORM模型中

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

2. 查询

func main(){
    o := orm.NewOrm()
    var posts []*models.Post
    qs := o.QueryTable("post")
    num,err := qs.Filter("User__Name","tom").All(&posts)
    for _,v := range posts{
	fmt.Println(v.User.Id)
    }
    if err != nil{
    	fmt.Println("查询错误")
    }else {
	fmt.Println(num)
	fmt.Println(posts)
	this.Ctx.WriteString("查询成功")
}

}

8. 多对多

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)"` // 设置一对多的反向关系
}

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

9. 事务

o.Begin()
...
user := User{Name: "slene"}
id, err := o.Insert(&user)
if err == nil {
    o.Commit()
} else {
    o.Rollback()
}

10. 调试模式打印查询语句

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

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

func init() {
    orm.Debug = true
...
}

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

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

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

日志格式

开启后将会输出所有查询语句，包括执行、准备、事务等。

例如：

[ORM] - 2013-08-09 13:18:16 - [Queries/default] - [    db.Exec /     0.4ms] -     [INSERT INTO `user` (`name`) VALUES (?)] - `slene`
...

注意：我们不建议您在部署产品后这样做。

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

posted @ 2024-09-19 17:26 河图s 阅读(105) 评论(0) 收藏举报

刷新页面返回顶部

河图

Beego --- Orm

0. 基本介绍

1. 模块下载

2. 基础设置

1. 驱动

2. 注册数据库

3. 最大空闲连接

4. 最大连接数

5. 时区

3. 常用 API

8.1 QueryTable

8.2 Using

8.3 Raw

8.4 Driver

4. 创建模型

建表的字段属性限制

int类型

时间类型

字符串类型

浮点数类型

5. 注册模型

7.1 RegisterModel

7.2 RegisterModelWithPrefix

7.3 NewOrmWithDB

7.4 GetDB

7.5 ResetModelCache

6. 单表

1. 模型 创建

2. 新增

3. 更新

3. 查询

4. 删除

7. 一对多

1. 模型创建

2. 查询

8. 多对多

9. 事务

10. 调试模式打印查询语句

公告

1. 模型创建