springboot整合mybatis分页插件PageHelper实战

全栈程序员站长

发布于 2022-11-03 11:05:16

1.4K0

发布于 2022-11-03 11:05:16

一、在pom.xml文件中引入Pagehelper分页插件

注意： 我这里直接使用springboot在线模板创建的，即springboot2.6.0， springboot2.6.0默认情况完全禁止Bean的循环引用，当我们使用依赖注入@Resource和@Autowired时候，直接启动报错，说出现循环依赖等英文。

解决方法：你也可以通过下面的配置，放开不允许循环依赖的要求：

spring.main.allow-circular-references=true

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.6.0</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.example</groupId>
<artifactId>springboot-mabtis-pagehelper</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>springboot-mabtis-pagehelper</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<!--mysql驱动-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.22</version>
</dependency>
<!--druid-spring-boot-->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
<version>1.1.17</version>
</dependency>
<!--mybatis-spring-boot-->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.1.3</version>
</dependency>
<!--pagehelper-spring-boot-->
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper-spring-boot-starter</artifactId>
<version>1.2.5</version>
</dependency>
<!--web核心-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<version>2.5.0</version>
</dependency>
<!--lombok-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.22</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<!--springboot打包插件-->
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>

二、yml中配置分页插件等:

pagehelper.helper-dialect=mysql
pagehelper.params=count=countSql
pagehelper.reasonable=true
pagehelper.support-methods-arguments=true

或者yml:

server:
port: 8080
spring:
datasource:  #数据源连接信息
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://127.0.0.1:3306/test?characterEncoding=utf8&useSSL=false&serverTimezone=UTC&rewriteBatchedStatements=true
username: root
password: root
type: com.alibaba.druid.pool.DruidDataSource
main:  #springboot2.6要开启允许循环依赖
allow-circular-references: true
#mybatis的配置
mybatis:
mapper-locations: classpath:mapper/*.xml
type-aliases-package: com.example.springboot.entity
configuration:
map-underscore-to-camel-case: true
#分页插件的配置
pagehelper:
#配置四項 hprs
helper-dialect: mysql  #分页助手方言：mysql
params: count=countSql  #为了支持 startPage(Object params) 方法
support-methods-arguments: true  #支持通过 Mapper 接口参数来传递分页参数，默认值 false
reasonable: true #分页合理化参数，默认值为 false,页码不为负，不超总页码
logging: #打印sql拼接语句日志
level:
root: debug

配置参数说明：

helperDialect ：分页插件会自动检测当前的数据库链接，自动选择合适的分页方式。你可以配置helperDialect 属性来指定分页插件使用哪种方言。配置时，可以使用下面的缩写值：oracle , mysql , mariadb , sqlite , hsqldb , postgresql , db2 , sqlserver , informix , h2 , sqlserver2012 , derby特别注意：使用 SqlServer2012 数据库时，需要手动指定为 sqlserver2012 ，否则会使用 SqlServer2005 的方式进行分页。你也可以实现 AbstractHelperDialect ，然后配置该属性为实现类的全限定名称即可使用自定义的实现方法。
offsetAsPageNum ：默认值为 false ，该参数对使用 RowBounds 作为分页参数时有效。当该参数设置为true 时，会将 RowBounds 中的 offset 参数当成 pageNum 使用，可以用页码和页面大小两个参数进行分页。
rowBoundsWithCount ：默认值为 false ，该参数对使用 RowBounds 作为分页参数时有效。当该参数设置为 true 时，使用 RowBounds 分页会进行 count 查询。
pageSizeZero ：默认值为 false ，当该参数设置为 true 时，如果 pageSize=0 或者 RowBounds.limit =0 就会查询出全部的结果（相当于没有执行分页查询，但是返回结果仍然是 Page 类型）。
reasonable ：分页合理化参数，默认值为 false 。当该参数设置为 true 时， pageNum<=0 时会查询第一页， pageNum>pages （超过总数时），会查询最后一页。默认 false 时，直接根据参数进行查询。
params ：为了支持 startPage(Object params) 方法，增加了该参数来配置参数映射，用于从对象中根据属性名取值，可以配置 pageNum,pageSize,count,pageSizeZero,reasonable ，不配置映射的用默认值，默认值为pageNum=pageNum;pageSize=pageSize;count=countSql;reasonable=reasonable;pageSizeZero=pageSizeZero。
supportMethodsArguments ：支持通过 Mapper 接口参数来传递分页参数，默认值 false ，分页插件会从查询方法的参数值中，自动根据上面 params 配置的字段中取值，查找到合适的值时就会自动分页。使用方法可以参考测试代码中的 com.github.pagehelper.test.basic 包下的 ArgumentsMapTest 和ArgumentsObjTest 。
autoRuntimeDialect ：默认值为 false 。设置为 true 时，允许在运行时根据多数据源自动识别对应方言的分页（不支持自动选择 sqlserver2012 ，只能使用 sqlserver ），用法和注意事项参考下面的场景五。
closeConn ：默认值为 true 。当使用运行时动态数据源或没有设置 helperDialect 属性自动获取数据库类型时，会自动获取一个数据库连接，通过该属性来设置是否关闭获取的这个连接，默认 true 关闭，设置为false 后，不会关闭获取的连接，这个参数的设置要根据自己选择的数据源来决定

首先，在 DAO 层添加一个分页查找方法。这个查询方法跟查询全部数据的方法(除了名称)几乎一样。

三、数据库t_book：

四、实体类Book：

package com.example.springboot.entity;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Book {
private Integer id;
private String bookName;
private String bookAuthor;
private Double bookMoney;
public Book(String bookName, String bookAuthor, Double bookMoney) {
this.bookName = bookName;
this.bookAuthor = bookAuthor;
this.bookMoney = bookMoney;
}
}

五、BookDao接口(即mapper接口):

分页的返回值是List：

package com.example.springboot.dao;
import com.example.springboot.entity.Book;
import org.apache.ibatis.annotations.Mapper;
import org.springframework.stereotype.Repository;
import java.util.List;
@Mapper  //此注解可以加，也可以不加，因为我们在主启动类加了@MapperScan
@Repository //dao层的注解
public interface BookMaper {
//分页查询所有
public List<Book> selectAllByPage();
//动态条件查询加分页
public List<Book> selectByPageAndCondition(Book book);
}

然后在 BookDao.xml 中加入selectPage的实现，当然你也可以直接用@Select注解将查询语句直接写在DAO代码，但我们这里选择写在XML映射文件，这是一个普通的查找全部记录的查询语句，并不需要写分页SQL，分页插件会拦截查询请求，并读取前台传来的分页查询参数重新生成分页查询语句。

六、sql映射文件：

注意：selectAllByPage这个sql语句最后不能加分号，因为要拼接limit语句的。

BookDao.xml:

<?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">
<!--namespace对应mapper接口所在的位置-->
<mapper namespace="com.example.springboot.dao.BookDao">
<resultMap id="BaseResultMap" type="com.example.springboot.entity.Book">
<id column="id" property="id" jdbcType="INTEGER"></id>
<result column="book_name" property="bookName" jdbcType="VARCHAR"></result>
<result column="book_author" property="bookAuthor" jdbcType="VARCHAR"></result>
<result column="book_money" property="bookMoney" jdbcType="DOUBLE"></result>
</resultMap>
<sql id="BaseColumn">id,book_name,book_author,book_money </sql>
<!--public List<Book> selectAllByPage();-->
<select id="selectAllByPage" resultMap="BaseResultMap">
select <include refid="BaseColumn"></include>
from t_book 
</select>
<!--public List<Book> selectByPageAndCondition(Book book);-->
<select id="selectByPageAndCondition" parameterType="book" resultMap="BaseResultMap">
select <include refid="BaseColumn"></include>
from t_book
<where>
<if test="id!=null and id!='' ">id = #{id}</if>
<if test="bookName!=null and bookName!='' ">
<bind name="bookName" value=" '%'+bookName+'%' "/>
and book_Name like #{bookName}</if>
<if test="bookAuthor!=null and bookAuthor!='' ">
<bind name="bookAuthor" value=" '%'+bookAuthor+'%' "/>
and book_author like #{bookAuthor}</if>
<if test="bookMoney!=null and bookMoney!='' ">and book_money = #{bookMoney}</if>
</where>
</select>
</mapper>

服务层通过调用DAO层代码完成分页查询，这里统一封装分页查询的请求和结果类，从而避免因为替换ORM框架而导致服务层、控制层的分页接口也需要变动的情况，替换ORM框架也不会影响服务层以上的分页接口，起到了解耦的作用。

我们使用官方的PageInfo对结果进行包装,这样就不需要我们自己写一个封装分页结果的类了：

//获取第1页，10条内容，默认查询总数count
PageHelper.startPage(1, 10);
List<User> list = userMapper.selectAll();
//用PageInfo对结果进行包装
PageInfo page = new PageInfo(list);
//测试PageInfo全部属性
//PageInfo包含了非常全面的分页属性
assertEquals(1, page.getPageNum());
assertEquals(10, page.getPageSize());
assertEquals(1, page.getStartRow());
assertEquals(10, page.getEndRow());
assertEquals(183, page.getTotal());
assertEquals(19, page.getPages());
assertEquals(1, page.getFirstPage());
assertEquals(8, page.getLastPage());
assertEquals(true, page.isFirstPage());
assertEquals(false, page.isLastPage());
assertEquals(false, page.isHasPreviousPage());
assertEquals(true, page.isHasNextPage());

PageInfo中每个参数代表的意思示例：

pageNum=1,当前页码
pageSize=1,每页个数
size=1,当前页个数
startRow=1,由第几条开始
endRow=1,到第几条结束
total=3,总条数
pages=3,总页数
list= XXXX 查出出来的数据集合
prePage=0,上一页
nextPage=2,下一页
isFirstPage=true,是否为首页
isLastPage=false,是否为尾页
hasPreviousPage=false,是否有上一页
hasNextPage=true,是否有下一页
navigatePages=8,每页显示的页码个数
navigateFirstPage=1,首页
navigateLastPage=3,尾页
navigatepageNums=[1, 2, 3]}页码数

七、service层：

由于pageHelper插件内置了分页PageBean对象 : PageInfo，所以，这里使用主要有以下几个步骤：

1> 在service层进行分页

2> 设置分页参数 : PageHelper.startPage(page,size)，其中page为当前页，size为每页显示条数

3> 调用dao层的查询全部方法 : PageHelper插件会自动的对下边第一个查询方法进行分页

4> 封装返回值PageInfo；

分页的所有逻辑在这一层完成，包括分页信息的封装，参数传递等：

service接口：方法返回值为PageInfo：

package com.example.springboot.service;
import com.example.springboot.entity.Book;
import com.github.pagehelper.PageInfo;
public interface BookService {
/**
* 分页查询接口
* 这里统一封装了分页请求和结果，避免直接引入具体框架的分页对象, 如MyBatis或JPA的分页对象
* 从而避免因为替换ORM框架而导致服务层、控制层的分页接口也需要变动的情况，替换ORM框架也不会
* 影响服务层以上的分页接口，起到了解耦的作用
* 返回值：PageInfo（官方封装好的分页返回信息类）
*/
//分页参数这里必须带（因为前端一定会传递分页的两个参数的），分页的本质就是在server层进行包装和执行
public PageInfo<Book> selectAllByPageInfo(Integer pageNum, Integer pageSize);
//动态条件查询加分页
public PageInfo<Book> selectByPageAndCondition(Integer pageNum, Integer pageSize,Book book);
}

