Springboot注解，SpringBoot使用Mybatis-PageHelper

前言

之前一篇文章介紹了《SpringBoot+Mybatis+MySql學習》的整合，這一片擴展一下Mybatis的分頁插件-Mybatis-PageHelper。

新建項目

首先，pom文件中加入pagehelper依賴，完整pom代碼如下：

<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><groupId>com.dalaoyang</groupId><artifactId>springboot_mybatis_pagehelper</artifactId><version>0.0.1-SNAPSHOT</version><packaging>jar</packaging><name>springboot_mybatis_pagehelper</name><description>springboot_mybatis_pagehelper</description><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>1.5.9.RELEASE</version><relativePath/> <!-- lookup parent from repository --></parent><properties><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding><project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding><java.version>1.8</java.version></properties><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.mybatis.spring.boot</groupId><artifactId>mybatis-spring-boot-starter</artifactId><version>1.3.2</version></dependency><!--pagehelper --><dependency><groupId>com.github.pagehelper</groupId><artifactId>pagehelper-spring-boot-starter</artifactId><version>1.2.5</version></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-devtools</artifactId><scope>runtime</scope></dependency><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><scope>runtime</scope></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency></dependencies><build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId></plugin></plugins></build></project>

配置文件增加PageHelper的配置，由于demo很簡單，只用到了分頁，所以沒有增加其他配置，只設置了分頁方言，完整代碼如下：

##端口號
server.port=8888##日志級別
logging.level.com.dalaoyang.dao.UserMapper=debug##數據庫url
spring.datasource.url=jdbc:mysql://localhost:3306/test?characterEncoding=utf8&useSSL=false
##數據庫用戶名
spring.datasource.username=root
##數據庫密碼
spring.datasource.password=root
##數據庫驅動
spring.datasource.driver-class-name=com.mysql.jdbc.Driver#pagehelper分頁插件配置
pagehelper.helperDialect=mysql

Springboot注解？實體類User代碼如下：

package com.dalaoyang.entity;import org.apache.ibatis.type.Alias;/*** @author dalaoyang* @Description* @project springboot_learn* @package com.dalaoyang.entity* @email 397600342@qq.com* @date 2018/6/22*/
@Alias("user")
public class User {private int id;private String user_name;private String user_password;public User(String user_name, String user_password) {this.user_name = user_name;this.user_password = user_password;}public User(int id, String user_name, String user_password) {this.id = id;this.user_name = user_name;this.user_password = user_password;}public int getId() {return id;}public void setId(int id) {this.id = id;}public String getUser_name() {return user_name;}public void setUser_name(String user_name) {this.user_name = user_name;}public String getUser_password() {return user_password;}public void setUser_password(String user_password) {this.user_password = user_password;}
}

啟動類代碼如下：

package com.dalaoyang;import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;@SpringBootApplication
public class SpringbootMybatisPagehelperApplication {public static void main(String[] args) {SpringApplication.run(SpringbootMybatisPagehelperApplication.class, args);}
}

新建一個UserMapper，之前介紹的整合mybatis是使用的mapper方式，本文選擇使用注解方式，代碼如下：

package com.dalaoyang.dao;import com.dalaoyang.entity.User;
import com.github.pagehelper.Page;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Select;/*** @author dalaoyang* @Description* @project springboot_learn* @package com.dalaoyang.dao* @email 397600342@qq.com* @date 2018/6/22*/
@Mapper
public interface UserMapper {@Select("SELECT * FROM USER")Page<User> getUserList();
}

還是一如既往的使用controller作為測試，代碼如下：

package com.dalaoyang.controller;import com.dalaoyang.dao.UserMapper;
import com.dalaoyang.entity.User;
import com.github.pagehelper.Page;
import com.github.pagehelper.PageHelper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/*** @author dalaoyang* @Description* @project springboot_learn* @package com.dalaoyang.controller* @email 397600342@qq.com* @date 2018/6/22*/
@RestController
public class UserController {@AutowiredUserMapper userMapper;//http://localhost:8888/getUserList?pageNum=1&pageSize=2@RequestMapping("/getUserList")public Page<User> getUserList(Integer pageNum, Integer pageSize){PageHelper.startPage(pageNum, pageSize);Page<User>  userList= userMapper.getUserList();return userList;}
}

Mybatis框架，到這里項目就完全創建完成了。

測試

瀏覽器訪問http://localhost:8888/getUserList?pageNum=1&pageSize=2，結果如下：

然后查看控制臺如下：

java pagehelper。

可以看到sql已經進行分頁了。

