一、数据结构

查询结果的数据结构如下：

type Value  = *gvar.Var              // 返回数据表记录值
type Record   map[string]Value       // 返回数据表记录键值对
type Result   []Record               // 返回数据表记录列表
  1. Value/Record/Result用于ORM操作的结果数据类型。
  2. Result表示数据表记录列表，Record表示一条数据表记录，Value表示记录中的一条键值数据。
  3. Value是*gvar.Var类型的别名类型，是一个运行时泛型，以便支持数据表不同的字段类型，方便于后续的数据类型转换。

举个🌰：

二、Record数据记录

接口文档： https://pkg.go.dev/github.com/gogf/gf/v2/database/gdb

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

首先，我们的用户表结构是这样的（简单设计的示例表）：

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;

其次，我们的表数据如下：

uid  name   site
1    john   https://goframe.org

最后，我们的示例程序如下：

package main

import (
	"github.com/gogf/gf/v2/frame/g"
	"github.com/gogf/gf/v2/os/gctx"
)

type User struct {
	Uid  int
	Name string
}

func main() {
	var (
		user *User
		ctx  = gctx.New()
	)
	err := g.DB().Model("user").Where("uid", 1).Scan(&user)
	if err != nil {
		g.Log().Header(false).Fatal(ctx, err)
	}
	if user != nil {
		g.Log().Header(false).Print(ctx, user)
	}
}

执行后，输出结果为：

{"Uid":1,"Name":"john"}

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

通过gdb.Model.Scan方法可以将查询到的数据记录转换为struct对象或者struct对象数组。由于这里传递的参数为&user即**User类型，那么将会转换为一个结构体对象，如果传递为[]*User类型的参数，将会转换为结构体数组结果，请查看后续示例。具体方法介绍请查看链式操作章节。

属性字段映射规则：

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

  1. struct中需要匹配的属性必须为公开属性(首字母大写)；
  2. 记录结果中键名会自动按照  不区分大小写  且  忽略-/_/空格符号  的形式与struct属性进行匹配；
  3. 如果匹配成功，那么将键值赋值给属性，如果无法匹配，那么忽略该键值；

以下是几个匹配的示例：

记录键名    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

由于数据库结果集转struct的底层是依靠gconv.Struct方法实现的，因此如果想要实现自定义的属性转换，以及更详细的映射规则说明，请参考 类型转换-Struct转换 章节。

三、Result数据集合

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

接口文档： https://pkg.go.dev/github.com/gogf/gf/v2/database/gdb

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

使用示例：

package main

import (
	"database/sql"

	"github.com/gogf/gf/v2/frame/g"
	"github.com/gogf/gf/v2/os/gctx"
)

type User struct {
	Uid  int
	Name string
	Site string
}

func main() {
	var (
		user []*User
		ctx  = gctx.New()
	)
	err := g.DB().Model("user").Where("uid", 1).Scan(&user)
	if err != nil && err != sql.ErrNoRows {
		g.Log().Header(false).Fatal(ctx, err)
	}
	if user != nil {
		g.Log().Header(false).Print(ctx, user)
	}
}

执行后，输出结果为：

[{"Uid":1,"Name":"john","Site":"https://goframe.org"}]
Content Menu

  • No labels

2 Comments

  1. jianyu.liu

    2.Result表示数据表记录列表，Record表示一条数据表记录，Value表示记录中的一条键值数据。这一行里面Record和Value的描述应该是写反了吧

    1. 郭强

      没有