Springboot+Mybatis+Thymeleaf实现分页

前言：分页查询功能很常见，否则数据量很多都排在同一个页面的话，查看很不方便，之前用ssh搭建项目的时候写的分页功能是纯java实现的，界面的分页也是用的jsp编写，感觉不是很灵活，想换种实现方式。刚好最近在开始写一个SpringBoot的项目，界面用的是thymeleaf模板引擎，想实现一个查询所用用户但要分页显示的功能，百度到mybatis分页插件，于是开始动手了解。

如何使用分页插件

参考mybatis分页插件的官网文档先：https://pagehelper.github.io/docs/howtouse/
官方文档给我们讲得挺详细了，使用pagehelper插件可以实现

1、添加maven依赖

<!--mybatis分页插件-->
        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper-spring-boot-starter</artifactId>
            <version>1.2.5</version>
        </dependency>
<!--springboot整合mybatis-->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.3.2</version>
        </dependency>
<!--springboot整合thymeleaf-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>

2、application.yaml配置文件

#mybatis分页配置
pagehelper:
  helper-dialect: mysql
  reasonable: true
  support-methods-arguments: true
  params: count=countsql

3、userList.html页面部分

<!--显示分页信息部分代码-->
                        <div class="modal-footer no-margin-top">
                            <div class="col-md-6">
                                <strong>当前第 [[${pageInfo.pageNum}]]页,共 [[${pageInfo.pages}]] 页.一共 [[${pageInfo.total}]] 条记录
                                </strong>
                            </div>
                            <ul class="pagination pull-right no-margin">
                                <li th:if="${pageInfo.hasPreviousPage}">
                                    <a th:href="'/TBMS/admin/userList?pageNum=1'">首页</a>
                                </li>
                                <li class="prev" th:if="${pageInfo.hasPreviousPage}">
                                    <a th:href="'/TBMS/admin/userList?pageNum='+${pageInfo.prePage}">
                                        <i class="ace-icon fa fa-angle-double-left"></i>
                                    </a>
                                </li>
                                <!--遍历条数-->
                                <li th:each="nav:${pageInfo.navigatepageNums}">
                                    <a th:href="'/TBMS/admin/userList?pageNum='+${nav}" th:text="${nav}" th:if="${nav != pageInfo.pageNum}"></a>
                                    <span style="font-weight: bold;background: #6faed9;" th:if="${nav == pageInfo.pageNum}" th:text="${nav}" ></span>
                                </li>
                                <li class="next" th:if="${pageInfo.hasNextPage}">
                                    <a th:href="'/TBMS/admin/userList?pageNum='+${pageInfo.nextPage}">
                                        <i class="ace-icon fa fa-angle-double-right"></i>
                                    </a>
                                </li>
                                <li>
                                    <a th:href="'/TBMS/admin/userList?pageNum='+${pageInfo.pages}">尾页</a>
                                </li>
                            </ul>
                        </div>

4、mapper映射sql文件

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.zhbit.xiaojiang.mapper.UserMapper">
    <!--定义一个resultMap，关联查询用户角色信息-->
    <resultMap id="UserRoleResultMap" type="User">
        <!--id 主表唯一标识 result 普通标识-->
        <id column="userId" property="userId" />
        <result column="userName" property="userName" />
        <result column="password" property="password" />
        <result column="sex" property="sex" />
        <result column="address" property="address" />
        <result column="phone" property="phone" />
        <!--配置关联角色信息  多对一-->
        <association property="role" javaType="Role">
            <id column="roleId" property="roleId" />
            <result column="roleType" property="roleType" />
            <result column="roleName" property="roleName" />
            <result column="rolePower" property="rolePower" />
        </association>
    </resultMap>

    <select id="findByUserId" parameterType="String" resultMap="UserRoleResultMap">
      select u.*,roleType,roleName,rolePower
      from users u join roles r
      on u.roleId = r.roleId
      where userId = #{value}
    </select>

    <select id="findAllUser" resultMap="UserRoleResultMap">
        select u.*,roleType,roleName,rolePower
        from users u join roles r
        on u.roleId = r.roleId
    </select>

</mapper>

5、service实现类方法

/**
 * FileName: UserServiceImpl
 * Author:   小江
 * Date:     2019/12/26 21:12
 * History:
 */
package com.zhbit.xiaojiang.service.impl;

import com.zhbit.xiaojiang.entity.User;
import com.zhbit.xiaojiang.mapper.UserMapper;
import com.zhbit.xiaojiang.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class UserServiceImpl implements UserService {

    //自动注入userMapper接口
    @Autowired
    private UserMapper userMapper;

    @Override
    public User findByUserId(String userId) {
        return userMapper.findByUserId(userId);
    }

    @Override
    public List<User> findAllUser() {

        return userMapper.findAllUser();
    }

}

6、controller控制器方法

package com.zhbit.xiaojiang.controller;

import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;
import com.zhbit.xiaojiang.entity.User;
import com.zhbit.xiaojiang.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;

import java.util.List;

@Controller
public class UserController {

    @Autowired
    private UserService userService;

    @RequestMapping("/admin/userList")
    public String userList(Model model,
                           @RequestParam(required = false,defaultValue="1",value="pageNum")Integer pageNum,
                           @RequestParam(defaultValue="2",value="pageSize")Integer pageSize){
        //为了程序的严谨性，判断非空：
        //设置默认当前页
        if(pageNum==null || pageNum<=0){
            pageNum = 1;
        }
        //设置默认每页显示的数据数
        if(pageSize == null){
            pageSize = 1;
        }
        System.out.println("当前页是："+pageNum+"显示条数是："+pageSize);

        //1.引入分页插件,pageNum是第几页，pageSize是每页显示多少条,默认查询总数count
        PageHelper.startPage(pageNum,pageSize);
        //2.紧跟的查询就是一个分页查询-必须紧跟.后面的其他查询不会被分页，除非再次调用PageHelper.startPage
        try {
            List<User> userList = userService.findAllUser();
            System.out.println("分页数据："+userList);
            //3.使用PageInfo包装查询后的结果,5是连续显示的条数,结果list类型是Page<E>
            PageInfo<User> pageInfo = new PageInfo<User>(userList,pageSize);
            //4.使用model传参数回前端
            model.addAttribute("pageInfo",pageInfo);
            model.addAttribute("userList",userList);
        }finally {
            //清理 ThreadLocal 存储的分页参数,保证线程安全
            PageHelper.clearPage();
        }
        return "admin/userList";
    }
}

编写以上核心代码后就基本实现了，此篇文章没有放service接口的代码，没啥必要，接口就是其service实现类的方法名，还有entity实现类也没贴出来，这部分因数据库表而异。mybatis是一个半自动化的ORM框架，实现了sql代码与java代码的解耦，这一点从mapper映射文件就显而易见地体现了。

项目结构.png

项目效果图

图片.png

最后附参考文章，详细学习细节介绍大佬就在里面总结了，界面分页部分的代码和Controller部分代码借用此处，感谢：http://www.pianshen.com/article/6213345123/