然后回頭看controller的方法，返回的Page對象中包含了很多關于分頁的參數等數據，下面是Page的代碼，具體使用可以查看一下：

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//package com.github.pagehelper;import java.io.Closeable;
import java.util.ArrayList;
import java.util.List;public class Page<E> extends ArrayList<E> implements Closeable {private static final long serialVersionUID = 1L;private int pageNum;private int pageSize;private int startRow;private int endRow;private long total;private int pages;private boolean count;private Boolean reasonable;private Boolean pageSizeZero;private String countColumn;private String orderBy;private boolean orderByOnly;public Page() {this.count = true;}public Page(int pageNum, int pageSize) {this(pageNum, pageSize, true, (Boolean)null);}public Page(int pageNum, int pageSize, boolean count) {this(pageNum, pageSize, count, (Boolean)null);}private Page(int pageNum, int pageSize, boolean count, Boolean reasonable) {super(0);this.count = true;if (pageNum == 1 && pageSize == 2147483647) {this.pageSizeZero = true;pageSize = 0;}this.pageNum = pageNum;this.pageSize = pageSize;this.count = count;this.calculateStartAndEndRow();this.setReasonable(reasonable);}public Page(int[] rowBounds, boolean count) {super(0);this.count = true;if (rowBounds[0] == 0 && rowBounds[1] == 2147483647) {this.pageSizeZero = true;this.pageSize = 0;} else {this.pageSize = rowBounds[1];this.pageNum = rowBounds[1] != 0 ? (int)Math.ceil(((double)rowBounds[0] + (double)rowBounds[1]) / (double)rowBounds[1]) : 0;}this.startRow = rowBounds[0];this.count = count;this.endRow = this.startRow + rowBounds[1];}public List<E> getResult() {return this;}public int getPages() {return this.pages;}public Page<E> setPages(int pages) {this.pages = pages;return this;}public int getEndRow() {return this.endRow;}public Page<E> setEndRow(int endRow) {this.endRow = endRow;return this;}public int getPageNum() {return this.pageNum;}public Page<E> setPageNum(int pageNum) {this.pageNum = this.reasonable != null && this.reasonable && pageNum <= 0 ? 1 : pageNum;return this;}public int getPageSize() {return this.pageSize;}public Page<E> setPageSize(int pageSize) {this.pageSize = pageSize;return this;}public int getStartRow() {return this.startRow;}public Page<E> setStartRow(int startRow) {this.startRow = startRow;return this;}public long getTotal() {return this.total;}public void setTotal(long total) {this.total = total;if (total == -1L) {this.pages = 1;} else {if (this.pageSize > 0) {this.pages = (int)(total / (long)this.pageSize + (long)(total % (long)this.pageSize == 0L ? 0 : 1));} else {this.pages = 0;}if (this.reasonable != null && this.reasonable && this.pageNum > this.pages) {this.pageNum = this.pages;this.calculateStartAndEndRow();}}}public Boolean getReasonable() {return this.reasonable;}public Page<E> setReasonable(Boolean reasonable) {if (reasonable == null) {return this;} else {this.reasonable = reasonable;if (this.reasonable && this.pageNum <= 0) {this.pageNum = 1;this.calculateStartAndEndRow();}return this;}}public Boolean getPageSizeZero() {return this.pageSizeZero;}public Page<E> setPageSizeZero(Boolean pageSizeZero) {if (pageSizeZero != null) {this.pageSizeZero = pageSizeZero;}return this;}public String getOrderBy() {return this.orderBy;}public <E> Page<E> setOrderBy(String orderBy) {this.orderBy = orderBy;return this;}public boolean isOrderByOnly() {return this.orderByOnly;}public void setOrderByOnly(boolean orderByOnly) {this.orderByOnly = orderByOnly;}private void calculateStartAndEndRow() {this.startRow = this.pageNum > 0 ? (this.pageNum - 1) * this.pageSize : 0;this.endRow = this.startRow + this.pageSize * (this.pageNum > 0 ? 1 : 0);}public boolean isCount() {return this.count;}public Page<E> setCount(boolean count) {this.count = count;return this;}public Page<E> pageNum(int pageNum) {this.pageNum = this.reasonable != null && this.reasonable && pageNum <= 0 ? 1 : pageNum;return this;}public Page<E> pageSize(int pageSize) {this.pageSize = pageSize;this.calculateStartAndEndRow();return this;}public Page<E> count(Boolean count) {this.count = count;return this;}public Page<E> reasonable(Boolean reasonable) {this.setReasonable(reasonable);return this;}public Page<E> pageSizeZero(Boolean pageSizeZero) {this.setPageSizeZero(pageSizeZero);return this;}public Page<E> countColumn(String columnName) {this.countColumn = columnName;return this;}public PageInfo<E> toPageInfo() {PageInfo<E> pageInfo = new PageInfo(this);return pageInfo;}public PageSerializable<E> toPageSerializable() {PageSerializable<E> serializable = new PageSerializable(this);return serializable;}public <E> Page<E> doSelectPage(ISelect select) {select.doSelect();return this;}public <E> PageInfo<E> doSelectPageInfo(ISelect select) {select.doSelect();return this.toPageInfo();}public <E> PageSerializable<E> doSelectPageSerializable(ISelect select) {select.doSelect();return this.toPageSerializable();}public long doCount(ISelect select) {this.pageSizeZero = true;this.pageSize = 0;select.doSelect();return this.total;}public String getCountColumn() {return this.countColumn;}public void setCountColumn(String countColumn) {this.countColumn = countColumn;}public String toString() {return "Page{count=" + this.count + ", pageNum=" + this.pageNum + ", pageSize=" + this.pageSize + ", startRow=" + this.startRow + ", endRow=" + this.endRow + ", total=" + this.total + ", pages=" + this.pages + ", reasonable=" + this.reasonable + ", pageSizeZero=" + this.pageSizeZero + '}' + super.toString();}public void close() {PageHelper.clearPage();}
}

其他

關于更多Mybatis-PageHelper配置及介紹可以查看下面網站：
https://gitee.com/free/Mybatis_PageHelper
https://github.com/pagehelper/Mybatis-PageHelper/blob/master/wikis/zh/HowToUse.md

@SpringBootApplication、源碼下載 ：大老楊碼云

個人網站：https://www.dalaoyang.cn

關注作者公眾號