gorm+gin实现restful分页接口的实践

更新时间：2021年12月22日 09:37:21 作者：OwenZhang

本文主要介绍了gorm+gin实现restful分页接口的实践，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下

{
    "data": [
        {
            "id": 28,
            "created_at": "2019-09-12T14:25:54+08:00",
            "updated_at": "2019-09-12T14:25:54+08:00",
            "user_id": 26,
            "machine_id": 1,
            "ssh_user": "mojotv.cn",
            "client_ip": "10.18.60.16",
            "started_at": "2019-09-12T14:24:05+08:00",
            "status": 0,
            "remark": ""
        }
    ],
    "ok": true,
    "page": 1,
    "size": 10,
    "total": 1
}

1. 定义分页struct

//PaginationQ gin handler query binding struct
type PaginationQ struct {
 Ok    bool        `json:"ok"`
 Size  uint        `form:"size" json:"size"`
 Page  uint        `form:"page" json:"page"`
 Data  interface{} `json:"data" comment:"muster be a pointer of slice gorm.Model"` // save pagination list
 Total uint        `json:"total"`
}

Ok 代表业务查询没有出错
Size 每页显示的数量,使用 form tag 接受gin的url-query参数
Page 当前页码,使用 form tag 接受gin的url-query参数
Data 分页的数据内容
Total 全部的页码数量

2. 数据表Model

这里以ssh_log(ssh 命令日志为示例),使用GORM创建MYSQL数据表模型, 使用 form tag 接受gin的url-query参数,作为搜索条件

type SshLog struct {
 BaseModel
 UserId    uint      `gorm:"index" json:"user_id" form:"user_id"` //form tag 绑定gin url-query 参数
 MachineId uint      `gorm:"index" json:"machine_id" form:"machine_id"` //form tag 绑定gin url-query 参数
 SshUser   string    `json:"ssh_user" comment:"ssh账号"`
 ClientIp  string    `json:"client_ip" form:"client_ip"` //form tag 绑定gin url-query 参数
 StartedAt time.Time `json:"started_at" form:"started_at"`
 Status    uint      `json:"status" comment:"0-未标记 2-正常 4-警告 8-危险 16-致命"`
 Remark    string    `json:"remark"`
 Log       string    `gorm:"type:text" json:"log"`
 Machine   Machine   `gorm:"association_autoupdate:false;association_autocreate:false" json:"machine"`
 User      User      `gorm:"association_autoupdate:false;association_autocreate:false" json:"user"`
}

3. 定义分页查询搜索的结构体

ssh2ws/internal/h_ssh_log.go
type SshLogQ struct {
 SshLog
 PaginationQ
 FromTime string `form:"from_time"` //搜索开始时间
 ToTime   string `form:"to_time"`  //搜索结束时候
}

这个结构体是提供给gin handler用作参数绑定的. 使用的方法如下:

func SshLogAll(c *gin.Context) {
 query := &model.SshLogQ{}
 err := c.ShouldBindQuery(query) //开始绑定url-query 参数到结构体
 if handleError(c, err) {
  return
 }
 list, total, err := query.Search()  //开始mysql 业务搜索查询
 if handleError(c, err) {
  return
 }
 //返回数据开始拼装分页json
 jsonPagination(c, list, total, &query.PaginationQ)
}

4. 分页和搜索数据查询

1.创建 db-query
2.搜索非空业务字段
3.使用crudAll 方法获取数据

model/m_ssh_log.go
type SshLogQ struct {
 SshLog
 PaginationQ
 FromTime string `form:"from_time"`
 ToTime   string `form:"to_time"`
}

func (m SshLogQ) Search() (list *[]SshLog, total uint, err error) {
 list = &[]SshLog{}
 //创建 db-query
 tx := db.Model(m.SshLog).Preload("User").Preload("Machine")
 //搜索非空业务字段
 if m.ClientIp != "" {
  tx = tx.Where("client_ip like ?", "%"+m.ClientIp+"%")
 }
 //搜索时间段
 if m.FromTime != "" && m.ToTime != "" {
  tx = tx.Where("`created_at` BETWEEN ? AND ?", m.FromTime, m.ToTime)
 }
 //使用crudAll 方法获取数据
 total, err = crudAll(&m.PaginationQ, tx, list)
 return
}

crudAll 方法来构建sql分页数据,

