gorm+gin實現(xiàn)restful分頁接口的實踐
更新時間：2021年12月22日 09:37:21 作者：OwenZhang
本文主要介紹了gorm+gin實現(xiàn)restful分頁接口的實踐，文中通過示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下
API處理分頁看似簡單,實際上暗藏危機.最常見的分頁方式,大概是下面這樣的
- 頁數(shù)表示法：/user/?page=1&size=15&name=李
- 偏移量表示法：/user/?offset=100&limit=15&name=李
使用頁碼表示法對前端開發(fā)比較友好,但是本質上是和偏移量表示發(fā)相似. 在這里我們將使用?jinzhu/gorm和?gin-gonic/gin?開發(fā)一個簡單的分頁接口
分頁查詢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
}
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?代表業(yè)務查詢沒有出錯
- Size?每頁顯示的數(shù)量,使用?form?tag 接受gin的url-query參數(shù)
- Page?當前頁碼,使用?form?tag 接受gin的url-query參數(shù)
- Data?分頁的數(shù)據內容
- Total?全部的頁碼數(shù)量
2. 數(shù)據表Model
這里以ssh_log(ssh 命令日志為示例),使用GORM創(chuàng)建MYSQL數(shù)據表模型, 使用?form?tag 接受gin的url-query參數(shù),作為搜索條件
type SshLog struct {
BaseModel
UserId uint `gorm:"index" json:"user_id" form:"user_id"` //form tag 綁定gin url-query 參數(shù)
MachineId uint `gorm:"index" json:"machine_id" form:"machine_id"` //form tag 綁定gin url-query 參數(shù)
SshUser string `json:"ssh_user" comment:"ssh賬號"`
ClientIp string `json:"client_ip" form:"client_ip"` //form tag 綁定gin url-query 參數(shù)
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用作參數(shù)綁定的. 使用的方法如下:
func SshLogAll(c *gin.Context) {
query := &model.SshLogQ{}
err := c.ShouldBindQuery(query) //開始綁定url-query 參數(shù)到結構體
if handleError(c, err) {
return
}
list, total, err := query.Search() //開始mysql 業(yè)務搜索查詢
if handleError(c, err) {
return
}
//返回數(shù)據開始拼裝分頁json
jsonPagination(c, list, total, &query.PaginationQ)
}
4. 分頁和搜索數(shù)據查詢
1.創(chuàng)建 db-query
2.搜索非空業(yè)務字段
3.使用crudAll 方法獲取數(shù)據
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{}
//創(chuàng)建 db-query
tx := db.Model(m.SshLog).Preload("User").Preload("Machine")
//搜索非空業(yè)務字段
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 方法獲取數(shù)據
total, err = crudAll(&m.PaginationQ, tx, list)
return
}
crudAll 方法來構建sql分頁數(shù)據,
- 設置默認參數(shù)
- 獲取全部搜索數(shù)量
- 獲取偏移量的數(shù)據
- 拼裝json 分頁數(shù)據?
model/helper.go
func crudAll(p *PaginationQ, queryTx *gorm.DB, list interface{}) (uint, error) {
//1.默認參數(shù)
if p.Size < 1 {
p.Size = 10
}
if p.Page < 1 {
p.Page = 1
}
//2.部搜索數(shù)量
var total uint err := queryTx.Count(&total).Error if err != nil {
return 0, err
}
offset := p.Size * (p.Page - 1)
//3.偏移量的數(shù)據
err = queryTx.Limit(p.Size).Offset(offset).Find(list).Error if err != nil {
return 0, err
}
return total, err
}
//4.json 分頁數(shù)據
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處理分頁看似簡單,實際上暗藏危機.最常見的分頁方式,大概是下面這樣的
- 頁數(shù)表示法：/user/?page=1&size=15&name=李
- 偏移量表示法：/user/?offset=100&limit=15&name=李
使用頁碼表示法對前端開發(fā)比較友好,但是本質上是和偏移量表示發(fā)相似. 在這里我們將使用?jinzhu/gorm和?gin-gonic/gin?開發(fā)一個簡單的分頁接口
分頁查詢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實現(xiàn)restful分頁接口的實踐的文章就介紹到這了,更多相關gorm gin restful分頁接口內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
這篇文章主要介紹了Golang 的defer執(zhí)行規(guī)則說明，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2021-04-04
docker在開發(fā)和運維中使用的場景越來越多,作為開發(fā)人員非常有必要了解一些docker的基本知識,而離我們工作中最近的也就是對應用的docker部署編排了,這篇文章主要給大家介紹了關于golang使用DockerFile的正確用法指南,需要的朋友可以參考下2024-03-03
在開發(fā)組件庫的過程中,文檔無疑是不可或缺的一環(huán),在本文中將嘗試將Go語言與前端技術巧妙融合,以創(chuàng)建一款能在毫秒級別完成文檔生成的工具,需要的可以參考下2024-03-03
這篇文章給大家介紹了Golang常用的幾種密碼加密方式,加密有兩種方式,一種是直接加密,一種是鹽值加密,直接加密指的是將原始密碼直接進行加密,鹽值加密則是在進行密碼加密之前,文中有詳細的代碼示例,需要的朋友可以參考下2023-08-08
go 原生http web 服務跨域restful api的寫法介紹
這篇文章主要介紹了go 原生http web 服務跨域restful api的寫法，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2021-04-04
go get 從指定源上面下載或者更新指定的代碼和依賴，并對他們進行編譯和安裝，但go get功能比較差，所以下面這篇文章主要給大家介紹了關于利用dep代替go get獲取私有庫的相關資料，需要的朋友可以參考借鑒，下面來一起看看吧。2017-11-11
Golang使用Gin創(chuàng)建Restful API的實現(xiàn)
本文主要介紹了Golang使用Gin創(chuàng)建Restful API的實現(xiàn)，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2023-01-01
本文詳細介紹了Go語言中netpoll部分的實現(xiàn)細節(jié)和協(xié)程阻塞調度原理,特別是epoll在Linux環(huán)境下的工作原理,Go語言通過將epoll操作放在runtime包中,結合運行時調度功能,實現(xiàn)了高效的協(xié)程I/O操作,感興趣的朋友跟隨小編一起看看吧2024-11-11
利用Go語言快速實現(xiàn)一個極簡任務調度系統(tǒng)
任務調度（Task Scheduling）是很多軟件系統(tǒng)中的重要組成部分，字面上的意思是按照一定要求分配運行一些通常時間較長的腳本或程序。本文將利用Go語言快速實現(xiàn)一個極簡任務調度系統(tǒng)，感興趣的可以了解一下2022-10-10
淺析Go語言如何在select語句中實現(xiàn)優(yōu)先級
這篇文章主要為大家詳細介紹了Go語言如何在select語句中實現(xiàn)優(yōu)先級,文中的示例代碼講解詳細,感興趣的小伙伴可以跟隨小編一起學習一下2024-03-03