service实现类：分页方法的返回值也是PageInfo：

package com.example.springboot.service.impl;
import com.example.springboot.dao.BookDao;
import com.example.springboot.entity.Book;
import com.example.springboot.service.BookService;
import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.List;
@Service
public class BookserviceImpl implements BookService {
@Autowired
private BookDao bookDao;
@Override
public PageInfo<Book> selectAllByPageInfo(Integer pageNum, Integer pageSize) {
//1.分页的开始页的分页设置,分页一定要至少传递这两个参数
PageHelper.startPage(pageNum, pageSize);
//2.紧跟分页设置的后的第一个select查询会被分页查询
List<Book> books = bookDao.selectAllByPage();
//3.PageInfo参数navigatepage（导航页，显示的页码）：默认显示5个连续页,页码导航连续显示的页数5
PageInfo<Book> bookPageInfo = new PageInfo<Book>(books,5);
return bookPageInfo;
}
@Override
public PageInfo<Book> selectByPageAndCondition
(Integer pageNum, Integer pageSize, Book book) {
//1.分页助手开始分页
PageHelper.startPage(pageNum,pageSize);
//2.调用dao层的select查询方法，第一个select方法会被分页
List<Book> books = bookMaper.selectByPageAndCondition(book);
//3。封装分页结果到PageInfo中
PageInfo<Book> bookPageInfo = new PageInfo<>(books, 5);
return bookPageInfo;
}
}

