gorm+gin实现restful分页接⼝的实践
⽬录
1. 定义分页struct
2. 数据表Model
3. 定义分页查询搜索的结构体
4. 分页和搜索数据查询
5.例⼦代码restful接口调用实例
API处理分页看似简单，实际上暗藏危机.最常见的分页⽅式,⼤概是下⾯这样的
页数表⽰法：/user/?page=1&size=15&name=李
偏移量表⽰法：/user/?offset=100&limit=15&name=李
使⽤页码表⽰法对前端开发⽐较友好，但是本质上是和偏移量表⽰发相似. 在这⾥我们将使⽤和开发⼀个简单的分页接⼝
{
"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",
"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_
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_
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 分页数据
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=李
使⽤页码表⽰法对前端开发⽐较友好，但是本质上是和偏移量表⽰发相似. 在这⾥我们将使⽤和开发⼀个简单的分页接⼝
{
"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",
"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分页接⼝内容请搜索以前的⽂章或继续浏览下⾯的相关⽂章希望⼤家以后多多⽀持！

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。