PageHelper插件

时间:2022-05-08
本文章向大家介绍PageHelper插件,主要内容包括一、使用、二、加载配置、三、运行、基本概念、基础应用、原理机制和需要注意的事项等,并结合实例形式分析了其使用技巧,希望通过本文能帮助到大家理解应用这部分内容。

一、使用

PageHelper.startPage(pn,5);  
//startPage后紧跟的这个查询就是分页查询  
List<Employee> emps = employeeService.getAll();  

二、加载配置

  1. PageHelperProperties
@ConfigurationProperties(prefix = PageHelperProperties.PAGEHELPER_PREFIX)
public class PageHelperProperties {
public static final String PAGEHELPER_PREFIX = "pagehelper";
  1. PageHelperAutoConfiguration

自定注入分页插件

@Configuration
@ConditionalOnBean(SqlSessionFactory.class)
@EnableConfigurationProperties(PageHelperProperties.class)
@AutoConfigureAfter(MybatisAutoConfiguration.class)
public class PageHelperAutoConfiguration {
@Autowired
private List<SqlSessionFactory> sqlSessionFactoryList;
@Autowired
private PageHelperProperties properties;
/**
 * 接受分页插件额外的属性
 *
 * @return
 */
@Bean
@ConfigurationProperties(prefix = PageHelperProperties.PAGEHELPER_PREFIX)
public Properties pageHelperProperties() {
    return new Properties();
}
@PostConstruct
public void addPageInterceptor() {
    PageInterceptor interceptor = new PageInterceptor();
    Properties properties = new Properties();
    //先把一般方式配置的属性放进去
    properties.putAll(pageHelperProperties());
    //在把特殊配置放进去,由于close-conn 利用上面方式时,属性名就是 close-conn 而不是 closeConn,所以需要额外的一步
    properties.putAll(this.properties.getProperties());
    interceptor.setProperties(properties);
    for (SqlSessionFactory sqlSessionFactory : sqlSessionFactoryList) {
        sqlSessionFactory.getConfiguration().addInterceptor(interceptor);
    }
}

被@PostConstruct修饰的方法会在服务器加载Servlet的时候运行, 并且在构造函数之后,init()方法之前运行。

第一步,配置随项目启动加载进来,存入interceptor中,放入mybatis的Conguration中。

三、运行

  1. startPage
setLocalPage(page);
protected static final ThreadLocal<Page> LOCAL_PAGE = new ThreadLocal<Page>();

设置ThreadLocal。

  1. SqlSessionInterceptor.invoke(..)

```

@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
  SqlSession sqlSession = getSqlSession(
      SqlSessionTemplate.this.sqlSessionFactory,
      SqlSessionTemplate.this.executorType,
      SqlSessionTemplate.this.exceptionTranslator);
  try {
    Object result = method.invoke(sqlSession, args);
    ..
    return result;
  } catch (Throwable t) {
    ..
  } finally {
    ..
  }
}

```

然后执行PageInterceptor。

  1. PageInterceptor.intercept()

判断是否进行分页,是否查询总数,在这里对sql进行加工,然后执行。