Java Mybatis

Mybatis-PageHelper

目前Mybatis-PageHelper支持对以下种类繁多的的数据库物理分页：

  1. static {
  2.     //注册别名
  3.     registerDialectAlias("hsqldb", HsqldbDialect.class);
  4.     registerDialectAlias("h2", HsqldbDialect.class);
  5.     registerDialectAlias("phoenix", HsqldbDialect.class);
  6.     registerDialectAlias("postgresql", PostgreSqlDialect.class);
  7.     registerDialectAlias("mysql", MySqlDialect.class); 
  8.     registerDialectAlias("mariadb", MySqlDialect.class); 
  9.     registerDialectAlias("sqlite", MySqlDialect.class);
  10.     registerDialectAlias("herddb", HerdDBDialect.class);
  11.     registerDialectAlias("oracle", OracleDialect.class); 
  12.     registerDialectAlias("oracle9i", Oracle9iDialect.class); 
  13.     registerDialectAlias("db2", Db2Dialect.class); 
  14.     registerDialectAlias("informix", InformixDialect.class); 
  15.     //解决 informix-sqli #129，仍然保留上面的 
  16.     registerDialectAlias("informix-sqli", InformixDialect.class);
  17.     registerDialectAlias("sqlserver", SqlServerDialect.class); 
  18.     registerDialectAlias("sqlserver2012", SqlServer2012Dialect.class);
  19.     registerDialectAlias("derby", SqlServer2012Dialect.class); 
  20.     //达梦数据库,https://github.com/mybatis-book/book/issues/43 
  21.     registerDialectAlias("dm", OracleDialect.class); 
  22.     //阿里云PPAS数据库,https://github.com/pagehelper/Mybatis-PageHelper/issues/281 
  23.     registerDialectAlias("edb", OracleDialect.class); 
  24.     //神通数据库 
  25.     registerDialectAlias("oscar", OscarDialect.class); 
  26.     registerDialectAlias("clickhouse", MySqlDialect.class); 
  27.     //瀚高数据库 
  28.     registerDialectAlias("highgo", HsqldbDialect.class); 
  29.     //虚谷数据库 
  30.     registerDialectAlias("xugu", HsqldbDialect.class); 
  31. }

当然，如果使用的数据库恰好不在这些范围之内，别着急，Mybatis-PageHelper还支持自定义配置，只需要配置 dialectAlias 参数，配置的内容根据 JDBCURL 自动获取对应实现，允许通过此种方式覆盖已有的实现，切记多个配置时使用分号隔开，举例如下：

  1. <property name="dialectAlias" value="oracle=com.github.pagehelper.dialect.helper.OracleDialect"/>

如何使用？

引入方式

两种，一种是直接引入jar包，一种是使用 Maven方式引入。
如果是后者，只需要在 pom.xml 中添加下面的依赖：

  1. <dependency>
  2.     <groupId>com.github.pagehelper</groupId>
  3.     <artifactId>pagehelper</artifactId>
  4.     <version>最新版本</version>
  5. </dependency>

配置拦截器

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

  1. <!-- 
  2.     plugins在配置文件中的位置必须符合要求，否则会报错，顺序如下:
  3.     properties?, settings?, 
  4.     typeAliases?, typeHandlers?, 
  5.     objectFactory?,objectWrapperFactory?, 
  6.     plugins?, 
  7.     environments?, databaseIdProvider?, mappers?
  8. -->
  9. <plugins>
  10.     <!-- com.github.pagehelper为PageHelper类所在包名 -->
  11.     <plugin interceptor="com.github.pagehelper.PageInterceptor">
  12.         <!-- 使用下面的方式配置参数，后面会有所有的参数介绍 -->
  13.         <property name="param1" value="value1"/>
  14.  </plugin>
  15. </plugins>

2、在Spring配置文件中配置拦截器插件

  1. <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
  2.   <!-- 注意其他配置 -->
  3.   <property name="plugins">
  4.     <array>
  5.       <bean class="com.github.pagehelper.PageInterceptor">
  6.         <property name="properties">
  7.           <!--使用下面的方式配置参数，一行配置一个 -->
  8.           <value>
  9.             params=value1
  10.           </value>
  11.         </property>
  12.       </bean>
  13.     </array>
  14.   </property>
  15. </bean>

插件参数

Mybatis-PageHelper提供了多个可选参数，如果小伙伴们想要实现自己的分页逻辑，也可以通过实现 Dialect(com.github.pagehelper.Dialect) 接口，来自定义 dialect 实现及参数。
下面介绍几个自带默认使用的常见参数：

1、helperDialect

