Mybatis分頁插件使用方法詳解

這篇文章主要爲大家詳細介紹了Mybatis分頁插件的使用方法，具有一定的參考價值，感興趣的小夥伴們可以參考一下

本文實例爲大家分享了Mybatis分頁插件使用的具體代碼，供大家參考，具體內容如下

1.分頁插件簡介

pagehelper源碼

都說這是史上最好用的分頁插件，支持多種數據庫以多種方式分頁。

2.分頁插件的使用

2.1導入maven依賴

<dependency>
 <groupId>com.github.pagehelper</groupId>
 <artifactId>pagehelper</artifactId>
 <version>最新版本</version>
</dependency>

2.2 添加配置

1.在mybatis的config配置文件中添加攔截器 <plugin>

<!--
 plugins在配置文件中的位置必須符合要求，否則會報錯，順序如下:
 properties?, settings?,
 typeAliases?, typeHandlers?,
 objectFactory?,objectWrapperFactory?,
 plugins?,
 environments?, databaseIdProvider?, mappers?
-->
<plugins>
  <plugin interceptor="com.github.pagehelper.PageHelper">
   <property name="dialect" value="mysql"/>
   <!-- 該參數默認爲false -->
   <!-- 設置爲true時，會將RowBounds第一個參數offset當成pageNum頁碼使用 -->
   <!-- 和startPage中的pageNum效果一樣-->
   <property name="offsetAsPageNum" value="true"/>
   <!-- 該參數默認爲false -->
   <!-- 設置爲true時，使用RowBounds分頁會進行count查詢 -->
   <property name="rowBoundsWithCount" value="true"/>
   <!-- 設置爲true時，如果pageSize=0或者RowBounds.limit = 0就會查詢出全部的結果 -->
   <!-- （相當於沒有執行分頁查詢，但是返回結果仍然是Page類型）-->
   <property name="pageSizeZero" value="true"/>
   <!-- 3.3.0版本可用 - 分頁參數合理化，默認false禁用 -->
   <!-- 啓用合理化時，如果pageNum<1會查詢第一頁，如果pageNum>pages會查詢最後一頁 -->
   <!-- 禁用合理化時，如果pageNum<1或pageNum>pages會返回空數據 -->
   <property name="reasonable" value="false"/>
   <!-- 3.5.0版本可用 - 爲了支持startPage(Object params)方法 -->
   <!-- 增加了一個`params`參數來配置參數映射，用於從Map或ServletRequest中取值 -->
   <!-- 可以配置pageNum,pageSize,count,pageSizeZero,reasonable,不配置映射的用默認值 -->
   <!-- 不理解該含義的前提下，不要隨便複製該配置 -->
   <property name="params" value="pageNum=start;pageSize=limit;"/>
  </plugin>
</plugins>

2.或者在spring配置中添加

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
 <!-- 注意其他配置 -->
 <property name="plugins">
 <array>
  <bean class="com.github.pagehelper.PageInterceptor">
  <property name="properties">
   <!--使用下面的方式配置參數，一行配置一個 -->
   <value>
   params=value1
   </value>
  </property>
  </bean>
 </array>
 </property>
</bean>

這兩種方式不能同時用

3.在代碼中的使用

3.1設置一個基礎的請求類

public class BaseRequest implements Serializable {

 private static final long serialVersionUID = 1193444819529643410L;

 private Integer pageNum;//頁數
 private Integer pageSize;//每頁行數
 private Boolean count;//是否查詢總條數

 public Integer getPageNum() {
  return pageNum;
 }

 public void setPageNum(Integer pageNum) {
  this.pageNum = pageNum;
 }

 public Integer getPageSize() {
  return pageSize;
 }

 public void setPageSize(Integer pageSize) {
  this.pageSize = pageSize;
 }

 public Boolean getCount() {
  return count;
 }

 public void setCount(Boolean count) {
  this.count = count;
 }

 @Override
 public String toString() {
  return "BaseRequest{" +
    "pageNum=" + pageNum +
    ", pageSize=" + pageSize +
    '}';
 }
}

3.2 設置一個基礎的PageService 接口

讓每個service 去實現這個接口來設置分頁的初始值

