SpringBoot+Mybatis-plus實現(xiàn)分頁查詢的示例代碼

更新時間：2025年02月05日 10:29:04 作者：2301_81439082

本文主要介紹了SpringBoot+Mybatis-plus實現(xiàn)分頁查詢的示例代碼,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧

那么我們?nèi)绾螌崿F(xiàn)呢

首先，根據(jù)這張圖，我們需要幾個類

實體類，DTO，以及VO

這幾個類來干嘛？ DTO就是用來當形參的，VO就是來當返回信息的，實體類干嘛？先別急，聽我說

根據(jù)這張圖片，我們首先要實現(xiàn)對于人員姓名的模糊查詢，手機號的查詢，以及狀態(tài)的查詢

所以我們是不是就要傳三個字段username、phone、status呢

是的，然后我們定義一個dto類

@Data
@AllArgsConstructor
@NoArgsConstructor
@Api(tags = "用戶查詢列表")
public class QueryUserDto extends PageDto {

    @ApiModelProperty(value = "賬號")
    private String account;
    @ApiModelProperty(value = "用戶姓名")
    private String accName;
   @ApiModelProperty(value = "手機號")
    private String accPhone;
    @ApiModelProperty(value = "是否啟用(1:啟用,0:停用)")
    private Integer isEnable;
}

Api這些注解是用的swagger的，相當于是提示功能，這些都先不管，我們是不是定義好了幾個需要傳入的字段？ok ，那么我們剛剛說了既然是分頁功能，是不是要由total、pageSize等字段呢

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.Setter;

@Data
@Setter
@ApiModel(value = "分頁對象" ,description = "分頁查詢實體")
@NoArgsConstructor
public class PageDto {
    @ApiModelProperty(value = "頁碼",required = true)
    private  Integer PageNumber=1;
    @ApiModelProperty(value = "每頁顯示數(shù)量",required = true)
    private  Integer PageSize=10;
    @ApiModelProperty("排序字段")
    private  String sortBy;
    @ApiModelProperty("排序方式")
    private  Boolean isAsc;

}

這個就是我們需要傳入的分頁對象，可以說是一個查詢的模板，大家可以保存下來，要分頁的時候拿出來用就行了。我們剛剛定義的QueryUserDto繼承這個pageDto，相當于pageDto是一個父類，但我們用的是QueryUserDto，在實際情況中，我們可以通過需要傳入哪些字段進行查詢來定義我們QueryUserDto里面的字段

然后是返回對象VO，我們剛剛提到前端需要我們返回給他們Total，pages,records等字段，VO里面就封裝了這些字段，

import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

import java.util.List;
@Data
public class PageVO<T> {
   @ApiModelProperty(value = "每頁顯示的條數(shù)")
    private  Long size =10L;
   @ApiModelProperty(value = "當前頁")
    private Long current=1L;
   @ApiModelProperty(value = "總條數(shù)")
    private Long total;
   @ApiModelProperty(value = "總頁數(shù)")
    private Long pages;
   @ApiModelProperty(value = "分頁數(shù)據(jù)")
    private List<T> records;
}

這里面就封裝了前端需要的字段，每次返回給前端都會默認有這些字段，這也是一個模板，大家可以保存起來

然后就是具體的實現(xiàn)方法，首先就是mybatis-plus的分頁插件

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MyBatisConfig {

    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor(){
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
    }
}

這個就是mybatis-plus提供的分頁插件功能，我們配置好后進入下一步

創(chuàng)建相關的service接口類

里面的方法暫且可以不管，看PageUser這個方法

然后實現(xiàn)類serviceImpl

 @Override
    public R<?> PageUser(QueryUserDto queryUserDto)  {

        Page<AccountInfo> userPage = new Page<>(queryUserDto.getPageNumber(), queryUserDto.getPageSize());

        LambdaQueryWrapper<AccountInfo> queryWrapper =new LambdaQueryWrapper<>();
        if(queryUserDto.getIsEnable()!=null){
            queryWrapper.eq(AccountInfo::getIsEnable,queryUserDto.getIsEnable());
        }

        String accName=queryUserDto.getAccName();
        if (StringUtils.isNotBlank(accName)){
            accName=accName.trim();
            queryWrapper.like(AccountInfo::getAccName,accName);
        }
        String accPhone=queryUserDto.getAccPhone();
        if (StringUtils.isNotBlank(accPhone)){
            accPhone=accPhone.trim();
            queryWrapper.like(AccountInfo::getAccPhone,accPhone);
        }
        String account=queryUserDto.getAccount();
        if (StringUtils.isNotBlank(account)){
            account=account.trim();
            queryWrapper.like(AccountInfo::getAccount,account);
        }


        Page<AccountInfo> page = page(userPage,queryWrapper);

   

        PageVO<AccountInfo> userPageVO = new PageVO<>();
        BeanUtils.copyProperties(page,userPageVO);
        return R.Success("查詢成功",userPageVO);
    }

關于形參我在上面講到過，我們不用pageDto實現(xiàn)，而是用他的子類QueryUserDto來實現(xiàn)，因為是繼承關系，所以我們傳入他的子類QueryUserDto。

我們看起來這個代碼很復雜，其實我們可以分成三個板塊看就很清晰結構了

第一個

- 這部分聲明了一個Page類型的變量userPage，Page是MyBatis-Plus中用于分頁查詢的類。
- <AccountInfo>是泛型參數(shù)，表示這個分頁查詢將會返回AccountInfo類型的對象列表。AccountInfo是一個自定義的Java類，通常代表了某種數(shù)據(jù)庫表的結構。
new Page<>(queryUserDto.getPageNumber(), queryUserDto.getPageSize());：
- 這部分通過new Page<>()構造函數(shù)創(chuàng)建了一個Page實例。
- queryUserDto是一個數(shù)據(jù)傳輸對象（DTO），通常用于封裝從前端傳遞到后端的請求參數(shù)。在這個上下文中，它封裝了分頁查詢所需的頁碼和每頁大小。
- queryUserDto.getPageNumber()獲取請求中的頁碼（通常是從1開始的整數(shù)）。頁碼指定了用戶想要查看哪一頁的數(shù)據(jù)。
- queryUserDto.getPageSize()獲取請求中的每頁大小，即每頁應該顯示多少條數(shù)據(jù)。