go-xorm入门教程

1. 创建Orm引擎

xorm支持同时存在多个orm引擎，一个引擎一般对应一个数据库，调用xorm.NewEngine(driverName, dataSourceName)方法创建引擎，示例如下：

package model

import (
	_ "github.com/go-sql-driver/mysql"
	"github.com/go-xorm/xorm"
	"github.com/micro/go-micro/util/log"
)

var engine *xorm.Engine

func init() {
	en, err := xorm.NewEngine("mysql", "root:123@/test?charset=utf8")
	if err != nil {
		log.Error("connect to database error")
		panic(err)
	}
	log.Info("connect success")
	engine = en
}

一般情况下，如果只操作一个数据库则创建一个engine即可，engine是GoRoutine安全的。engine创建完成后并没有立即连接数据库，此时可以通过engine.Ping()来进行数据库的连接测试。

2. 连接参数设置

	en.ShowSQL(true)
	en.SetMaxIdleConns(maxIdleConn)
	en.SetMaxOpenConns(maxOpenConn)

如果需要显示生成的SQL语句，可以通过engine.ShowSQL()来实现。
如果需要设置连接池的空闲数大小，可以使用engine.SetMaxIdleConns()来实现。
如果需要设置最大打开连接数，则可以使用engine.SetMaxOpenConns()来实现。

3. 名称映射规则

xorm由core.IMapper接口的实现者来管理映射规则，内置的三种IMapper实现为：core.SnakeMapper(默认)， core.SameMapper和core.GonicMapper。
如果需要改变时，在engine创建完成后使用

en.SetMapper(core.SameMapper{})

如果你使用了别的命名规则映射方案，也可以自己实现一个IMapper。
表名称和字段名称的映射规则默认是相同的，当然也可以设置为不同，如：

en.SetTableMapper(core.SameMapper{})
en.SetColumnMapper(core.SnakeMapper{})

如果表名和字段名与映射规则不匹配时可以通过如下方法进行修改：
如果表名与映射规则不一致，则可以修改结构体，如果结构体中包含TableName() string方法，那么此方法的返回值就是对应的数据库表名称；也可以在操作数据库时使用engine.Table()指定操作的数据库表。例如：

package model

import (
	"github.com/micro/go-micro/util/log"
)

type (
	User struct {
		Id int64 `xorm:"id"`
		Name string `xorm:"name"`
		Age int64 `xorm:"age"`
	}
)

func (User) TableName() string {
	//方法一：指定数据库表名称为users
	return "users"
}

func GetUserByName(name string) User {
	user := User{}
	//方法二：指定操作的表名称为users
	has, err := engine.Table("users").Where("name=?", name).Get(&user)
	if err != nil {
		log.Error("select user error:", err)
	}
	log.Info("res :", has)
	return user
}

如果字段名称与映射规则不同，则可以在定义结构体时通过xorm:"'column_name'"进行指定。（使用单引号防止名称冲突）
映射规则优先级为engin.Table()>TableName() string>IMapper

4. 字段属性定义

我们在field对应的Tag中对Column的一些属性进行定义，定义的方法基本和我们写SQL定义表结构类似，比如：

type User struct {
    Id   int64
    Name string  `xorm:"varchar(25) notnull unique 'usr_name'"`
}

注意：Tag中的关键字均不区分大小写，但字段名根据不同的数据库是区分大小写。详细规则参考：Go语言中文网

5. 表结构操作

通常在项目启动后我们需要对数据库进行同步，我们可以使用Sync或者Sync2(推荐)方法进行同步操作，使用方法为：

	err ：= en.Sync2(new(User))
	if err != nil {
		log.Error("sync table error : ", err)
		panic(err)
	}

Sync2对Sync进行了改进，目前推荐使用Sync2。Sync2函数将进行如下的同步操作：

• 自动检测和创建表，这个检测是根据表的名字
• 自动检测和新增表中的字段，这个检测是根据字段名，同时对表中多余的字段给出警告信息
• 自动检测，创建和删除索引和唯一索引，这个检测是根据索引的一个或多个字段名，而不根据索引名称。因此这里需要注意，如果在一个有大量数据的表中引入新的索引，数据库可能需要一定的时间来建立索引。
• 自动转换varchar字段类型到text字段类型，自动警告其它字段类型在模型和数据库之间不一致的情况。
• 自动警告字段的默认值，是否为空信息在模型和数据库之间不匹配的情况

以上这些警告信息需要将engine.ShowWarn 设置为 true 才会显示。
其他操作见：Go中文文档

6. 数据操作

插入：

var user User
engine.Insert(&user)

查询和统计主要使用Get, Find, Count, Rows, Iterate这几个方法

//设置表别名
engine.Alias("o").Where("o.name = ?", name).Get(&order)
//And和Where函数中的条件基本相同，作为条件
engine.Where(...).And(...).Get(&order)
//指定字段名正序排序Asc,逆序Desc
engine.Asc("id").Find(&orders)

//传入一个主键字段的值，作为查询条件，如SELECT * FROM user Where id = 1
var user User
engine.Id(1).Get(&user)
//复合主键SELECT * FROM user Where id =1 AND name= 'name'
engine.Id(core.PK{1, "name"}).Get(&user)
//in
engine.In("cloumn", 1, 2, 3).Find()
engine.In("column", []int{1, 2, 3}).Find()

//指定部分查询字段
engine.Select("a.*, (select name from b limit 1) as name").Find(&beans)
engine.Select("a.*, (select name from b limit 1) as name").Get(&bean)

//指定SQL语句
engine.Sql("select * from table").Find(&beans)

//指定字段
// SELECT age, name FROM user limit 1
engine.Cols("age", "name").Get(&usr)
// SELECT age, name FROM user
engine.Cols("age", "name").Find(&users)

更新：

user := new(User)
user.Name = "myname"
affected, err := engine.Id(id).Update(user)
// UPDATE user SET age=? AND name=?
engine.Cols("age", "name").Update(&user)

删除：

user := new(User)
affected, err := engine.Id(id).Delete(user)

详细文档见Go语言中文网