调试模式

为便于开发阶段调试,gf-orm支持调试模式,可以使用以下方式开启调试模式:

  1. // 是否开启调试服务
  2. func (db *Db) SetDebug(debug bool)

随后在ORM的操作过程中,所有的执行语句将会打印到终端进行展示。
同时,我们可以通过以下方法获得调试过程中执行的所有SQL语句:

  1. // 获取已经执行的SQL列表
  2. func (db *Db) GetQueriedSqls() []*Sql

使用示例:

  1. package main
  2. import (
  3. "fmt"
  4. "gitee.com/johng/gf/g/database/gdb"
  5. )
  6. var db *gdb.Db
  7. // 初始化配置及创建数据库
  8. func init () {
  9. gdb.AddDefaultConfigNode(gdb.ConfigNode {
  10. Host : "127.0.0.1",
  11. Port : "3306",
  12. User : "root",
  13. Pass : "123456",
  14. Name : "test",
  15. Type : "mysql",
  16. Role : "master",
  17. Charset : "utf8",
  18. })
  19. db, _ = gdb.New()
  20. }
  21. func main() {
  22. db.SetDebug(true)
  23. // 执行3条SQL查询
  24. for i := 1; i <= 3; i++ {
  25. db.Table("user").Where("uid=?", i).One()
  26. }
  27. // 构造一条错误查询
  28. db.Table("user").Where("no_such_field=?", "just_test").One()
  29. }

执行后,输出结果如下:

  1. 2018-08-31 13:54:32.913 [DEBU] SELECT * FROM user WHERE uid=?, [1], 2018-08-31 13:54:32.912, 2018-08-31 13:54:32.913, 1 ms, DB:Query
  2. 2018-08-31 13:54:32.915 [DEBU] SELECT * FROM user WHERE uid=?, [2], 2018-08-31 13:54:32.914, 2018-08-31 13:54:32.915, 1 ms, DB:Query
  3. 2018-08-31 13:54:32.915 [DEBU] SELECT * FROM user WHERE uid=?, [3], 2018-08-31 13:54:32.915, 2018-08-31 13:54:32.915, 0 ms, DB:Query
  4. 2018-08-31 13:54:32.915 [ERRO] SELECT * FROM user WHERE no_such_field=?, [just_test], 2018-08-31 13:54:32.915, 2018-08-31 13:54:32.915, 0 ms, DB:Query
  5. Error: Error 1054: Unknown column 'no_such_field' in 'where clause'
  6. 1. /home/john/Workspace/Go/GOPATH/src/gitee.com/johng/gf/g/database/gdb/gdb_base.go:120
  7. 2. /home/john/Workspace/Go/GOPATH/src/gitee.com/johng/gf/g/database/gdb/gdb_base.go:174
  8. 3. /home/john/Workspace/Go/GOPATH/src/gitee.com/johng/gf/g/database/gdb/gdb_model.go:378
  9. 4. /home/john/Workspace/Go/GOPATH/src/gitee.com/johng/gf/g/database/gdb/gdb_model.go:301
  10. 5. /home/john/Workspace/Go/GOPATH/src/gitee.com/johng/gf/g/database/gdb/gdb_model.go:306
  11. 6. /home/john/Workspace/Go/GOPATH/src/gitee.com/johng/gf/g/database/gdb/gdb_model.go:311
  12. 7. /home/john/Workspace/Go/GOPATH/src/gitee.com/johng/gf/geg/database/orm/mysql/gdb_debug.go:30

查询缓存

gf-orm支持对查询结果的缓存处理,并支持手动的缓存清理,一切都由业务层调用端自主决定。需要注意的是,查询缓存仅支持链式操作,且在事务操作下不可用。
相关方法:

  1. // 查询缓存/清除缓存操作,需要注意的是,事务查询不支持缓存。
  2. // 当time < 0时表示清除缓存, time=0时表示不过期, time > 0时表示过期时间,time过期时间单位:秒;
  3. // name表示自定义的缓存名称,便于业务层精准定位缓存项(如果业务层需要手动清理时,必须指定缓存名称),
  4. // 例如:查询缓存时设置名称,清理缓存时可以给定清理的缓存名称进行精准清理。
  5. func (md *Model) Cache(time int, name ... string) *Model

使用示例:

  1. package main
  2. import (
  3. "gitee.com/johng/gf/g/database/gdb"
  4. "gitee.com/johng/gf/g/util/gutil"
  5. )
  6. func main() {
  7. gdb.AddDefaultConfigNode(gdb.ConfigNode {
  8. Host : "127.0.0.1",
  9. Port : "3306",
  10. User : "root",
  11. Pass : "123456",
  12. Name : "test",
  13. Type : "mysql",
  14. Role : "master",
  15. Charset : "utf8",
  16. })
  17. db, err := gdb.New()
  18. if err != nil {
  19. panic(err)
  20. }
  21. // 开启调试模式,以便于记录所有执行的SQL
  22. db.SetDebug(true)
  23. // 执行2次查询并将查询结果缓存3秒,并可执行缓存名称(可选)
  24. for i := 0; i < 2; i++ {
  25. r, _ := db.Table("user").Cache(3, "vip-user").Where("uid=?", 1).One()
  26. gutil.Dump(r.ToMap())
  27. }
  28. // 执行更新操作,并清理指定名称的查询缓存
  29. db.Table("user").Cache(-1, "vip-user").Data(gdb.Map{"name" : "smith"}).Where("uid=?", 1).Update()
  30. // 再次执行查询,启用查询缓存特性
  31. r, _ := db.Table("user").Cache(3, "vip-user").Where("uid=?", 1).One()
  32. gutil.Dump(r.ToMap())
  33. }

