Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qm012/okk
go gin web develop tool library，paging，pageinfo object，sort，response
https://github.com/qm012/okk
gin go paging web
Last synced: about 4 hours ago
JSON representation
go gin web develop tool library，paging，pageinfo object，sort，response
- Host: GitHub
- URL: https://github.com/qm012/okk
- Owner: qm012
- License: apache-2.0
- Created: 2023-05-08T03:22:33.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-24T06:21:28.000Z (3 months ago)
- Last Synced: 2024-10-24T19:48:10.576Z (3 months ago)
- Topics: gin, go, paging, web
- Language: Go
- Homepage:
- Size: 70.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ok web develop tool library
[//]: # ([](https://github.com/qm012/okk/actions?query=branch%3Amian))
[//]: # ([](https://codecov.io/gh/qm012/okk))
[](https://pkg.go.dev/github.com/qm012/okk?tab=doc)
[](https://sourcegraph.com/github.com/qm012/okk?badge)
[](https://github.com/qm012/okk/releases)
go gin web develop tool library,includes pagination, middleware, pageSearch, response and other functions
## Getting started
### Getting okk
```sh
$ go get -u github.com/qm012/okk
```
With [Go module](https://github.com/golang/go/wiki/Modules) support, simply add the following import
```go
import "github.com/qm012/okk"
```
### Examples reference
#### Base info
```go
type SearchUserinfoReq struct {
Query string `json:"query" binding:"required,max=1000"`
okk.PageSearch
}
```
#### PageInfo
```go
// for gorm paging
// Part of the code is omitted
func gormPaging(req *SerchUserinfoReq) (*okk.PageInfo, err){
var (
count int64
userinfo Userinfo
)
err := *gorm.DB.Model(&userinfo).Select("id").Where(cmd, values...).Count(&count).Error
if err != nil {
return nil, err
}
userinfoList := make([]*Userinfo, 0, req.PageSize)
err = *gorm.DB.Where(cmd, values...).Order(req.SortByMysql(nil, "id")).Limit(req.PageSize).Offset(req.Offset(count)).Find(&userinfos).Error
if err !=nil {
return nil, err
}
info := okk.NewPageInfo(count, userinfoList).SetPageSize(req.PageNum, req.PageSize)
// info object can be used by the frontend
return info, nil
}
// for mongo paging
// Part of the code is omitted
func mongoPaging(req *SerchUserinfoReq) (*okk.PageInfo, err){
count, err := *mongo.Collection.CountDocuments(context.Background(), bson.D{})
if err != nil {
return nil, err
}
opt := options.Find().
SetLimit(int64(req.PageSize)).
SetSkip(int64(req.Offset(count)))
cursor,err:=*mongo.Collection.Find(ctx, filter, opt)
if err != nil {
return nil, err
}
userinfoList := make([]*Userinfo, 0, req.PageSize) // cursor.All(ctx, &userinfos)
info := okk.NewPageInfo(count, userinfoList).SetPageSize(req.PageNum, req.PageSize)
// info object can be used by the frontend
return info, nil
}
```
#### PageSearch
##### P.S.：The value of `offset` depends on whether the current page exceeds the maximum number of pages. By default, the maximum number of pages is the main number. You can also call `okk.DisableCalcPageNum()` to cancel the calculation，`okk.DisableCalcPageNum()` global valid
```go
func GetUserinfoService(req *SearchUserinfoReq) {
// get request object data
sortFieldMap := map[string]struct{}{
"id": {},
"name":{},
"sort":{},
}
// Prevents sql injection. Properties are valid when they exist in sortFieldMap
`example1：`*gorm.DB.Where(cmd, values...).Order(req.SortByMysql(sortFieldMap))
// req.SortField level gt customField
`example2：`*gorm.DB.Where(cmd, values...).Order(req.SortByMysql(sortFieldMap, "id"))
totalCount := 290 // total records，data source: Select/Find mysql/mongo data
offset:=req.Offset(totalCount)
`example mysql：`*gorm.DB.Where(cmd, values...).Limit(req.PageSize).Offset(offset)
`example mongo：`opt := options.Find().
SetLimit(int64(req.PageSize)).
SetSkip(int64(offset))
}
```
## License
The okk web tool is open-sourced software licensed under the [Apache license](./LICENSE).
## Acknowledgments
The following project had particular influence on okk's design.
- [pagehelper/Mybatis-PageHelper](https://github.com/pagehelper/Mybatis-PageHelper) Mybatis通用分页插件