模型(Models)- beego ORM

beego ORM 包是一个强大的 Go 语言 ORM 框架,她的灵感主要来自 Django ORM 和 SQLAlchemy。
其主要是处理MVC中的M(model)层,完成对数据库的操作。

SofTool.CN Notes:

  • ORM = Object Relationship Mapping
  • Django 是一个由 Python 编写的一个开放源代码的 Web 应用框架。
    使用 Django,只要很少的代码,Python 的程序开发人员就可以轻松地完成一个正式网站所需要的大部分内容,并进一步开发出全功能的 Web 服务 Django 本身基于 MVC 模型,即 Model(模型)+ View(视图)+ Controller(控制器)设计模式,MVC 模式使后续对程序的修改和扩展简化,并且使程序某一部分的重复利用成为可能。
  • SQLAlchemy 是 Python SQL 工具包和对象关系映射器。
    //python 英[‘paɪθən] ;美[‘paɪθɑːn]
    //alchemy 英[ˈælkəmi] n. 炼金术; (改变事物的)神秘力量,魔力;
    它是python中最著名的ORM框架,它简化了应用程序开发人员在原生SQL上的操作,使开发人员将主要精力都放在程序逻辑上,从而提高开发效率。它提供了一整套著名的企业级持久性模式,设计用于高效和高性能的数据库访问。

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

已支持数据库驱动:

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

以上数据库驱动均通过基本测试,但我们仍需要您的反馈。

ORM 特性:

  • 支持 Go 的所有类型存储
  • 轻松上手,采用简单的 CRUD 风格

    什么是CRUD? 详见:https://www.softool.cn/blog-193.html

  • 自动 Join 关联表
  • 跨数据库兼容查询
  • 允许直接使用 SQL 查询/映射
  • 严格完整的测试保证 ORM 的稳定与健壮

更多特性请在文档中自行品读。

安装 ORM:

go get github.com/astaxie/beego/orm

修改日志:

  • 2016-01-18: 规范了数据库驱动的命名

  • 2014-03-10: GetDB 从注册的数据库中返回 *sql.DB. ResetModelCache 重置已注册的模型struct

  • 2014-02-10: 随着 beego1.1.0 的发布提交的改进
    – 关于 时区设置
    – 新增的 api:
    Ormer.InsertMulti
    Ormer.ReadOrCreate
    RawSeter.RowsToMap
    RawSeter.RowsToStruct
    orm.NewOrmWithDB
    – 改进的 api:
    RawSeter.Values 支持设置 columns
    RawSeter.ValuesList 支持设置 columns
    RawSeter.ValuesFlat 支持设置 column
    RawSeter.QueryRow/QueryRows 从对应每个strcut field位置的赋值,改为对应名称取值(不需要对应好字段数量与位置)

  • 2013-10-14: 自动载入关系字段,多对多关系操作,完善关系查询

  • 2013-10-09: 原子操作更新值

  • 2013-09-22: RegisterDataBase maxIdle / maxConn 设置为可选参数, MySQL 自定义引擎

  • 2013-09-16: 支持设置 空闲链接数 和 最大链接数 SetMaxIdleConns / SetMaxOpenConns

  • 2013-09-12: Read 支持设定条件字段 Update / All / One 支持设定返回字段

  • 2013-09-09: Raw SQL QueryRow/QueryRows 功能完成

  • 2013-08-27: 自动建表继续改进

  • 2013-08-19: 自动建表功能完成

  • 2013-08-13: 更新数据库类型测试

  • 2013-08-13: 增加 Go 类型支持,包括 int8、uint8、byte、rune 等

  • 2013-08-13: 增强 date/datetime 的时区支持

快速入门

简单示例

package main

import (
    "fmt"
    "github.com/astaxie/beego/orm"
    // import 下划线的作用:当导入一个包时,该包下的文件里所有 init() 函数都会被执行,但有时我们并不需要把整个包都导进来,只希望它执行 init() 函数而已。这个时候就可以使用 import _ 引用该包了。
    _ "github.com/go-sql-driver/mysql" // import your used driver
)

// Model Struct
//定义名为 User 的数据模型结构:
type User struct {
    Id   int
    Name string `orm:"size(100)"`
}

func init() {
    // set default database
    //设置默认的数据库,该数据库名为 default:
    orm.RegisterDataBase("default", "mysql", "username:password@tcp(127.0.0.1:3306)/db_name?charset=utf8", 30)
    // register model
    //注册User数据模型:
    orm.RegisterModel(new(User))
    // create table
    //创建一个名为 default的表
    orm.RunSyncdb("default", false, true)
}

func main() {
    o := orm.NewOrm()
    //实例化一个名为 user 模型对象,其 Name字段对应的值为 slene :
    user := User{Name: "slene"}
    // insert
    id, err := o.Insert(&user)
    fmt.Printf("ID: %d, ERR: %v\n", id, err)
    // 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)
}

关联查询

type Post struct {
    Id    int    `orm:"auto"`
    Title string `orm:"size(100)"`
    User  *User  `orm:"rel(fk)"`
}

var posts []*Post
qs := o.QueryTable("post")
num, err := qs.Filter("User__Name", "slene").All(&posts)

SQL 查询

当您无法使用 ORM 来达到您的需求时,也可以直接使用 SQL 语句来完成查询/映射操作。

var maps []orm.Params
//将查询的所有结果放到 maps[] 中:
num, err := o.Raw("SELECT * FROM user").Values(&maps)
//遍历 maps 中的每条记录:
for _,term := range maps{
    fmt.Println(term["id"],":",term["name"])
}

事务处理

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

调试查询日志

在开发环境下,您可以使用以下指令来开启查询调试模式:

func main() {
    //开启查询调试模式:
    orm.Debug = true
...

开启后将会输出所有查询语句,包括执行、准备、事务等,例如:

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

注意:我们不建议您在部署产品后继续开启调试模式。