设置默认参数
获取全部搜索数量
获取偏移量的数据
拼装json 分页数据

model/helper.go

func crudAll(p *PaginationQ, queryTx *gorm.DB, list interface{}) (uint, error) { 
    //1.默认参数 
    if p.Size < 1 { 
        p.Size = 10 
    } 
    if p.Page < 1 { 
        p.Page = 1 
    }

    //2.部搜索数量 
    var total uint err := queryTx.Count(&total).Error if err != nil {
        return 0, err 
    } 
    offset := p.Size * (p.Page - 1)

    //3.偏移量的数据
    err = queryTx.Limit(p.Size).Offset(offset).Find(list).Error if err != nil { 
        return 0, err
    } 
    
    return total, err 
}

//4.json 分页数据 
func jsonPagination(c *gin.Context, list interface{}, total uint, query *model.PaginationQ) { 
    c.AbortWithStatusJSON(200, gin.H{
        “ok”: true,
        “data”: list, 
        “total”: total,
        “page”: query.Page, 
        “size”: query.Size
    })
 }

API处理分页看似简单,实际上暗藏危机.最常见的分页方式,大概是下面这样的

页数表示法：/user/?page=1&size=15&name=李
偏移量表示法：/user/?offset=100&limit=15&name=李

使用页码表示法对前端开发比较友好,但是本质上是和偏移量表示发相似. 在这里我们将使用 jinzhu/gorm和 gin-gonic/gin 开发一个简单的分页接口

分页查询URL: http://dev.mojotv.cn:3333/api/ssh-log?client_ip=&page=1&size=10&user_id=0&machine_id=0 返回json 结果

{
    "data": [
        {
            "id": 28,
            "created_at": "2019-09-12T14:25:54+08:00",
            "updated_at": "2019-09-12T14:25:54+08:00",
            "user_id": 26,
            "machine_id": 1,
            "ssh_user": "mojotv.cn",
            "client_ip": "10.18.60.16",
            "started_at": "2019-09-12T14:24:05+08:00",
            "status": 0,
            "remark": ""
        }
    ],
    "ok": true,
    "page": 1,
    "size": 10,
    "total": 1
}

5.例子代码

完整项目代码地址

到此这篇关于gorm+gin实现restful分页接口的实践的文章就介绍到这了,更多相关gorm gin restful分页接口内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Skywalking-go自动监控增强使用探究
这篇文章主要介绍了Skywalking-go自动监控增强使用深入探究,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
2024-01-01
使用Golang获取音视频时长信息的示例代码
这篇文章主要介绍了如何使用Golang获取音视频时长信息,文中通过代码示例讲解的非常详细,对大家的学习或工作有一定的帮助,需要的朋友可以参考下
2024-03-03
golang常用库之字段参数验证库-validator使用详解
这篇文章主要介绍了golang常用库：字段参数验证库-validator使用,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借价值，需要的朋友可以参考下
2020-10-10
Go语言编程入门超级指南
这篇文章主要介绍了Go语言编程的入门指南,包括对Go的变量及函数的基本介绍,需要的朋友可以参考下
2016-01-01
一文带你了解Go语言中的类型断言和类型转换
在Go中，类型断言和类型转换是一个令人困惑的事情，他们似乎都在做同样的事情。最明显的不同点是他们具有不同的语法(variable.(type) vs type(variable) )。本文我们就来深入研究一下二者的区别
2022-09-09
Go http请求排队处理实战示例
这篇文章主要为大家介绍了Go http请求排队处理实战实例详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-07-07
sublime安装支持go和html的插件
这篇文章主要介绍了sublime安装支持go和html的插件,需要的朋友可以参考下
2015-01-01
GO语言中Chan实现原理的示例详解
这篇文章主要为大家详细介绍了Go语言中Chan实现原理的相关资料，文中的示例代码讲解详细，对我们学习Go语言有一定的帮助，需要的可以参考一下
2023-02-02
Go语言实现聊天小工具的示例代码
这篇文章主要为大家详细介绍了如何利用Go语言实现聊天小工具，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2023-03-03
golang中按照结构体的某个字段排序实例代码
在任何编程语言中,关乎到数据的排序都会有对应的策略,下面这篇文章主要给大家介绍了关于golang中按照结构体的某个字段排序的相关资料,需要的朋友可以参考下
2022-05-05