执行后输出结果为(测试表数据结构仅供示例参考):

  1. 2018-08-31 13:56:58.132 [DEBU] SELECT * FROM user WHERE uid=?, [1], 2018-08-31 13:56:58.131, 2018-08-31 13:56:58.132, 1 ms, DB:Query
  2. {
  3. "datetime": "",
  4. "name": "smith",
  5. "uid": "1"
  6. }
  7. {
  8. "datetime": "",
  9. "name": "smith",
  10. "uid": "1"
  11. }
  12. 2018-08-31 13:56:58.144 [DEBU] UPDATE `user` SET `name`=? WHERE uid=?, [smith 1], 2018-08-31 13:56:58.133, 2018-08-31 13:56:58.144, 11 ms, DB:Exec
  13. 2018-08-31 13:56:58.144 [DEBU] SELECT * FROM user WHERE uid=?, [1], 2018-08-31 13:56:58.144, 2018-08-31 13:56:58.144, 0 ms, DB:Query
  14. {
  15. "datetime": "",
  16. "name": "smith",
  17. "uid": "1"
  18. }

Record转Struct对象

gf-orm为数据表记录操作提供了极高的灵活性和简便性,除了支持以map的形式访问/操作数据表记录以外,也支持将数据表记录转换为struct进行处理。我们以下使用一个简单的示例来演示该特性。

首先,我们的用户表结构是这样的(简单设计的示例表):

  1. CREATE TABLE `user` (
  2. `uid` int(10) unsigned NOT NULL AUTO_INCREMENT,
  3. `name` varchar(30) NOT NULL DEFAULT '' COMMENT '昵称',
  4. `site` varchar(255) NOT NULL DEFAULT '' COMMENT '主页',
  5. PRIMARY KEY (`uid`)
  6. ) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;

其次,我们的表数据如下:

  1. uid name site
  2. 1 john http://johng.cn

最后,我们的示例程序如下:

  1. package main
  2. import (
  3. "fmt"
  4. )
  5. type User struct {
  6. Uid int
  7. Name string
  8. }
  9. func main() {
  10. if r, err := db.Table("user").Where("uid=?", 1).One(); err == nil {
  11. u := User{}
  12. if err := r.ToStruct(&u); err == nil {
  13. fmt.Println(" uid:", u.Uid)
  14. fmt.Println("name:", u.Name)
  15. } else {
  16. fmt.Println(err)
  17. }
  18. } else {
  19. fmt.Println(err)
  20. }
  21. }

执行后,输出结果为:

  1. uid: 1
  2. name: john

这里,我们自定义了一个struct,里面只包含了UidName属性,可以看到它的属性并不和数据表的字段一致,这也是ORM灵活的特性之一:支持指定属性获取。

通过gdb.Model.One方法获取的返回数据表记录是一个gdb.Map数据类型,我们可以直接通过它的ToStruct(obj interface{}) error方法转换为指定的struct对象。

需要注意的是,map中的键名为uid,name,site,而struct中的属性为Uid,Name,那么他们之间是如何执行映射的呢?主要是以下几点重要的规则:

  1. struct中的属性必须为公开属性;
  2. map中的键名会自动将首字母进行大写转换以进行属性匹配;
  3. 如果匹配成功,那么将键值赋值给属性,如果无法匹配,那么忽略;

以下是几个匹配的示例:

  1. map键名 struct属性 是否匹配
  2. name Name match
  3. Email Email match
  4. nickname Nickname match
  5. Nick-Name Nickname not match
  6. nick_name Nickname not match
  7. nick_name Nick_name match

Result结果集类型转换

Result/Record数据类型根据数据结果集操作的需要,往往需要根据记录中特定的字段作为键名进行数据检索,因此它包含多个用于转换Map/List的方法,同时也包含了常用数据结构JSON/XML的转换方法,如下:

  1. // 数据表记录
  2. type Record
  3. func (r Record) ToMap() Map
  4. func (r Record) ToJson() string
  5. func (r Record) ToXml() string
  6. func (r Record) ToStruct(obj interface{}) error
  1. // 数据表记录列表
  2. type Result
  3. func (r Result) ToList() List
  4. func (r Result) ToJson() string
  5. func (r Result) ToXml() string
  6. func (r Result) ToStringMap(key string) map[string]Map
  7. func (r Result) ToIntMap(key string) map[int]Map
  8. func (r Result) ToUintMap(key string) map[uint]Map
  9. func (r Result) ToStringRecord(key string) map[string]Record
  10. func (r Result) ToIntRecord(key string) map[int]Record
  11. func (r Result) ToUintRecord(key string) map[uint]Record

由于方法比较简单,这里便不再举例说明。需要注意的是两个方法Record.ToMapResult.ToList,这两个方法也是使用比较频繁的方法,用以将ORM查询结果信息转换为可做展示的数据类型。例如,由于结果集字段值底层为[]byte类型,虽然使用了新的Value类型做了封装,并且也提供了数十种常见的类型转换方法(具体请阅读【通用动态变量】章节),但是大多数时候需要直接将结果Result或者Record直接作为json或者xml数据结构返回,就需要做转换才行。