SpringBoot-MybatisHelper分页插件使用和粗浅分析

提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档

目录

前言

一、使用例子

二、底层粗浅分析

---

前言

提示：这里可以添加本文要记录的大概内容：

Srpingboot中拥有很有集成的插件，如Druid监控台，PageHelper分页插件等。一个小白刚接触SpringBoot，很多底层代码其实都不是很懂，只是会使用。其中，引入Mybatis依赖后使用PageHelper分页插件使得分页十分简单，这里做个例子总结和很粗浅的底层分析。

---

提示：以下是本篇文章正文内容，下面案例可供参考

一、使用例子

1、引入Starter依赖

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

2、创建一个Student数据表和对应的Student类

package com.example.mysql.bean;


import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Student {
    public String id;
    public String name;
    public String username;
    public String password;
    public String sex;
    public String major;
}

@AllArgsConstructor表示有参构造器 @NoArgsConstructor表示无参构造器  @Data表示同时使用了@ToString、@EqualsAndHashCode、@Getter、@Setter@RequiredArgsConstrutor，即平时的getname()，setname()等全部函数。

 3、创建Service服务和Mapper接口

package com.example.mysql.mapper;

import com.example.mysql.bean.Student;
import org.apache.ibatis.annotations.*;

import java.util.List;

@Mapper
public interface AccountMapper {
    @Select("select *from student")
    public List<Student> show_student();

}

package com.example.mysql.service;

import com.example.mysql.bean.Student;

import java.util.List;

public interface UserService{
    List<Student> show_student();
}

package com.example.mysql.service.Imp;

import com.example.mysql.bean.Student;
import com.example.mysql.mapper.AccountMapper;
import com.example.mysql.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class UserServiceImp implements UserService {
    @Autowired
    AccountMapper accountMapper;
    @Override
    public List<Student> show_student() {
        return accountMapper.show_student();
    }
}

4、创建访问的接口类

package com.example.mysql.controller;

import com.example.mysql.bean.Student;
import com.example.mysql.mapper.AccountMapper;
import com.example.mysql.service.UserService;
import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.jdbc.core.BeanPropertyRowMapper;
import org.springframework.jdbc.core.RowMapper;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import javax.annotation.Resource;
import javax.servlet.http.HttpSession;
import java.util.List;

@Controller
public class student {
    @Autowired
    AccountMapper accountMapper;
    @Resource
    UserService userService;
    @GetMapping ("/student")
    public String student_admin(@RequestParam(name = "page",defaultValue = "1") Integer page,HttpSession session,Model model){
        if(session==null)
        {
            return "login";
        }
        else {
            #一页一个数据进行分页查询
            PageHelper.startPage(page,1);
            List<Student> list=userService.show_student();
            #返回一个列表，列表中有各项数据值
            PageInfo<Student> pageInfo=new PageInfo<Student>(list);
            model.addAttribute("student_list",list);
            log.info(String.valueOf(pageInfo));
            model.addAttribute("pageInfo",pageInfo);
            return "student_admin";
        }
        }
}

PageInfo的各项数据值。

 

5、yaml配置

spring:
  mvc:
      hiddenmethod:
        filter:
          enabled: true
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/mydb2019?useUnicode=true&characterEncoding=UTF-8&useSSL=false&serverTimezone=Asia/Shanghai
    username: root
    password: root
pagehelper:
  helper-dialect: mysql  #指定数据库类型
  reasonable: true      #分页合理化,小于0查询第一页，大于总数查询最后一页
  support-methods-arguments: true #通过 Mapper 接口参数来传递分页参数
  params: count=countSql  #从对象中根据属性名取值

6、HTML的配置如下

            <div class="box-footer clearfix">
              <a role="button" th:href="@{/add}" class="btn btn-primary">
                <span class="glyphicon glyphicon-plus" aria-hidden="true"></span> 添加学生</a>
              <ul class="pagination pagination-sm no-margin pull-right">
                <li><a th:href="@{/student(page=${pageInfo.pageNum-1})}">&laquo;</a></li>
                <li th:each="num:${pageInfo.navigatepageNums}"><a th:href="@{/student(page=${num})}">[[${num}]]</a></li>
                <li><a th:href="@{/student(page=${pageInfo.pageNum+1})}">&raquo;</a></li>
              </ul>
            </div>

7、最终效果

 

二、底层粗浅分析

首先通过startPage进入，设置合理化，分页数量等。然后通过getlocalPage()查询是否进行过分页，没进行过分页则进入setLocalPage方法。

 getlocalpage()最终主要进入get()方法，获取是否存在之间分页的线程信息，有则直接返回。 

setlocalpage()方法进入set函数，创建新的分页信息，并且与当前线程进行绑定。

 当准备分页工作完成后，进入了PageIntercept拦截器，通过参数的数量创建缓存键后进入boundSql拦截，拦截要执行的Sql语句。

 

通过skip函数判断是否需要进行分页，beforeCount查询是否需要count查询，然后返回查询总书，如果查询结果是空，则返回。关键进入了pageQuery()函数。

 pageQuery()函数关键进入了getPagesql()函数，getPagesql()函数会通过配置的数据库类型进入不同的getPagesql()函数，如mysql进入如图的函数，通过拼接limit到拦截器拦截到的sql语句中，然后进行query()查询结果。查询到的结果通过afterpage()更新到当前的线程中，然后会进入finally以及remove函数，清除线程中查询的参数。最终程序将结果的集合返回到PageInfo()中。

---

总结

总的来说，PageHelper原理还是比较容易理解的，就是先将分页与线程绑定，如果线程中的Page绑定没有remove，下次还能使用，关键是通过拦截器拦截原生的Sql语句，拼接排序的orderby语句以及limit语句，进行sql查询后返回到PageInfo()中。当然因为比较菜，只能debug个大致，很多细节都忽略。