PageHelper笔记

2021-08-22 约 1765 字预计阅读 4 分钟次阅读

/mybatis-pagehelper-note/featured-image.jpg

PageHelper是什么东西？

PageHelper是一个Mybatis的分页插件，其原理利用Mybatis提供的Interceptor接口创建了其实现类PageInterceptor类来实现分页功能。使用起来很方便，只需要简单的引入包，并且附加一行代码就可以实现在使用Mybatis时自动分页查询

如何使用PageHelper?

导入依赖的包，我这里使用的是spring boot starter的包, maven代码:

1
2
3
4
5


<dependency>
     <groupId>com.github.pagehelper</groupId>
     <artifactId>pagehelper-spring-boot-starter</artifactId>
      <version>1.2.13</version>
</dependency>

在代码中需要分页时，直接在mapper方法调用前，插入一行PageHelper类的分页method即可

1
2


PageHelper.startPage(taskPageVo.getPageNum(), taskPageVo.getPageSize()); //多种分页方法，具体查看PageHelper类
List<SaTask> saTasks = saTaskMapper.findTasks(userIds, taskPageVo.getStatus(), null, null);

使用PageHelper处理多个不同类型数据库数据源

上面的方法在单个数据源中或多个相同类型的数据库数据源中使用没有任何问题，但是在多个数据源中使用就会有问题。原因是不同的数据库分页的sql语句不一样，譬如mysql使用limit，sqlserver使用top，oracle使用rownum等等。而PageHelper为我们提供了方便，只要配置属性autoRuntimeDialect为true就可以完全支持不同类型数据库数据源分页了
针对上面的问题该如何解决，网上搜索了一下，大概有三种方式
方式一，在定义sessionFactory的时候，不同的数据源使用不同的PageInterceptor过滤

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50


    //mysql
    @Bean(name = "masterSqlSessionFactory")
    @Primary
    public SqlSessionFactory masterSqlSessionFactory(@Qualifier("masterDataSource") DataSource masterDataSource)
            throws Exception {
        final SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
        sessionFactory.setDataSource(masterDataSource);
        sessionFactory.setMapperLocations(new PathMatchingResourcePatternResolver().getResources(MysqlDataSourceConfig.MAPPER_LOCATION));
        sessionFactory.getObject().getConfiguration().setMapUnderscoreToCamelCase(true);//配置驼峰映射
        sessionFactory.getObject().getConfiguration().setLogImpl(StdOutImpl.class);

        //分页插件
        Interceptor interceptor = new PageInterceptor();
        Properties properties = new Properties();
        //分页数据库方言为mysql
        properties.setProperty("helperDialect", "mysql");
        //是否为分页数据库多个数据配置
        properties.setProperty("autoRuntimeDialect", "true");
        //是否分页合理化
        properties.setProperty("reasonable", "false");
        interceptor.setProperties(properties);
        sessionFactory.setPlugins(new Interceptor[] {interceptor});

        return sessionFactory.getObject();
    }

    //sqlserver
    @Bean(name = "clusterSqlSessionFactory")
    public SqlSessionFactory clusterSqlSessionFactory(@Qualifier("clusterDataSource") DataSource clusterDataSource)
            throws Exception {
        final SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
        sessionFactory.setDataSource(clusterDataSource);
        sessionFactory.setMapperLocations(new PathMatchingResourcePatternResolver().getResources(SqlserverDataSourceConfig.MAPPER_LOCATION));
//        sessionFactory.getObject().getConfiguration().setMapUnderscoreToCamelCase(true);//配置驼峰映射
        sessionFactory.getObject().getConfiguration().setLogImpl(StdOutImpl.class);

        //分页插件
        Interceptor interceptor = new PageInterceptor();
        Properties properties = new Properties();
        //分页数据库方言为sqlserver
        properties.setProperty("helperDialect", "sqlserver");
        //是否为分页数据库多个数据配置
        properties.setProperty("autoRuntimeDialect", "true");
        //是否分页合理化
        properties.setProperty("reasonable", "false");
        interceptor.setProperties(properties);
        sessionFactory.setPlugins(new Interceptor[] {interceptor});

        return sessionFactory.getObject();
    }

方式二：统一配置PageHelper Config类，实际上也就是统一配置PageInterceptor

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


  @Configuration
  public class PageHelperConfig {
    @Bean
    PageInterceptor pageInterceptor() {
        PageInterceptor pageInterceptor = new PageInterceptor();
        Properties properties = new Properties();
        properties.setProperty("offsetAsPageNum", "false");
        properties.setProperty("rowBoundsWithCount", "false");
        properties.setProperty("pageSizeZero", "true");
        properties.setProperty("reasonable", "false");
        properties.setProperty("supportMethodsArguments", "false");
        properties.setProperty("returnPageInfo", "none");
        properties.setProperty("autoRuntimeDialect", "true"); //处理多数据源数据库
        pageInterceptor.setProperties(properties);
        return pageInterceptor;
      }
  }

方式三：在application.yml文件中配置PageHelper的属性支持多数据源

1
2


  pagehelper:
    autoRuntimeDialect: true

在不同类型数据库的数据源情况下，正确的在spring boot 中使用PageHelper

使用方式一，看网络上的朋友，需要根据对应的sessionFactory创建SqlSessionTemplate，并且在Mapper上加分页参数，我没有测试过，但是感觉麻烦。
使用方式二，则可能简单方便点。但是方式一和方式二都有共同的问题，就是除非直接导入的依赖包是非spring boot starter包，而是直接导入pagehelper包，如：
1 2 3 4

<dependency> <groupId>com.github.pagehelper</groupId> <artifactId>pagehelper</artifactId> </dependency>

否则都会出现一个问题，第一次使用某个类型的数据库分页查询正确，后面使用的其他类型数据库分页查询都会失败。

使用方式三可以完全的使用PageHelper解决不同类型数据库数据源的分页问题。
方式一和方式二出现问题的根本原因是autoRuntimeDialect属性没有被设置上导致的。因为使用spring boot starter包时，每次服务器启动的时候spring容器都会去实例化PageHelperAutoConfiguration类，在这个类里会去读取yml文件中配置pagehelper属性，如果没有在yml中配置pagehelper.autoRuntimeDialect=true，那么它的值就为null，到时候PageHelper类就自动认为不是多数据源。HelperDialect 方言永远是第一次查询时的方言。
源码分析（由于篇幅有限，简单的截图说明）