八、controller:

package com.example.springboot.controller;
import com.example.springboot.entity.Book;
import com.example.springboot.service.BookService;
import com.github.pagehelper.PageInfo;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
@RestController
@Slf4j
public class BookController {
@Autowired
private BookService bookService;
@RequestMapping(value = "/selectAllByPage" ,method = RequestMethod.GET)
public PageInfo<Book> selectAllByPage(
@RequestParam(required = true,defaultValue = "1",value ="pageNum" )Integer pageNum,
@RequestParam(required = false,defaultValue = "5",value = "pageSize")Integer pageSize){
if(pageNum==null){
pageNum=1;
}
if(pageSize==null){
pageSize=10;
}
PageInfo<Book> pageInfo = bookService.selectAllByPageInfo(pageNum, pageSize);
return pageInfo;
}
@ResponseBody //动态查询的分页
@RequestMapping(value = "/selectByPageAndCondition",method = RequestMethod.GET)
public PageInfo<Book> selectByPageAndCondition(
@RequestParam(value = "pageNum",required = true,defaultValue = "1") Integer pageNum,
@RequestParam(value = "pageSize",required = false,defaultValue = "5") Integer pageSize,
Book book){
PageInfo<Book> bookPageInfo = bookService.selectByPageAndCondition(pageNum, pageSize, book);
return bookPageInfo;
}
}

九、postman测试：

数据库数据展示：

动态条件加分页的postman测试：

拓展：

使用pageHelper插件来分页，只需在执行sql前用即可

String orderBy = 排序字段 + ” desc”;//按照（数据库）排序字段倒序排序

PageHelper.startPage(pageNum, pageSize, orderBy)

或者： service实现类：

 @Override
public PageInfo<Book> selectByPageAndCondition
(Integer pageNum, Integer pageSize,String orderBy, Book book) {
//1.分页助手开始分页
PageHelper.startPage(pageNum,pageSize);
PageHelper.orderBy(orderBy); //排序的方法 PageHelper.orderBy(String orderBy)
//2.调用dao层的select查询方法，第一个select方法会被分页
List<Book> books = bookMaper.selectByPageAndCondition(book);
//3。封装分页结果到PageInfo中
PageInfo<Book> bookPageInfo = new PageInfo<>(books, 5);
return bookPageInfo;
}

controller:

@ResponseBody //动态查询的分页
@RequestMapping(value = "/selectByPageAndCondition",method = RequestMethod.GET)
public PageInfo<Book> selectByPageAndCondition(
@RequestParam(value = "pageNum",required = true,defaultValue = "1") Integer pageNum,
@RequestParam(value = "pageSize",required = false,defaultValue = "5") Integer pageSize,
@RequestParam(value = "orderBy",required = false) String orderBy,
Book book){
PageInfo<Book> bookPageInfo =
bookService.selectByPageAndCondition(pageNum, pageSize,orderBy, book);
return bookPageInfo;
}

发布者：全栈程序员栈长，转载请注明出处：https://javaforall.cn/179534.html原文链接：https://javaforall.cn

本文参与腾讯云自媒体同步曝光计划，分享自作者个人站点/博客。

原始发表：2022年10月21日，如有侵权请联系 cloudcommunity@tencent.com 删除

编程算法