go restful接口开发步骤(go语言调用第三方restful api)

技术gorm+gin怎么实现restful分页本篇内容主要讲解“gorm+gin怎么实现restful分页”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“gorm+gin怎么实

本文主要解释“gorm gin如何实现安静的分页”。感兴趣的朋友不妨看看。本文介绍的方法简单、快速、实用。让边肖带你学习“戈尔姆金如何实现安静的寻呼”!

处理API分页看似简单,实则隐藏着危机。最常见的分页方法可能如下

页码符号:/user/?Page=1size=15name=Li

偏移符号:/user/?Offset=100limit=15name=Li

使用页码表示法对前端开发很友好,但本质上类似于偏移量表示法。这里我们将使用朱槿/gorm和gin-gonic/gin开发一个简单的分页接口

分页URL :3358 dev . mojo TV . cn :3333/API/ssh-log?client _ IP=page=1 size=10 user _ id=0 machine _ id=0返回json结果。

{

数据' :[

{

id':28,

创建于_ : ' 2019-09-12t 14:25:54 08:00 ',

updated _ at ' : ' 2019-09-12t 14:25:54 08:00 ',

user_id':26,

machine_id':1,

ssh_user':'mojotv.cn ',

client_ip':'10.18.60.16 ',

started _ at ' : ' 2019-09-12t 14:24:05 08:00 ',

状态' :0,

备注“:”

}

],

好的:路,

第:1页,

尺寸' :10,

总计' :1

}

1. 定义分页struct

//PaginationQginhandlerquerybindingstruct

类型分页q

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"`
}

gorm+gin怎么实现restful分页

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

ssh3ws/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
}

到此,相信大家对“gorm+gin怎么实现restful分页”有了更深的了解,不妨来实际操作一番吧!这里是网站,更多相关内容可以进入相关频道进行查询,关注我们,继续学习!

内容来源网络,如有侵权,联系删除,本文地址:https://www.230890.com/zhan/155208.html

(0)

相关推荐

  • MySQL中SQL优化建议的示例分析

    技术MySQL中SQL优化建议的示例分析这期内容当中小编将会给大家带来有关MySQL中SQL优化建议的示例分析,文章内容丰富且以专业的角度为大家分析和叙述,阅读完这篇文章希望大家可以有所收获。今天早上看到同事的一个优化需

    攻略 2021年11月29日
  • 如何进行JS中的事件冒泡与捕获

    技术如何进行JS中的事件冒泡与捕获这期内容当中小编将会给大家带来有关如何进行JS中的事件冒泡与捕获,文章内容丰富且以专业的角度为大家分析和叙述,阅读完这篇文章希望大家可以有所收获。刚接触 JS 的那个时候,啥也不懂,只想

    攻略 2021年11月16日
  • 美国纽约邮政编码,谁给我个美国地址加邮编

    技术美国纽约邮政编码,谁给我个美国地址加邮编您好,给您几个地址和邮编作为参考美国纽约邮政编码: Calle C #32 Parcelas Perez Santana Ohio Arecibo的邮编是00612
    1121

    生活 2021年10月29日
  • Windows如何实现任务计划隐藏显示黑窗口

    技术Windows如何实现任务计划隐藏显示黑窗口小编给大家分享一下Windows如何实现任务计划隐藏显示黑窗口,希望大家阅读完这篇文章之后都有所收获,下面让我们一起去探讨吧!Windows 任务计划隐藏显示黑窗口,主要通

    攻略 2021年11月18日
  • 香港VPS or 香港服务器 如何选择

    技术香港VPS or 香港服务器 如何选择选择香港地区的IDC产品搭建网站有不少选择,比较常用的是香港服务器和香港VPS,那么二者之间有什么区别,应该如何选择呢,下面就来简单介绍一下香港VPS 香港VPS租用是一个常见的

    礼包 2021年12月15日
  • MYSQL如何利用MYSQL Shell安装 INNODB Cluster

    技术MYSQL如何利用MYSQL Shell安装 INNODB Cluster今天就跟大家聊聊有关MYSQL如何利用MYSQL Shell安装 INNODB Cluster,可能很多人都不太了解,为了让大家更加了解,小编

    攻略 2021年10月25日