一、数据结构
查询结果的数据结构如下：
| Code Block |
|---|
|
type Value = *gvar.Var // 返回数据表记录值
type Record map[string]Value // 返回数据表记录键值对
type Result []Record // 返回数据表记录列表 |
Value/Record/Result用于ORM操作的结果数据类型。Result表示数据表记录列表，Record表示一条数据表记录，Value表示记录中的一条键值数据。Value是*gvar.Var类型的别名类型，方便于后续的数据类型转换。
二、Record数据记录
接口文档： https://godocpkg.go.orgdev/github.com/gogf/gf/v2/database/gdb
gdb为数据表记录操作提供了极高的灵活性和简便性，除了支持以map的形式访问/操作数据表记录以外，也支持将数据表记录转换为struct进行处理。我们以下使用一个简单的示例来演示该特性。
首先，我们的用户表结构是这样的（简单设计的示例表）：
| Code Block |
|---|
|
CREATE TABLE `user` (
`uid` int(10) unsigned NOT NULL AUTO_INCREMENT,
`name` varchar(30) NOT NULL DEFAULT '' COMMENT '昵称',
`site` varchar(255) NOT NULL DEFAULT '' COMMENT '主页',
PRIMARY KEY (`uid`)
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8; |
其次，我们的表数据如下：
| Code Block |
|---|
|
uid name site
1 john https://goframe.org |
最后，我们的示例程序如下：
| Code Block |
|---|
|
package main
import (
"database/sql"
"github.com/gogf/gf/v2/frame/g"
)
type User struct {
Uid int
Name string
}
func main() {
var user *User
err := g.DB().Table("user").Where("uid", 1).Scan(&user)
if err != nil {
g.Log().Header(false).Fatal(err)
}
if user != nil {
g.Log().Header(false).Println(user)
}
} |
执行后，输出结果为：
| Code Block |
|---|
|
{"Uid":1,"Name":"john"} |
这里，我们自定义了一个struct，里面只包含了Uid和Name属性，可以看到它的属性并不和数据表的字段一致，这也是ORM灵活的特性之一：支持指定属性获取。
通过gdb.Model.Scan方法可以将查询到的数据记录转换为struct对象或者struct对象数组。由于这里传递的参数为&user即**User类型，那么将会转换为一个struct对象，如果传递为[]*User类型的参数，将会转换为数组结果，请查看后续示例。具体方法介绍请查看链式操作章节。
属性字段映射规则：
需要注意的是，map中的键名为uid,name,site，而struct中的属性为Uid,Name，那么他们之间是如何执行映射的呢？主要是以下几点简单的规则：
struct中需要匹配的属性必须为公开属性(首字母大写)；- 记录结果中键名会自动按照
不区分大小写 且 忽略-/_/空格符号 的形式与struct属性进行匹配； - 如果匹配成功，那么将键值赋值给属性，如果无法匹配，那么忽略该键值；
以下是几个匹配的示例：
| Code Block |
|---|
|
记录键名 struct属性 是否匹配
name Name match
Email Email match
nickname NickName match
NICKNAME NickName match
Nick-Name NickName match
nick_name NickName match
nick_name Nick_Name match
NickName Nick_Name match
Nick-Name Nick_Name match |
| Tip |
|---|
由于数据库结果集转struct的底层是依靠gconv.Struct方法实现的，因此如果想要实现自定义的属性转换，以及更详细的映射规则说明，请参考 类型转换-Struct转换 章节。 |
三、Result数据集合
Result/Record数据类型根据数据结果集操作的需要，往往需要根据记录中特定的字段作为键名进行数据检索，因此它包含多个用于转换Map/List的方法，同时也包含了常用数据结构JSON/XML的转换方法。
接口文档： https://godocpkg.go.orgdev/github.com/gogf/gf/v2/database/gdb
由于方法比较简单，这里便不再举例说明。需要注意的是两个方法Record.Map及Result.List，这两个方法也是使用比较频繁的方法，用以将ORM查询结果信息转换为可做展示的数据类型。由于结果集字段值底层为[]byte类型，虽然使用了新的Value类型做了封装，并且也提供了数十种常见的类型转换方法（具体请阅读 泛型类型-gvar (通用变量) 章节），但是大多数时候需要直接将结果Result或者Record直接作为json或者xml数据结构返回，就需要做转换才行。
使用示例：
| Code Block |
|---|
|
package main
import (
"database/sql"
"github.com/gogf/gf/v2/frame/g"
)
type User struct {
Uid int
Name string
Site string
}
func main() {
var user []*User
err := g.DB().Table("user").Where("uid", 1).Scan(&user)
if err != nil && err != sql.ErrNoRows {
g.Log().Header(false).Fatal(err)
}
if user != nil {
g.Log().Header(false).Println(user)
}
} |
执行后，输出结果为：
| Code Block |
|---|
|
[{"Uid":1,"Name":"john","Site":"https://goframe.org"}] |
四、结果为空判断
使用gf ORM对返回结果为空判断非常简便，大部分场景下直接判断返回的数据是否为nil或者长度为0，或者使用IsEmpty/IsNil方法。
数据集合
| Code Block |
|---|
|
// All/FindAll
r, err := g.Table("order").Where("status", 1).All()
if err != nil {
return err
}
if len(r) == 0 {
// 结果为空
} |
也可以使用IsEmpty方法：
| Code Block |
|---|
|
// All/FindAll
r, err := g.Table("order").Where("status", 1).All()
if err != nil {
return err
}
if r.IsEmpty() {
// 结果为空
} |
数据记录
| Code Block |
|---|
|
// One/FindOne
r, err := g.Table("order").Where("status", 1).One()
if err != nil {
return err
}
if len(r) == 0 {
// 结果为空
} |
也可以使用IsEmpty方法：
| Code Block |
|---|
|
// One/FindOne
r, err := g.Table("order").Where("status", 1).One()
if err != nil {
return err
}
if r.IsEmpty() {
// 结果为空
} |
数据字段值
返回的是一个"泛型"变量，这个只能使用IsEmpty来判断是否为空了。
| Code Block |
|---|
|
// Value/FindValue
r, err := g.Table("order").Where("status", 1).Value()
if err != nil {
return err
}
if r.IsEmpty() {
// 结果为空
} |
字段值数组
查询返回字段值数组本身类型为[]gdb.Value类型，因此直接判断长度是否为0即可。
| Code Block |
|---|
|
// Array/FindArray
r, err := g.Table("order").Fields("id").Where("status", 1).Array()
if err != nil {
return err
}
if len(r) == 0 {
// 结果为空
} |
struct对象
关于Struct转换对象来说会有一点不一样，我们直接看例子吧。
当传递的对象本身就是一个空指针时，如果查询到数据，那么会在内部自动创建这个对象；如果没有查询到数据，那么这个空指针仍旧是一个空指针，内部并不会做任何处理。
| Code Block |
|---|
|
// Struct/GetStruct/Scan
var user *User
err := g.Table("order").Where("status", 1).Struct(&user)
if err != nil {
return err
}
if user == nil {
// 结果为空
} |
当传递的对象本身已经是一个初始化的对象，如果查询到数据，那么会在内部将数据赋值给这个对象；如果没有查询到数据，那么此时就没办法将对象做nil判断空结果。因此ORM会返回一个sql.ErrNoRows错误，提醒开发者没有查询到任何数据并且对象没有做任何赋值，对象的所有属性还是给定的初始化数值，以便开发者可以做进一步的空结果判断。
| Code Block |
|---|
|
// Struct/GetStruct/Scan
var user = new(User)
// 或者
// var user = &User{}
err := g.Table("order").Where("status", 1).Struct(&user)
if err != nil && err != sql.ErrNoRows {
return err
}
if err == sql.ErrNoRows {
// 结果为空
} |
| Tip |
|---|
所以我们推荐开发者不要传递一个初始化过后的对象给ORM，而是直接传递一个对象的指针的指针类型（**struct类型），ORM内部会根据查询结果智能地做自动初始化。 |
struct数组
当传递的对象数组本身是一个空数组（长度为0），如果查询到数据，那么会在内部自动赋值给数组；如果没有查询到数据，那么这个空数组仍旧是一个空数组，内部并不会做任何处理。
| Code Block |
|---|
|
// Structs/GetStructs/Scan
var users []*User
// 或者
// var users []User
err := g.Table("order").Where("status", 1).Structs(&users)
if err != nil {
return err
}
if len(users) == 0 {
// 结果为空
} |
当传递的对象数组本身不是空数组，如果查询到数据，那么会在内部自动从索引0位置覆盖到数组上；如果没有查询到数据，那么此时就没办法将数组做长度为0判断空结果。因此ORM会返回一个sql.ErrNoRows错误，提醒开发者没有查询到任何数据并且数组没有做任何赋值，以便开发者可以做进一步的空结果判断。
| Code Block |
|---|
|
// Structs/GetStructs/Scan
var users = make([]*User, 100)
// 或者
// var users = make([]User, 100)
err := g.Table("order").Where("status", 1).Structs(&users)
if err != nil {
return err
}
if err == sql.ErrNoRows {
// 结果为空
} |
| Note |
|---|
如果您涉及到大量查询数据的struct数组转换，并且需要提高转换性能，请参考自定义实现对应由于struct转换利用了Golang反射特性，执行性能会有一定的损耗。如果您涉及到大量查询结果数据的struct数组对象转换，并且需要提高转换性能，请参考自定义实现对应struct的UnmarshalValue方法：类型转换-UnmarshalValue |