# mybatis-pager

**Repository Path**: cat73/mybatis-pager

## Basic Information

- **Project Name**: mybatis-pager
- **Description**: 为 SpringBoot(基于 Servlet 的 Web 项目) + Mybatis 提供简单易用的分页查询支持
- **Primary Language**: Java
- **License**: LGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 57
- **Forks**: 8
- **Created**: 2019-03-09
- **Last Updated**: 2022-12-20

## Categories & Tags

**Categories**: database-dev

**Tags**: None

## README

# mybatis-pager-spring-boot-starter
一个`@Pager`注解搞定你的分页需求～

[![](https://img.shields.io/maven-central/v/org.cat73/mybatis-pager-spring-boot-starter.svg)](https://search.maven.org/search?q=g:org.cat73%20AND%20a:mybatis-pager-spring-boot-starter)
[![](https://img.shields.io/github/license/Cat7373/mybatis-pager.svg)](LICENSE)
[![](https://img.shields.io/badge/Repo-GitHub-blue.svg)](https://github.com/Cat7373/mybatis-pager)
[![](https://img.shields.io/badge/Repo-Gitee-blue.svg)](https://gitee.com/cat73/mybatis-pager)

## 功能说明
以前要做一个分页查询需要做的：

1. 每个接口都需要接收分页参数
2. 写一个查询特定页数据的`SQL`
3. 写一个查询总记录数的`SQL`
4. 写一个分页查询结果的实体类
5. 将结果拼到分页查询结果的实体类中，并响应给前端
6. 如果需要导出`Excel`，又需要写一堆`POI`操作

用这个包后需要做的：

1. 在需要分页查询的接口上增加`@Pager`这个注解
2. 写一个常规的查询(无需带分页)
3. 如果需要导出`Excel`，在`@Pager`上增加一点配置，再写一个简单的导出类即可

## 环境要求
* `Java8`及以上
* `SpringBoot1.2`及以上 + 基于`Servlet`的`Web`支持
* `Mybatis 3.x`

## 使用文档
1. [快速入门](docs/1.QuickStart.md)
2. [更新历史](CHANGELOG.md)

## 开发者
### 构建说明
执行下面的代码来构建

```sh
./gradlew clean jar
```

之后你会在`build/libs`里找到构建结果

### 签名
上传到中央库的包使用`GPG`进行签名，公钥可在[这里](https://blog.cat73.org/about/gpg.html)获得

## FAQ
* 为何没使用`Lombok`？
    * `Lombok`对非`Java`的语言如`Kotlin`不太友好，与其想支持时再去掉，不如一开始就不用

## 参考内容
> 仅按字母序进行排序，无先后顺序

* [Mybatis](https://github.com/mybatis/mybatis-3)
* [Mybatis-PageHelper](https://github.com/pagehelper/Mybatis-PageHelper)
* [Spring-Boot](https://github.com/spring-projects/spring-boot)

## TODO
* 支持`Spring4.1`及以上的版本