分页插件会自动检测当前的数据库链接，自动选择合适的分页方式。通过配置helperDialect属性来指定分页插件使用哪种语言。

2、offsetAsPageNum

该参数对使用 RowBounds 作为分页参数时有效。当该参数设置为 true 时，会将 RowBounds 中的 offset 参数当成 pageNum 使用，可以用页码和页面大小两个参数进行分页。

3、 rowBoundsWithCount

该参数对使用 RowBounds 作为分页参数时有效。当该参数设置为true时，使用 RowBounds 分页会进行 count 查询。

4、pageSizeZero

该参数设置为 true 时，如果 pageSize=0 或者 RowBounds.limit = 0 就会查询出全部的结果（相当于没有执行分页查询，但是返回结果仍然是 Page 类型）。

5、 reasonable

分页合理化参数，当该参数设置为 true 时，pageNum<=0 时会查询第一页；pageNum>pages（超过总数时），会查询最后一页。

6、params

该参数来配置参数映射，用于从对象中根据属性名取值。

7、supportMethodsArguments

支持通过 Mapper 接口参数来传递分页参数，分页插件会从查询方法的参数值中，自动根据上面第6点 params 配置的字段中取值，查找到合适的值时就会自动分页。

8、autoRuntimeDialect

允许在运行时根据多数据源自动识别对应方言的分页

9、closeConn

当使用运行时动态数据源或没有设置 helperDialect 属性自动获取数据库类型时，会自动获取一个数据库连接，通过该属性来设置是否关闭获取的这个连接。

调用方式

下面是6种不同的调用方式：

  1. //第一种，RowBounds方式的调用
  2. List<User> list = sqlSession.selectList("x.y.selectIf", null, new RowBounds(0, 10));
  4. //第二种，Mapper接口方式的调用，推荐这种使用方式。
  5. PageHelper.startPage(1, 10);
  6. List<User> list = userMapper.selectIf(1);
  8. //第三种，Mapper接口方式的调用，推荐这种使用方式。
  9. PageHelper.offsetPage(1, 10);
  10. List<User> list = userMapper.selectIf(1);
  12. //第四种，参数方法调用
  13. //存在以下 Mapper 接口方法，你不需要在 xml 处理后两个参数
  14. public interface CountryMapper {
  15.     List<User> selectByPageNumSize(
  16.             @Param("user") User user,
  17.             @Param("pageNum") int pageNum, 
  18.             @Param("pageSize") int pageSize);
  19. }
  20. //配置supportMethodsArguments=true
  21. //在代码中直接调用：
  22. List<User> list = userMapper.selectByPageNumSize(user, 1, 10);
  24. //第五种，参数对象
  25. //如果 pageNum 和 pageSize 存在于 User 对象中，只要参数有值，也会被分页
  26. //有如下 User 对象
  27. public class User {
  28.     //其他fields
  29.     //下面两个参数名和 params 配置的名字一致
  30.     private Integer pageNum;
  31.     private Integer pageSize;
  32. }
  33. //存在以下 Mapper 接口方法，你不需要在 xml 处理后两个参数
  34. public interface CountryMapper {
  35.     List<User> selectByPageNumSize(User user);
  36. }
  37. //当 user 中的 pageNum!= null && pageSize!= null 时，会自动分页
  38. List<User> list = userMapper.selectByPageNumSize(user);
  40. //第六种，ISelect 接口方式
  41. //jdk6,7用法，创建接口
  42. Page<User> page = PageHelper.startPage(1, 10).doSelectPage(new ISelect() {
  43.     @Override
  44.     public void doSelect() {
  45.         userMapper.selectGroupBy();
  46.     }
  47. });
  48. //jdk8 lambda用法
  49. Page<User> page = PageHelper.startPage(1, 10).doSelectPage(()-> userMapper.selectGroupBy());
  51. //也可以直接返回PageInfo，注意doSelectPageInfo方法和doSelectPage
  52. pageInfo = PageHelper.startPage(1, 10).doSelectPageInfo(new ISelect() {
  53.     @Override
  54.     public void doSelect() {
  55.         userMapper.selectGroupBy();
  56.     }
  57. });
  58. //对应的lambda用法
  59. pageInfo = PageHelper.startPage(1, 10).doSelectPageInfo(() -> userMapper.selectGroupBy());
  61. //count查询，返回一个查询语句的count数
  62. long total = PageHelper.count(new ISelect() {
  63.     @Override
  64.     public void doSelect() {
  65.         userMapper.selectLike(user);
  66.     }
  67. });
  68. //lambda
  69. total = PageHelper.count(()->userMapper.selectLike(user));