想必大家都有過這樣的體驗,在使用Mybatis時,最頭痛的就是寫分頁了,需要先寫一個查詢count的select語句,然后再寫一個真正分頁查詢的語句,當查詢條件多了之后,會發現真的不想花雙倍的時間寫 count 和 select,幸好我們有 pagehelper 分頁插件,pagehelper 是一個強大實用的 MyBatis 分頁插件,可以幫助我們快速的實現MyBatis分頁功能,而且pagehelper有個優點是,分頁和Mapper.xml完全解耦,并以插件的形式實現,對Mybatis執行的流程進行了強化,這有效的避免了我們需要直接寫分頁SQL語句來實現分頁功能。那么,接下來我們就來一起體驗下吧。
接下來,我們就通過實際案例來講解如何使用pagehelper來實現MyBatis分頁,為了避免重復篇幅,此篇教程的源碼基于《Spring Boot:整合MyBatis框架》一篇的源碼實現,讀者請先參考并根據教程鏈接先行獲取基礎源碼和數據庫內容。
首先,我們需要在 pom.xml 文件中添加分頁插件依賴包。
pom.xml
<!-- pagehelper -->
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper-spring-boot-starter</artifactId>
<version>1.2.5</version>
</dependency>
然后在 application.yml 配置文件中添加分頁插件有關的配置。
application.yml
# pagehelper
pagehelper:
helperDialect: mysql
reasonable: true
supportMethodsArguments: true
params: count=countSql
首先,在 DAO 層添加一個分頁查找方法。這個查詢方法跟查詢全部數據的方法除了名稱幾乎一樣。
SysUserMapper.java
package com.louis.springboot.demo.dao;
import java.util.List;
import com.louis.springboot.demo.model.SysUser;
public interface SysUserMapper {
int deleteByPrimaryKey(Long id);
int insert(SysUser record);
int insertSelective(SysUser record);
SysUser selectByPrimaryKey(Long id);
int updateByPrimaryKeySelective(SysUser record);
int updateByPrimaryKey(SysUser record);
/**
* 查詢全部用戶
* @return
*/
List<SysUser> selectAll();
/**
* 分頁查詢用戶
* @return
*/
List<SysUser> selectPage();
}
然后在 SysUserMapper.xml 中加入selectPage的實現,當然你也可以直接用@Select注解將查詢語句直接寫在DAO代碼,但我們這里選擇寫在XML映射文件,這是一個普通的查找全部記錄的查詢語句,并不需要寫分頁SQL,分頁插件會攔截查詢請求,并讀取前臺傳來的分頁查詢參數重新生成分頁查詢語句。
SysUserMapper.xml
<select id="selectPage" resultMap="BaseResultMap">
select
<include refid="Base_Column_List" />
from sys_user
</select>
服務層通過調用DAO層代碼完成分頁查詢,這里統一封裝分頁查詢的請求和結果類,從而避免因為替換ORM框架而導致服務層、控制層的分頁接口也需要變動的情況,替換ORM框架也不會影響服務層以上的分頁接口,起到了解耦的作用。
SysUserService.java
package com.louis.springboot.demo.service;
import java.util.List;
import com.louis.springboot.demo.model.SysUser;
import com.louis.springboot.demo.util.PageRequest;
import com.louis.springboot.demo.util.PageResult;
public interface SysUserService {
/**
* 根據用戶ID查找用戶
* @param userId
* @return
*/
SysUser findByUserId(Long userId);
/**
* 查找所有用戶
* @return
*/
List<SysUser> findAll();
/**
* 分頁查詢接口
* 這里統一封裝了分頁請求和結果,避免直接引入具體框架的分頁對象, 如MyBatis或JPA的分頁對象
* 從而避免因為替換ORM框架而導致服務層、控制層的分頁接口也需要變動的情況,替換ORM框架也不會
* 影響服務層以上的分頁接口,起到了解耦的作用
* @param pageRequest 自定義,統一分頁查詢請求
* @return PageResult 自定義,統一分頁查詢結果
*/
PageResult findPage(PageRequest pageRequest);
}
服務實現類通過調用分頁插件完成最終的分頁查詢,關鍵代碼是 PageHelper.startPage(pageNum, pageSize),將前臺分頁查詢參數傳入并攔截MyBtis執行實現分頁效果。
SysUserServiceImpl.java
package com.louis.springboot.demo.service.impl;
import java.util.List;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;
import com.louis.springboot.demo.dao.SysUserMapper;
import com.louis.springboot.demo.model.SysUser;
import com.louis.springboot.demo.service.SysUserService;
import com.louis.springboot.demo.util.PageRequest;
import com.louis.springboot.demo.util.PageResult;
import com.louis.springboot.demo.util.PageUtils;
@Service
public class SysUserServiceImpl implements SysUserService {
@Autowired
private SysUserMapper sysUserMapper;
@Override
public SysUser findByUserId(Long userId) {
return sysUserMapper.selectByPrimaryKey(userId);
}
@Override
public List<SysUser> findAll() {
return sysUserMapper.selectAll();
}
@Override
public PageResult findPage(PageRequest pageRequest) {
return PageUtils.getPageResult(pageRequest, getPageInfo(pageRequest));
}
/**
* 調用分頁插件完成分頁
* @param pageQuery
* @return
*/
private PageInfo<SysUser> getPageInfo(PageRequest pageRequest) {
int pageNum = pageRequest.getPageNum();
int pageSize = pageRequest.getPageSize();
PageHelper.startPage(pageNum, pageSize);
List<SysUser> sysMenus = sysUserMapper.selectPage();
return new PageInfo<SysUser>(sysMenus);
}
}
在控制器SysUserController中添加分頁查詢方法,并調用服務層的分頁查詢方法。
SysUserController.java
package com.louis.springboot.demo.controller;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import com.louis.springboot.demo.service.SysUserService;
import com.louis.springboot.demo.util.PageRequest;
@RestController
@RequestMapping("user")
public class SysUserController {
@Autowired
private SysUserService sysUserService;
@GetMapping(value="/findByUserId")
public Object findByUserId(@RequestParam Long userId) {
return sysUserService.findByUserId(userId);
}
@GetMapping(value="/findAll")
public Object findAll() {
return sysUserService.findAll();
}
@PostMapping(value="/findPage")
public Object findPage(@RequestBody PageRequest pageQuery) {
return sysUserService.findPage(pageQuery);
}
}
分頁查詢請求封裝類。
PageRequest.java
package com.louis.springboot.demo.util;
/**
* 分頁請求
*/
public class PageRequest {
/**
* 當前頁碼
*/
private int pageNum;
/**
* 每頁數量
*/
private int pageSize;
public int getPageNum() {
return pageNum;
}
public void setPageNum(int pageNum) {
this.pageNum = pageNum;
}
public int getPageSize() {
return pageSize;
}
public void setPageSize(int pageSize) {
this.pageSize = pageSize;
}
}
分頁查詢結果封裝類。
PageResult.java
package com.louis.springboot.demo.util;
import java.util.List;
/**
* 分頁返回結果
*/
public class PageResult {
/**
* 當前頁碼
*/
private int pageNum;
/**
* 每頁數量
*/
private int pageSize;
/**
* 記錄總數
*/
private long totalSize;
/**
* 頁碼總數
*/
private int totalPages;
/**
* 數據模型
*/
private List<?> content;
public int getPageNum() {
return pageNum;
}
public void setPageNum(int pageNum) {
this.pageNum = pageNum;
}
public int getPageSize() {
return pageSize;
}
public void setPageSize(int pageSize) {
this.pageSize = pageSize;
}
public long getTotalSize() {
return totalSize;
}
public void setTotalSize(long totalSize) {
this.totalSize = totalSize;
}
public int getTotalPages() {
return totalPages;
}
public void setTotalPages(int totalPages) {
this.totalPages = totalPages;
}
public List<?> getContent() {
return content;
}
public void setContent(List<?> content) {
this.content = content;
}
}
分頁查詢相關工具類。
PageUtils.java
package com.louis.springboot.demo.util;
import com.github.pagehelper.PageInfo;
public class PageUtils {
/**
* 將分頁信息封裝到統一的接口
* @param pageRequest
* @param page
* @return
*/
public static PageResult getPageResult(PageRequest pageRequest, PageInfo<?> pageInfo) {
PageResult pageResult = new PageResult();
pageResult.setPageNum(pageInfo.getPageNum());
pageResult.setPageSize(pageInfo.getPageSize());
pageResult.setTotalSize(pageInfo.getTotal());
pageResult.setTotalPages(pageInfo.getPages());
pageResult.setContent(pageInfo.getList());
return pageResult;
}
}
啟動應用,訪問:localhost:8088/swagger-ui.html,找到對應接口,模擬測試,結果如下。
參數:pageNum: 1, pageSize: 5
參數:pageNum: 2, pageSize: 4
學習更多JAVA知識與技巧,關注與私信博主(學習)
xcel表格頁圍與頁角這個地方就是設置頁角的地方,可以增加頁數,可以減少頁數。這里可以輸入公式加與減,但是輸入乘號或者除號是不行的,只能輸入加號和減號。
大家看一下,我把頁碼減到三,總頁碼加到二,然后大家看一下結果,第一頁就變成負二了,總頁數在二十六頁基礎上加了二變成二十八了。這個有什么用?如果想在表格預覽看一下,想在任何一頁的時候插入分頁符,想從分頁符那一頁開始算作一,就需要這種設置。
舉個例子,從這里隨便找個地方插入一個分頁符,預覽一下,這就是半張了,第一張不想讓它拍頁碼,只想讓這一張拍頁碼,這樣拍總頁碼還是二十六頁的總頁碼,這個時候在預覽的時候就可以從這設置了。
頁面距記憶一般就是頁眉頁角,頁碼減個一,總頁數減個一,這個時候再看,放大一下再看一下,袋就變成第一頁二十五頁了,一共二十五張,其中這是第一頁,但是看這下邊一共這是第二頁,一共第二十六頁,所以這種辦法就可以實現插入分頁符的時候按照自己想的頁開始算頁碼。
設計目的就是為了加速開發,減少xml的配置。如果你不想寫配置文件只需要在配置文件添加相對應的配置就能快速地啟動的程序。
通用mapper只支持對單表的操作,對單表的增刪改查,無需在mapper.xml寫對應的sql語句,只需要我們調用相應的接口即可。
pagehelper主要是在對查詢的數據進行一個分頁查詢。
<!-- pagehelp -->
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper-spring-boot-starter</artifactId>
<version>1.2.3</version>
</dependency>
<!-- 通用mapper -->
<dependency>
<groupId>tk.mybatis</groupId>
<artifactId>mapper-spring-boot-starter</artifactId>
<version>1.0.0</version>
</dependency>
2 新建一個mymapper.java文件,繼承mapper接口
public interface MyMapper<T> extends Mapper<T>, MySqlMapper<T>,ConditionMapper<T> {
//FIXME 特別注意,該接口不能被掃描到,否則會出錯
}
這個java文件不能和其它mapper放在一起,以免被掃描到。獲取單表數據的操作都直接調用這個方法。
3 在配置文件上添加以后屬性字段
#jdbc
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/news
spring.datasource.username=數據庫用戶名
spring.datasource.password=數據庫密碼
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.freemarker.request-context-attribute=request
#mapper
mapper.mappers=com.imooc.springboot.mapper.util.MyMapper
mapper.not-empty=false
mapper.identity=MYSQL
#pagehelper
pagehelper.helper-dialect = mysql
pagehelper.reasonable = true
pagehelper.support-methods-arguments = true
pagehelper.params= count= countSql
上面的配置mapper.mappers 是第2步里面文件所在的路徑。
4 添加了controller文件之后,由controller里面的方法去調用server里面的方法。雖然是有通用mapper方法,但是每次添加一個server方法之后都要添加對應的mapper方法,這樣開發的也顯得比較繁瑣,所以我們需要一個通用server類,用這個類去調用第二步的方法就可以了。
public interface BaseService<T> {
/**
* 查詢所有
*
* @return 返回所有數據
*/
List<T> findAll();
/**
* 添加
*
* @param t 實體
*
* @return
*/
int save(T t);
/**
* 修改
*
* @param t
* 實體
* @return
*/
int updateByPrimaryKey(T t);
/**
* 根據主鍵刪除
*
* @param t 主鍵
*
* @return
*/
int deleteByPrimaryKey(int t);
/**
* 查詢表格列表
* @param t 分頁參數
* @return
*/
TableData<T> getTableData(PageBean pageBean);
}
上面只是封裝基本增刪改查的方法,后續可自行添加方法。
然后添加實現類
public abstract class BaseServiceImpl<T> implements BaseService<T> {
@Autowired
protected MyMapper<T> mapper;
@Override
public List<T> findAll() {
return mapper.selectAll();
}
@Override
public int save(T t) {
return mapper.insert(t);
}
@Override
public int updateByPrimaryKey(T t) {
return mapper.updateByPrimaryKey(t);
}
@Override
public int deleteByPrimaryKey(int t) {
return mapper.deleteByPrimaryKey(t);
}
@Override
public TableData<T> getTableData(PageBean bean) {
int count = mapper.selectAll().size();
if (count > 0) {
PageHelper.startPage((bean.getOffset()/bean.getLimit()) + 1, bean.getLimit());
List<T> list = this.findAll();
return TableData.bulid(count, list);
}
return TableData.empty();
}
}
注意:我用的編輯器是eclipse,如果用idea編輯器,這里可把abstract去掉。
然后添加對應的接口和實現類繼承上面的接口和方法就可以了,比如添加一個newsserver 接口和newsserverImpl類
public interface NewsService extends BaseService<SysUser> {
}
@Service
public class NewsServiceImpl extends BaseServiceImpl<SysUser> implements NewsService{
}
5 為了減少數據庫服務器的壓力,一般我們查詢數據的時候都會使用pagehelper進行分頁查詢,為了更加清晰的顯示我們展示的數據,使用bootstrap table展示數據,bootstrap table獲取數據有兩種途徑,一種是客戶端模式,即獲取全部數據之后,在前端進行分頁展示。另外一種,也就是我們接下來要說的服務端模式:要獲取的數據信息,比如獲取數據頁碼,每一頁數據的大小,都可以通過前端發送以上的參數向后臺發請求,后臺得到這些參數信息之后返回數據。
6 引入bootstrap table相關的js css文件之后,開始在網上找了一些資料之后發現很多都是要在前端頁面添加如下繁瑣的配置,
$('#mytable').bootstrapTable({
//請求方法
method: 'get',
//是否顯示行間隔色
striped: true,
//是否使用緩存,默認為true,所以一般情況下需要設置一下這個屬性(*)
cache: false,
//是否顯示分頁(*)
pagination: true,
//是否啟用排序
sortable: false,
//排序方式
sortOrder: "desc",
//初始化加載第一頁,默認第一頁
//我設置了這一項,但是貌似沒起作用,而且我這默認是0,- -
//pageNumber:1,
//每頁的記錄行數(*)
pageSize: 10,
//可供選擇的每頁的行數(*)
pageList: [10, 25, 50, 100],
//這個接口需要處理bootstrap table傳遞的固定參數,并返回特定格式的json數據
url: "${contextPath}/mapper/getTableData",
//默認值為 'limit',傳給服務端的參數為:limit, offset, search, sort, order Else
//queryParamsType:'',
////查詢參數,每次調用是會帶上這個參數,可自定義
queryParams: queryParams : function(params) {
var subcompany = $('#subcompany option:selected').val();
var name = $('#name').val();
return {
pageNumber: params.offset+1,
pageSize: params.limit,
companyId:subcompany,
name:name
};
},
//分頁方式:client客戶端分頁,server服務端分頁(*)
sidePagination: "server",
//是否顯示搜索
search: false,
//Enable the strict search.
strictSearch: true,
//Indicate which field is an identity field.
idField : "id",
columns: [],
pagination:true
});
每次添加一個頁面如果都要添加以上的配置信息也顯得繁瑣,不過bootstrap-table.js里面有個默認的配置,只需要修改里面的幾個配置。
contentType: 'application/json',//post請求頭 application/x-www-form-urlencoded; charset=UTF-8'
dataType: 'json',
sidePagination: 'server', // 改成server
當我們點擊表格分頁頁碼的時候,獲取改變每頁顯示的頁碼時候,前端會自動調用queryParams()方法,我們需要將這些數據傳遞給后臺,
function queryParams(params) {
var query={};
query["limit"] = params.limit;//第幾條數據開始
query["offset"] = params.offset;//數據大小
return query;
}
6 配合上一步前端的分頁,我們就需要使用pagehelp插件了,同樣我們把這個分頁的方法放在通用server類上,
public TableData<T> getTableData(PageBean bean) {
int count = mapper.selectAll().size();
if (count > 0) {
PageHelper.startPage((bean.getOffset()/bean.getLimit()) + 1, bean.getLimit());
List<T> list = this.findAll();
return TableData.bulid(count, list);
}
return TableData.empty();
}
上面的pagehelper.startpage需要做一點改變,前端傳過來的是顯示第幾條數據,但是startpage方法第一個參數是顯示第幾頁的數據,所以做一個轉換pageoffset/limit +1,然后在查詢數據,需要注意的是,一定要將startpage方法方法查詢數據語句的前一行,不能空行,或者換行。
github源碼:https://github.com/jeremylai7/springboot-bootstrap.git
demo展示:https://www.jeremy7.cn/bootstrap/
*請認真填寫需求信息,我們會在24小時內與您取得聯系。