Mybatis分页插件的使用流程

如果你也在用Mybatis，建议尝试该分页插件，这一定是最方便使用的分页插件。该插件支持任何复杂的单表、多表分页。

1.引入PageHelper的jar包

在pom.xml中添加如下依赖：

1 2 3 4 5

<dependency> <groupId>com.github.pagehelper</groupId> <artifactId>pagehelper</artifactId> <version>最新版本</version> </dependency>

2.配置拦截器插件

1.在 MyBatis 配置 xml 中配置拦截器插件

在Resource文件中mybatis的mybatis.xml配置文件中添加如下信息：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

plugins在配置文件中的位置必须符合要求，否则会报错，顺序如下: properties?, settings?, typeAliases?, typeHandlers?, objectFactory?,objectWrapperFactory?, plugins?, environments?, databaseIdProvider?, mappers? --> <plugins> <!-- com.github.pagehelper为PageHelper类所在包名 --> <plugin interceptor="com.github.pagehelper.PageInterceptor"> <!-- 使用下面的方式配置参数，后面会有所有的参数介绍 --> <property name="helperDialect" value="mysql"/> </plugin> </plugins>

2.分页插件参数介绍

分页插件提供了多个可选参数，这些参数使用时，按照上面两种配置方式中的示例配置即可。

分页插件可选参数如下：

• dialect：默认情况下会使用 PageHelper 方式进行分页，如果想要实现自己的分页逻辑，可以实现 Dialect(com.github.pagehelper.Dialect) 接口，然后配置该属性为实现类的全限定名称。

下面几个参数都是针对默认 dialect 情况下的参数。使用自定义 dialect 实现时，下面的参数没有任何作用。

1. helperDialect：分页插件会自动检测当前的数据库链接，自动选择合适的分页方式。 你可以配置helperDialect属性来指定分页插件使用哪种方言。配置时，可以使用下面的缩写值：
   oracle,mysql,mariadb,sqlite,hsqldb,postgresql,db2,sqlserver,informix,h2,sqlserver2012,derby
   特别注意：使用 SqlServer2012 数据库时，需要手动指定为 sqlserver2012，否则会使用 SqlServer2005 的方式进行分页。
   你也可以实现 AbstractHelperDialect，然后配置该属性为实现类的全限定名称即可使用自定义的实现方法。
2. offsetAsPageNum：默认值为 false，该参数对使用 RowBounds 作为分页参数时有效。 当该参数设置为 true 时，会将 RowBounds 中的 offset 参数当成 pageNum 使用，可以用页码和页面大小两个参数进行分页。
3. rowBoundsWithCount：默认值为false，该参数对使用 RowBounds 作为分页参数时有效。 当该参数设置为true时，使用 RowBounds 分页会进行 count 查询。
4. pageSizeZero：默认值为 false，当该参数设置为 true 时，如果 pageSize=0 或者 RowBounds.limit = 0 就会查询出全部的结果（相当于没有执行分页查询，但是返回结果仍然是 Page 类型）。
5. reasonable：分页合理化参数，默认值为false。当该参数设置为 true 时，pageNum<=0 时会查询第一页，pageNum>pages（超过总数时），会查询最后一页。默认false 时，直接根据参数进行查询。
6. params：为了支持startPage(Object params)方法，增加了该参数来配置参数映射，用于从对象中根据属性名取值， 可以配置 pageNum,pageSize,count,pageSizeZero,reasonable，不配置映射的用默认值， 默认值为pageNum=pageNum;pageSize=pageSize;count=countSql;reasonable=reasonable;pageSizeZero=pageSizeZero。
7. supportMethodsArguments：支持通过 Mapper 接口参数来传递分页参数，默认值false，分页插件会从查询方法的参数值中，自动根据上面 params 配置的字段中取值，查找到合适的值时就会自动分页。 使用方法可以参考测试代码中的 com.github.pagehelper.test.basic 包下的 ArgumentsMapTest 和 ArgumentsObjTest。
8. autoRuntimeDialect：默认值为 false。设置为 true 时，允许在运行时根据多数据源自动识别对应方言的分页 （不支持自动选择sqlserver2012，只能使用sqlserver），用法和注意事项参考下面的场景五。
9. closeConn：默认值为 true。当使用运行时动态数据源或没有设置 helperDialect 属性自动获取数据库类型时，会自动获取一个数据库连接， 通过该属性来设置是否关闭获取的这个连接，默认true关闭，设置为 false 后，不会关闭获取的连接，这个参数的设置要根据自己选择的数据源来决定。

重要提示：

当 offsetAsPageNum=false 的时候，由于 PageNum 问题，RowBounds查询的时候 reasonable 会强制为 false。使用 大专栏  Mybatis分页插件的使用流程PageHelper.startPage 方法不受影响。

3.如何在代码中使用（调用分页插件）

3.1Controller层

1 2 3 4 5 6 7 8 9 10 11 12 13 14

(value = "/test", method = RequestMethod.POST) public void (HttpServletRequest req, HttpServletResponse resp) throws IOException, SQLException { resp.setContentType("text/html;charset=UTF-8"); String parameter = new String(StreamResolve.InputStreamTOByte(req.getInputStream()), "UTF-8"); parameter = URLDecoder.decode(parameter, "utf-8"); Environment environment = (Environment) JsonUtils.getInstance().jsonStr2Object(parameter, Environment.class); //开始分页 PageHelper.startPage(environment.getPage(),environment.getPageSize()); List<Environment> allInfo = environmentService.getAllInfo(); PageInfo<Environment> pageInfo = new PageInfo<Environment>(allInfo); resp.getWriter().print(CommonLogic.jsonAssembly(Constant.SUCCESS_CODE, "SUCCESS", pageInfo)); } }

3.2Service层

1 2 3 4

public List<Environment> getAllInfo() { logger.info("API-getAllInfo-Service"); return environmentMapper.getAllInfo(); }

3.3编写一个mapper.xml文件

直接使用工程中的一个栗子，一个简单的查询。

1 2 3 4 5 6

<select id="getAllInfo" parameterType="Environment" resultMap="BaseResultMap"> SELECT * FROM t_module, t_company WHERE t_module.company_sid = t_company.company_sid </select>

对应的Mapper.java中接口如下：

1	List<Environment> getAllInfo();

3.4PageInfo类

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16

private int pageNum; //当前页 private int pageSize; //每页的数量 private int size; //当前页的数量 private int startRow; //当前页面第一个元素在数据库中的行号 private int endRow; //当前页面最后一个元素在数据库中的行号 private int pages; //总页数 private int prePage; //前面的页数 private int nextPage; //后面的页数 private boolean isFirstPage; //是否为第一页 private boolean isLastPage; //是否为最后一页 private boolean hasPreviousPage; //是否有前一页 private boolean hasNextPage; //是否有后一页 private int navigatePages; private int[] navigatepageNums; //页数导航 private int navigateFirstPage; private int navigateLastPage;

参考资料

https://pagehelper.github.io/

https://github.com/pagehelper/Mybatis-PageHelper/blob/master/wikis/zh/HowToUse.md

https://blog.csdn.net/qq_33624284/article/details/72828977