Go语言ORM框架：按需选择字段

介绍

worm是一款方便易用的Go语言ORM库，worm具有使用简单，运行性能高，功能强大的特点。具体特征如下：

• 通过Struct的Tag与数据库字段进行映射，让您免于经常拼写SQL的麻烦。
• 支持Struct映射、原生SQL以及SQLBuilder三种模式来操作数据库，并且Struct映射、原生SQL以及SQLBuilder可混合使用。
• Struct映射、SQL builder支持链式API，可使用Where, And, Or, ID, In, Limit, GroupBy, OrderBy, Having等函数构造查询条件。
• 可通过Join、LeftJoin、RightJoin来进行数据库表之间的关联查询。
• 支持事务支持，可在会话中开启事务，在事务中可以混用Struct映射、原生SQL以及SQL builder来操作数据库。
• 支持预编译模式访问数据库，会话开启预编译模式后，任何SQL都会使用缓存的Statement，可以提升数据库访问效率。
• 支持使用数据库的读写分离模式来访问一组数据库。
• 支持在Insert，Update，Delete，Get, Find操作中使用钩子方法。
• 支持SQL日志的输出，并且可通过日志钩子自定义SQL日志的输出，日志钩子支持Context。
• 可根据数据库自动生成库表对应的Model结构体。

目前worm支持的数据库有：mysql、postgres、sqlite、sqlserver。

代码获取

go get github.com/haming123/wego/worm

使用select方法指定字段

使用worm.Model().Update()方法来更新数据库时，则worm缺省会更新实体类对应的全部字段。若只希望更新指定的字段，可以使用若Select方法指定需要更新的字段：

func demoModelUpdate() {
    var user = User{Name:"name1", Age: 21, Created: time.Now()}
    _, err := worm.Model(&user).Select("name", "age").ID(1).Update()
    if err != nil{
        log.Println(err)
        return
    }
}
//update users set name=?,age=? where id=?

基于编辑状态来更新数据库

Select方法虽然能够做到按需更新，但是若库表的字段比较多，这种方法使用起来则比较麻烦，也容易引起错误（更新了不该更新的字段）。worm提供了一种基于编辑状态来更新数据库的方法：

• 首先创建实体类
• 接着Model对象，并将实体类指针传递给Model
• 然后使用SetValue方法逐个给字段赋值

• 最后调用Update()方法更新数据库

  func demoModelUpdateX() {
    var user = User{}
    md := worm.Model(&user)
    md.SetValue(&user.Name, "name2")
    md.SetValue(&user.Age, 22)
    _, err := md.ID(1).Update()
    if err != nil{
        log.Println(err)
        return
    }
  }
  //update users set name=?,age=? where id=?

  说明：

• 使用SetValue方法， 第一个参数必须是实体对象的字段的指针， 第二个对象的类型需要与字段类型一致。

通过Vo对象访问数据库

更加有效的方法是通过Vo对象来访问数据库。Vo对象只包含了需要使用的数据库字段，因此使用Vo对象来访问数据库可以减少数据库访问的负载，并能够减少数据更新时的错误（只更新必要字段）。 例如：

type UserVo struct {
    Id          int64       
    Name        string      
    Age         int64       
}

说明：

• 通常Vo结构提的字段与Model结构体的字段保持一致，并且不需要字段标签（tag：db）
• 若Vo结构提的字段与Model结构体的字段不一致， 需要实现：VoLoader接口或VoSaver接口

使用Vo添加数据库记录

有了Vo对象，您可以这样来查询数据库：

func insertUserVo() {
    var vo = UserVo{Age: 33, Name: "demo3"}
    id, err := worm.Model(&User{}).Insert(&vo)
    if err != nil{
        log.Error(err)
        return
    }
    log.Debug(id)
}
//insert into user set name=?,age=?

使用Vo更新数据库记录

func insertUserVo() {
    vo = UserVo{Age: 32, Name: "NameVo2"}
    _, err := worm.Model(&User{}).Update(&vo)
    if err != nil{
        log.Error(err)
        return
    }
}
//update user set name=?,age=? where id=?

使用查询单条记录到Vo

func demoGetVo() {
    var vo UserVo
    _, err := dbs.Model(&User{}).Where("id=?", 1).Get(&vo)
    if err != nil{
        log.Error(err)
        return
    }
}
//select id,name,age from user where id=1 limit 1

使用查询多条记录到Vo数组

func demoFindUserVo() {
    var arrvo []UserVo
    err := worm.Model(&User{}).WhereIn("id>?", 0).Find(&arrvo)
    if err != nil{
        log.Error(err)
        return
    }
}
//select id,name,age from user where id>?

使用VoLoader接口定义Vo数据查询逻辑

worm通过字段的名称+字段的类型把Vo对象与Model对象进行映射来选择Model的字段。若Vo对象与Model对象的字段名称不相同，您可为Vo对象实现VoLoader接口，VoLoader接口用于定义Vo如何从Model对象获取数据。

type VoLoader interface {
    LoadFromModel(md *DbModel, mo interface{})()
}

一个使用VoLoader接口的例子：

type UserVo struct {
    Id          int64
    UserName       string
    UserAge        int
}
func (vo *UserVo) LoadFromModel(md *worm.DbModel, mo_ptr interface{}) {
    if mo, ok := mo_ptr.(*User); ok {
        vo.Id = worm.GetInt64(md, &mo.Id)
        vo.UserName = worm.GetString(md, &mo.Name)
        vo.UserAge = worm.GetInt(md, &mo.Age)
    }
}
//使用UserVo查询数据库
var arr []UserVo
err := worm.Model(&User{}).Where("id>?", 0).Find(&arr)
//select id,name,age from user where id>?

使用VoSaver接口定义Vo数据存储逻辑

同样，您可为Vo对象实现VoSaver接口，VoSaver接口用于定义如何将Vo的值赋值给Model对象，并通过Model对象更新数据库。

type VoSaver interface {
    SaveToModel(md *DbModel, mo interface{})()
}

一个使用VoSaver接口的例子：

func (vo *UserVo) SaveToModel(md *worm.DbModel, mo_ptr interface{}) {
    if mo, ok := mo_ptr.(*User); ok {
        worm.SetValue(md, &mo.DB_id, vo.DB_id)
        worm.SetValue(md, &mo.DB_name, vo.DB_name)
        worm.SetValue(md, &mo.Age, vo.Age)
    }
}
//插入记录
vo := UserVo{UserAge: 31, UserName: "NameVo"}
id, err := worm.Model(&User{}).Insert(&vo)
//insert into user set name=?,age=?
//更新记录
vo = UserVo{UserAge: 32, UserName: "NameVo2"}
_, err = worm.Model(&User{}).ID(id).Update(&vo)
//update user set name=?,age=? where id=?