250 lines
9.1 KiB
Markdown
250 lines
9.1 KiB
Markdown
# 5.5 使用beedb库进行ORM开发
|
||
beedb是我开发的一个Go进行ORM操作的库，它采用了Go style方式对数据库进行操作，实现了struct到数据表记录的映射。beedb是一个十分轻量级的Go ORM框架，开发这个库的本意降低复杂的ORM学习曲线，尽可能在ORM的运行效率和功能之间寻求一个平衡，beedb是目前开源的Go ORM框架中实现比较完整的一个库，而且运行效率相当不错，功能也基本能满足需求。但是目前还不支持关系关联，这个是接下来版本升级的重点。
|
||
|
||
beedb是支持database/sql标准接口的ORM库，所以理论上来说，只要数据库驱动支持database/sql接口就可以无缝的接入beedb。目前我测试过的驱动包括下面几个：
|
||
|
||
Mysql:github.com/ziutek/mymysql/godrv[*]
|
||
|
||
Mysql:code.google.com/p/go-mysql-driver[*]
|
||
|
||
PostgreSQL:github.com/bmizerany/pq[*]
|
||
|
||
SQLite:github.com/mattn/go-sqlite3[*]
|
||
|
||
MS ADODB: github.com/mattn/go-adodb[*]
|
||
|
||
ODBC: bitbucket.org/miquella/mgodbc[*]
|
||
|
||
## 安装
|
||
|
||
beedb支持go get方式安装，是完全按照Go Style的方式来实现的。
|
||
|
||
go get github.com/astaxie/beedb
|
||
|
||
## 如何初始化
|
||
首先你需要import相应的数据库驱动包、database/sql标准接口包以及beedb包，如下所示：
|
||
|
||
import (
|
||
"database/sql"
|
||
"github.com/astaxie/beedb"
|
||
_ "github.com/ziutek/mymysql/godrv"
|
||
)
|
||
|
||
导入必须的package之后,我们需要打开到数据库的链接，然后创建一个beedb对象（以MySQL为例)，如下所示
|
||
|
||
db, err := sql.Open("mymysql", "test/xiemengjun/123456")
|
||
if err != nil {
|
||
panic(err)
|
||
}
|
||
orm := beedb.New(db)
|
||
|
||
beedb的New函数实际上应该有两个参数，第一个参数标准接口的db，第二个参数是使用的数据库引擎，如果你使用的数据库引擎是MySQL/Sqlite,那么第二个参数都可以省略。
|
||
|
||
如果你使用的数据库是SQLServer，那么初始化需要：
|
||
|
||
orm = beedb.New(db, "mssql")
|
||
|
||
如果你使用了PostgreSQL，那么初始化需要：
|
||
|
||
orm = beedb.New(db, "pg")
|
||
|
||
目前beedb支持打印调试，你可以通过如下的代码实现调试
|
||
|
||
beedb.OnDebug=true
|
||
|
||
接下来我们的例子采用前面的数据库表Userinfo，现在我们建立相应的struct
|
||
|
||
type Userinfo struct {
|
||
Uid int `PK` //如果表的主键不是id，那么需要加上pk注释，显式的说这个字段是主键
|
||
Username string
|
||
Departname string
|
||
Created time.Time
|
||
}
|
||
|
||
>注意一点，beedb针对驼峰命名会自动帮你转化成下划线字段，例如你定义了Struct名字为`UserInfo`，那么转化成底层实现的时候是`user_info`，字段命名也遵循该规则。
|
||
|
||
## 插入数据
|
||
下面的代码演示了如何插入一条记录，可以看到我们操作的是struct对象，而不是原生的sql语句，最后通过调用Save接口将数据保存到数据库。
|
||
|
||
var saveone Userinfo
|
||
saveone.Username = "Test Add User"
|
||
saveone.Departname = "Test Add Departname"
|
||
saveone.Created = time.Now()
|
||
orm.Save(&saveone)
|
||
|
||
我们看到插入之后`saveone.Uid`就是插入成功之后的自增ID。Save接口会自动帮你存进去。
|
||
|
||
beedb接口提供了另外一种插入的方式，map数据插入。
|
||
|
||
add := make(map[string]interface{})
|
||
add["username"] = "astaxie"
|
||
add["departname"] = "cloud develop"
|
||
add["created"] = "2012-12-02"
|
||
orm.SetTable("userinfo").Insert(add)
|
||
|
||
插入多条数据
|
||
|
||
addslice := make([]map[string]interface{}, 0)
|
||
add:=make(map[string]interface{})
|
||
add2:=make(map[string]interface{})
|
||
add["username"] = "astaxie"
|
||
add["departname"] = "cloud develop"
|
||
add["created"] = "2012-12-02"
|
||
add2["username"] = "astaxie2"
|
||
add2["departname"] = "cloud develop2"
|
||
add2["created"] = "2012-12-02"
|
||
addslice =append(addslice, add, add2)
|
||
orm.SetTable("userinfo").InsertBatch(addslice)
|
||
|
||
上面的操作方式有点类似链式查询，熟悉jquery的同学应该会觉得很亲切，每次调用的method都会返回原orm对象，以便可以继续调用该对象上的其他method。
|
||
|
||
上面我们调用的SetTable函数是显式的告诉ORM，我要执行的这个map对应的数据库表是`userinfo`。
|
||
|
||
## 更新数据
|
||
继续上面的例子来演示更新操作，现在saveone的主键已经有值了，此时调用save接口，beedb内部会自动调用update以进行数据的更新而非插入操作。
|
||
|
||
saveone.Username = "Update Username"
|
||
saveone.Departname = "Update Departname"
|
||
saveone.Created = time.Now()
|
||
orm.Save(&saveone) //现在saveone有了主键值，就执行更新操作
|
||
|
||
更新数据也支持直接使用map操作
|
||
|
||
t := make(map[string]interface{})
|
||
t["username"] = "astaxie"
|
||
orm.SetTable("userinfo").SetPK("uid").Where(2).Update(t)
|
||
|
||
这里我们调用了几个beedb的函数
|
||
|
||
SetPK：显式的告诉ORM，数据库表`userinfo`的主键是`uid`。
|
||
|
||
Where:用来设置条件，支持多个参数，第一个参数如果为整数，相当于调用了Where("主键=?",值)。
|
||
Updata函数接收map类型的数据，执行更新数据。
|
||
|
||
## 查询数据
|
||
beedb的查询接口比较灵活，具体使用请看下面的例子
|
||
|
||
例子1，根据主键获取数据：
|
||
|
||
var user Userinfo
|
||
//Where接受两个参数，支持整形参数
|
||
orm.Where("uid=?", 27).Find(&user)
|
||
|
||
|
||
例子2：
|
||
|
||
var user2 Userinfo
|
||
orm.Where(3).Find(&user2) // 这是上面版本的缩写版，可以省略主键
|
||
|
||
例子3，不是主键类型的的条件：
|
||
|
||
var user3 Userinfo
|
||
//Where接受两个参数，支持字符型的参数
|
||
orm.Where("name = ?", "john").Find(&user3)
|
||
例子4，更加复杂的条件：
|
||
|
||
var user4 Userinfo
|
||
//Where支持三个参数
|
||
orm.Where("name = ? and age < ?", "john", 88).Find(&user4)
|
||
|
||
|
||
可以通过如下接口获取多条数据，请看示例
|
||
|
||
例子1，根据条件id>3，获取20位置开始的10条数据的数据
|
||
|
||
var allusers []Userinfo
|
||
err := orm.Where("id > ?", "3").Limit(10,20).FindAll(&allusers)
|
||
|
||
例子2，省略limit第二个参数，默认从0开始，获取10条数据
|
||
|
||
var tenusers []Userinfo
|
||
err := orm.Where("id > ?", "3").Limit(10).FindAll(&tenusers)
|
||
|
||
例子3，获取全部数据
|
||
|
||
var everyone []Userinfo
|
||
err := orm.OrderBy("uid desc,username asc").FindAll(&everyone)
|
||
|
||
上面这些里面里面我们看到一个函数Limit，他是用来控制查询结构条数的。
|
||
|
||
Limit:支持两个参数，第一个参数表示查询的条数，第二个参数表示读取数据的起始位置，默认为0。
|
||
|
||
OrderBy:这个函数用来进行查询排序，参数是需要排序的条件。
|
||
|
||
上面这些例子都是将获取的的数据直接映射成struct对象，如果我们只是想获取一些数据到map，以下方式可以实现：
|
||
|
||
a, _ := orm.SetTable("userinfo").SetPK("uid").Where(2).Select("uid,username").FindMap()
|
||
|
||
上面和这个例子里面又出现了一个新的接口函数Select，这个函数用来指定需要查询多少个字段。默认为全部字段`*`。
|
||
|
||
FindMap()函数返回的是`[]map[string][]byte`类型，所以你需要自己作类型转换。
|
||
|
||
## 删除数据
|
||
beedb提供了丰富的删除数据接口，请看下面的例子
|
||
|
||
例子1，删除单条数据
|
||
|
||
//saveone就是上面示例中的那个saveone
|
||
orm.Delete(&saveone)
|
||
|
||
例子2，删除多条数据
|
||
|
||
//alluser就是上面定义的获取多条数据的slice
|
||
orm.DeleteAll(&alluser)
|
||
|
||
例子3，根据sql删除数据
|
||
|
||
orm.SetTable("userinfo").Where("uid>?", 3).DeleteRow()
|
||
|
||
|
||
## 关联查询
|
||
目前beedb还不支持struct的关联关系，但是有些应用却需要用到连接查询，所以现在beedb提供了一个简陋的实现方案：
|
||
|
||
a, _ := orm.SetTable("userinfo").Join("LEFT", "userdeatail", "userinfo.uid=userdeatail.uid").Where("userinfo.uid=?", 1).Select("userinfo.uid,userinfo.username,userdeatail.profile").FindMap()
|
||
|
||
上面代码中我们看到了一个新的接口Join函数，这个函数带有三个参数
|
||
|
||
- 第一个参数可以是：INNER, LEFT, OUTER, CROSS等
|
||
- 第二个参数表示连接的表
|
||
- 第三个参数表示连接的条件
|
||
|
||
|
||
## Group By和Having
|
||
针对有些应用需要用到group by和having的功能，beedb也提供了一个简陋的实现
|
||
|
||
a, _ := orm.SetTable("userinfo").GroupBy("username").Having("username='astaxie'").FindMap()
|
||
|
||
上面的代码中出现了两个新接口函数
|
||
|
||
GroupBy:用来指定进行groupby的字段
|
||
|
||
Having:用来指定having执行的时候的条件
|
||
|
||
## 进一步的发展
|
||
目前beedb已经获得了很多来自国内外用户的反馈，我目前也正在考虑重构，接下来会在几个方面进行改进
|
||
|
||
- 实现interface设计，类似databse/sql/driver的设计，设计beedb的接口，然后去实现相应数据库的CRUD操作
|
||
- 实现关联数据库设计，支持一对一，一对多，多对多的实现，示例代码如下：
|
||
|
||
|
||
type Profile struct{
|
||
Nickname string
|
||
Mobile string
|
||
}
|
||
|
||
type Userinfo struct {
|
||
Uid int `PK`
|
||
Username string
|
||
Departname string
|
||
Created time.Time
|
||
Profile `HasOne`
|
||
}
|
||
|
||
- 自动建库建表建索引
|
||
- 实现连接池的实现，采用goroutine
|
||
|
||
## links
|
||
* [目录](<preface.md>)
|
||
* 上一节: [使用PostgreSQL数据库](<05.4.md>)
|
||
* 下一节: [NOSQL数据库操作](<05.6.md>)
|