public interface PageService {

 default void setDefaultPageInfo(BaseRequest baseRequest) {
  if (null != baseRequest) {
   baseRequest.setPageNum(null == baseRequest.getPageNum() ? Constants.PAGE_NUM : baseRequest.getPageNum());
   baseRequest
     .setPageSize(null == baseRequest.getPageSize() ? Constants.PAGE_SIZE : baseRequest.getPageSize());
   baseRequest.setCount(null == baseRequest.getCount() ? Boolean.TRUE : baseRequest.getCount());
  } else {
   baseRequest = new BaseRequest();
   baseRequest.setPageNum(Constants.PAGE_NUM);
   baseRequest.setPageSize(Constants.PAGE_SIZE);
   baseRequest.setCount(Boolean.TRUE);
  }
  PageHelper.startPage(baseRequest.getPageNum(), baseRequest.getPageSize(),baseRequest.getCount());
 }

}

3.3 如果做了數據轉換這用來複制屬性值(可選）

數據模型entity 只對應數據庫表中的字段， 出參與入參 都是數據傳輸對象 dto ， 從數據庫中查出來的是entity而 接口返回的是dto 所要BeanUtils.copyProperties複製屬性，和pageutils.copyProperties 複製分頁屬性

public class PageUtils {

 public static void copyProperties(PageInfo<?> source, PageInfo<?> des) {
  des.setEndRow(source.getEndRow());
  des.setFirstPage(source.getFirstPage());
  des.setHasNextPage(source.isHasNextPage());
  des.setHasPreviousPage(source.isHasPreviousPage());
  des.setIsFirstPage(source.isIsFirstPage());
  des.setIsLastPage(source.isIsLastPage());
  des.setNavigatepageNums(source.getNavigatepageNums());
  des.setNavigatePages(source.getNavigatePages());
  des.setNextPage(source.getNextPage());
  des.setOrderBy(source.getOrderBy());
  des.setPageNum(source.getPageNum());
  des.setPages(source.getPages());
  des.setPageSize(source.getPageSize());
  des.setPrePage(source.getPrePage());
  des.setSize(source.getSize());
  des.setStartRow(source.getStartRow());
  des.setTotal(source.getTotal());
 }
}

4.使用示例

在OrderService實現類中

import com.github.pagehelper.PageInfo;
import com.javxuan.common.util.PageUtils;
import com.javxuan.order.entity.Order;
import com.javxuan.order.response.OrderDto;
import com.javxuan.order.service.PageService;
import org.springframework.beans.BeanUtils;
import org.springframework.beans.factory.annotation.Autowired;

import java.util.ArrayList;

public class OrderServcieImpl implements IOrderServcie, PageService {

 @Autowired
 IOrderMapper orderMapper;

 @GetMapping("/order")
 public PageInfo<OrderDto> list(OrderRequest orderRequest){
  //設置默認分頁信息 PageService的方法
  setDefaultPageInfo(orderRequest);

  //查出order列表
  List<Order> orderList = orderMapper.selectList();
  //將entity的列表分頁
  PageInfo<Order> orderPageInfo = new PageInfo<>(orderList);

  //連續顯示5頁與上面的二選一
  //PageInfo<Order> orderPageInfo = new PageInfo<>(orderList，5);

  //定義一個數據傳輸對象dtoList
  List<OrderDto> dtoList = new ArrayList<>();
  if(null==orderList || orderList.size<=0){
   return null;
  }

  //給dtoList 加值
  for(Order order:orderList){
   OrderDto dto = new OrderDto();
   //將entity 的屬性值 複製給dto上
   BeanUtils.copyProperties(order, dto);
   dtoList.add(dto);
  }

  //給dto 分頁
  PageInfo<OrderDto> dtoPageInfo = new PageInfo<>(dtoList);

  //連續顯示5頁 與上面的二選一
  //PageInfo<Order> orderPageInfo = new PageInfo<>(orderList，5);

  //將entity的分頁信息複製給dtoPageInfo上
  PageUtils.copyProperties(orderPageInfo, dtoPageInfo);
  return dtoPageInfo;
 }
}

以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持神馬文庫。