# gin-pagination

**Repository Path**: ostaer/gin-pagination

## Basic Information

- **Project Name**: gin-pagination
- **Description**: 基于gorm实现的gin分页中间
- **Primary Language**: Go
- **License**: Apache-2.0
- **Default Branch**: gorm_io
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2020-12-26
- **Last Updated**: 2023-03-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

#### 使用说明

1.引入
```go
import "gitee.com/ostaer/gin-pagination"
```

2.使用中间件
```go
app := gin.New()
paginationHandler := pagination.New(&pagination.CustomeParser{})
app.Get("/test", paginationHandler)
```

3.gorm引用查询数据

测试请求如[`middleware_test.go` 110-115行](https://gitee.com/ostaer/gin-pagination/-/blob/gorm_io/middleware_test.go#L110-L115)

`
GET /test3?page=1&&size=3&&order=desc&&order_by=id&&is_child=true&&child_relation=1&&search.1.key=age&&search.1.value=5&&search.1.exactly=true&&search.2.key=email&&search.2.value=user-1,user-2&&search.2.exactly=false
`


查询处理如[`middleware_test.go` 211-214行](https://gitee.com/ostaer/gin-pagination/-/blob/gorm_io/middleware_test.go#L211-L214)

```go
// SELECT count(*) FROM `users`  WHERE ((`age` = "5") or ((`email` like "%user-1%") or (`email` like "%user-2%")))
DB.Model(&User{}).Scopes(pagination.PaginationScope(query, ip.Count)).Count(&count)
// SELECT * FROM `users`  WHERE ((`age` = "5") or ((`email` like "%user-1%") or (`email` like "%user-2%"))) ORDER BY id desc LIMIT 3 OFFSET 0
DB.Model(&User{}).Scopes(pagination.PaginationScope(query)).Find(&users)
```

4.拼接query
```go
var query = pagination.PaginationQuery{
    PageNum: 1, PageSize: 10,
}
query.Search = append(query.Search, pagination.SearchGroup{
    SearchTerm: pagination.SearchTerm{
        Raw: &pagination.RawQuery{
            Query: "user_name = ? or nick_name = ?",
            Args: []interface{}{
                "张三", "四",
            },
        },
    },
})
```
自己组装gorm的Scope
```go
var scope = func(db *gorm.DB) *gorm.DB {
	d := &pagination.PaginationQueryDB{DB: db, Query: query}
	d.ParseLimit().ParsePagination().ParseOrder()
	return d.DB
}
a.conn.Model(&model.Account{}).Scopes(scope).Where("id in ?", ids).Find(&accounts)
```


更多例子
参考middleware_test.go文件

#### 文件说明

|文件|说明|
|--|--|
| model.go | 分页查询相关struct的定义, 如`PaginationQuery` |
| customParser.go | 负责解析查询参数到`PaginationQuery` |
| resolver.go | 负责解析`PaginationQuery`到gorm.DB Scopes |
| middleware.go | 实现兼容gin的中间件 |