Skip to end of metadata
Go to start of metadata

一、数据结构

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

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://godoc.org/github.com/gogf/gf/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 (
	"database/sql"
	"github.com/gogf/gf/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)
	}
}

执行后,输出结果为:

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

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

通过gdb.Model.Scan方法可以将查询到的数据记录转换为struct对象或者struct对象数组。由于这里传递的参数为&user**User类型,那么将会转换为一个struct对象,如果传递为[]*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://godoc.org/github.com/gogf/gf/database/gdb

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

使用示例:

package main

import (
	"database/sql"
	"github.com/gogf/gf/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)
	}
}

执行后,输出结果为:

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

四、结果为空判断

使用gf ORM对返回结果为空判断非常简便,大部分场景下直接判断返回的数据是否为nil或者长度为0,或者使用IsEmpty/IsNil方法。

数据集合

// All/FindAll
r, err := g.Table("order").Where("status", 1).All()
if err != nil {
	return err
}
if len(r) == 0 {
    // 结果为空
}

也可以使用IsEmpty方法:

// All/FindAll
r, err := g.Table("order").Where("status", 1).All()
if err != nil {
	return err
}
if r.IsEmpty() {
    // 结果为空
}

数据记录

// One/FindOne
r, err := g.Table("order").Where("status", 1).One()
if err != nil {
    return err
}
if len(r) == 0 {
    // 结果为空
}

也可以使用IsEmpty方法:

// One/FindOne
r, err := g.Table("order").Where("status", 1).One()
if err != nil {
    return err
}
if r.IsEmpty() {
    // 结果为空
}

数据字段值

返回的是一个"泛型"变量,这个只能使用IsEmpty来判断是否为空了。

// Value/FindValue
r, err := g.Table("order").Where("status", 1).Value()
if err != nil {
	return err
}
if r.IsEmpty() {
    // 结果为空
}

字段值数组

查询返回字段值数组本身类型为[]gdb.Value类型,因此直接判断长度是否为0即可。

// Array/FindArray
r, err := g.Table("order").Fields("id").Where("status", 1).Array()
if err != nil {
    return err
}
if len(r) == 0 {
    // 结果为空
}

struct对象

部分特性需要v1.15.2版本后支持。

关于Struct转换对象来说会有一点不一样,我们直接看例子吧。

当传递的对象本身就是一个空指针时,如果查询到数据,那么会在内部自动创建这个对象;如果没有查询到数据,那么这个空指针仍旧是一个空指针,内部并不会做任何处理。

// 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错误,提醒开发者没有查询到任何数据并且对象没有做任何赋值,对象的所有属性还是给定的初始化数值,以便开发者可以做进一步的空结果判断。

// 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 {
    // 结果为空
}

所以我们推荐开发者不要传递一个初始化过后的对象给ORM,而是直接传递一个对象的指针的指针类型(**struct类型),ORM内部会根据查询结果智能地做自动初始化。

struct数组

当传递的对象数组本身是一个空数组(长度为0),如果查询到数据,那么会在内部自动赋值给数组;如果没有查询到数据,那么这个空数组仍旧是一个空数组,内部并不会做任何处理。

// 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错误,提醒开发者没有查询到任何数据并且数组没有做任何赋值,以便开发者可以做进一步的空结果判断。

// 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 {     
    // 结果为空
}

由于struct转换利用了Golang反射特性,执行性能会有一定的损耗。如果您涉及到大量查询结果数据的struct数组对象转换,并且需要提高转换性能,请参考自定义实现对应structUnmarshalValue方法:类型转换-UnmarshalValue









Content Menu

  • No labels

10 Comments

  1. type DeviceInfo struct {
       id       int    `orm:"id"`
       Device   string `orm:"device"`
       Info     string `orm:"device_info"`
       DeviceIp string `orm:"device_ip"`
       UploadAt string `orm:"upload_at"`
    }
    type ResponseRes struct {
       Code    int
       Message string
       Data    interface{} `json:"data"`
    }
    
    // Index is a demonstration route handler for output "Hello World!".
    func (a *helloApi) Index(r *ghttp.Request) {
       m := g.DB().Model("face_device_upload_info")
       var deviceInfo []*DeviceInfo
       m.Where("id>", "10").Scan(&deviceInfo)
       r.Response.WriteJsonExit(ResponseRes{Data: &deviceInfo})
    }

    这样的一个结构,device_infomysql内的JSON字段,但是转换的时候被转义了,如何设置不被转义呢?另外在r.Response.WriteJsonExit是否也会自动转义JSON?如何设置不转义?

    1. 首先你看看你的数据表中的数据device_info字段JSON字符串是否被转义。

      其次你的Info属性的类型是字符串,改为具体结构体试试。

  2. 首先mysql内的device_info肯定没有被转义,其次device_info这个字段为JSON类型,是不同设备发送的各类信息,内容各不相同,这个怎么处理?另外在r.Response.WriteJsonExit是否也会自动转义JSON?如何设置不转义?

  3. 如果不使用结构转换,GO好像可以用 jsonEncoder.SetEscapeHTML(false) 设置不转义?类似PHP中json_encode( $json_context, 320) 但是如果用框架的结构自动转换如何设置?这个需求在和很多第三方做对接时候用的很多

  4. 已经解决了,改为:
    Info map[string]string `orm:"device_info"`



    1. 你好,用你的实例我的怎么返回是nil呢,数据库字段是json类型,数据也是json格式

      1. 结构体支持mysql的json类型

        结构体对应json数据格式
        type  DeviceUIDNode  struct {
             Uid        string      `orm:"uid,primary" json:"uid"`         // UID 
            ServersId gjson.json  `orm:"servers_id" json:"servers_id"`  // 服务器id 
        }

        踩过的坑希望能帮助到大家

  5. chinayesgo chinayesgo 如果数据表字段为JSON格式,目前CLI工具是自动当做string类型来对应的,开发者可以自定义为map或者struct可以接受的类型,底层会自动转换。

    1. type DeviceInfo struct {
      Id int `orm:"id"`
      Info map[string]string `orm:"refund_exchange"`
      }
      type ResponseRes struct {
      Code int
      Message string
      Data interface{} `json:"data"`
      }

      func (a *goodsApi) GetList(r *ghttp.Request) *response.Response {
      m := g.DB().Model("goods")
      var deviceInfo []*DeviceInfo
      m.Where("id>", 10).Scan(&deviceInfo)
      return &response.Response

      Unknown macro: {Data}

      }

      你好info的类型我试过map[string]string、map[string]interface{},refund_exchange在数据库是json类型 ,数据为[{"Uid": 1, "Name": "john", "Site": "https://goframe.org"}],或者{"Uid": 1, "Name": "john", "Site": "https://goframe.org"}返回都是nil,实现UnmarshalValue接口可以达到json转换的效果,但是所有的属性都要重写一遍 ,请问怎么操作好

      1. 你好,正常是可以自动接收JSON数据类型的,如果实在不行请将你的SQL和可运行的代码提交issue我帮你看看,WIKI中不接受issue反馈。