Mybatis分页插件PageHelper

￡神魔★判官ぃ 2021-06-24 16:12 608阅读 0赞

# 为什么使用PageHelper? #

在不使用插件的情况下，Mybatis实现分页是比较麻烦的。需要先写一个查询count的select语句，然后再写一个真正分页查询的语句，当查询条件多了之后，会发现真不想花双倍的时间写count和select，而且明显有大量重复代码。  
PageHelper分页插件能够根据select语句自动完成count，使得Mybatis的分页变得更加简洁。

# 如何使用PageHelper? #

### 配置分页插件 ###

直接从官网上copy的如下配置内容：

Config PageHelper
    
    1\. Using in mybatis-config.xml 
    
    <plugins>
        <plugin interceptor="com.github.pagehelper.PageInterceptor">
            
            <property name="param1" value="value1"/>
        </plugin>
    </plugins> 
    2\. Using in Spring application.xml
    
    config org.mybatis.spring.SqlSessionFactoryBean as following: 
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
      
      <property name="plugins">
        <array>
          <bean class="com.github.pagehelper.PageInterceptor">
            <property name="properties">
              
              <value> param1=value1 </value>
            </property>
          </bean>
        </array>
      </property>
    </bean>

这里使用第一种方法：

<plugins>
            <plugin interceptor="com.github.pagehelper.PageInterceptor">
                
                <property name="helperDialect" value="mysql"/>
            </plugin>
        </plugins>

关于mybatis整合spring的内容在此不再赘述。

### 编写mapper.xml文件 ###

简单的查询一个表，没有条件：

<select id="selectByPageAndSelections" resultMap="BaseResultMap">
            SELECT *
            FROM doc
            ORDER BY doc_abstract
    </select>

### 分页 ###

@Service
    public class DocServiceImpl implements IDocService {
        @Autowired
        private DocMapper docMapper;
    
        @Override
        public PageInfo<Doc> selectDocByPage1(int currentPage, int pageSize) {
            PageHelper.startPage(currentPage, pageSize);
            List<Doc> docs = docMapper.selectByPageAndSelections();
            PageInfo<Doc> pageInfo = new PageInfo<>(docs);
            return pageInfo;
        }
    }

使用了**PageHelper.startPage(currentPage, pageSize)**。  
这种方式不入侵mapper代码，插件对mybatis执行流程进行了增强，添加了limit以及count查询，属于**物理分页**。  
最后在controller中调用此Service的分页方法即可获得分页数据。

# 什么时候会导致不安全的分页？ #

PageHelper 方法使用了静态的 ThreadLocal 参数，分页参数和线程是绑定的。  
只要你可以保证在 PageHelper 方法调用后紧跟 MyBatis 查询方法，这就是安全的。因为 PageHelper 在 finally 代码段中自动清除了 ThreadLocal 存储的对象。  
如果代码在进入 Executor 前发生异常，就会导致线程不可用，这属于人为的 Bug（例如接口方法和 XML 中的不匹配，导致找不到 MappedStatement 时）， 这种情况由于线程不可用，也不会导致 ThreadLocal 参数被错误的使用。  
但是如果你写出下面这样的代码，就是不安全的用法：

PageHelper.startPage(1, 10);
    List<Country> list;
    if(param1 != null){
        list = countryMapper.selectIf(param1);
    } else {
        list = new ArrayList<Country>();
    }

这种情况下由于 param1 存在 null 的情况，就会导致 PageHelper 生产了一个分页参数，但是没有被消费，这个参数就会一直保留在这个线程上。当这个线程再次被使用时，就可能导致不该分页的方法去消费这个分页参数，这就产生了莫名其妙的分页。  
上面这个代码，应该写成下面这个样子：

List<Country> list;
    if(param1 != null){
        PageHelper.startPage(1, 10);
        list = countryMapper.selectIf(param1);
    } else {
        list = new ArrayList<Country>();
    }

这种写法就能保证安全。  
如果你对此不放心，你可以手动清理 ThreadLocal 存储的分页参数，可以像下面这样使用：

List<Country> list;
    if(param1 != null){
        PageHelper.startPage(1, 10);
        try{
            list = countryMapper.selectAll();
        } finally {
            PageHelper.clearPage();
        }
    } else {
        list = new ArrayList<Country>();
    }

这么写很不好看，而且没有必要。