SpringBoot集成MyBatis-Plus实现分页查询

引入MyBatis-Plus依赖，下面注意指定自己的MyBatis-Plus版本。

<dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-boot-starter</artifactId><version>${mybatis-plus.version}</version>
</dependency>

配置分页查询插件，将其配置到启动类或者配置类都可以。

@Bean
@ConditionalOnMissingBean
public MybatisPlusInterceptor mybatisPlusInterceptor() {MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();PaginationInnerInterceptor paginationInnerInterceptor = new PaginationInnerInterceptor(DbType.MYSQL);paginationInnerInterceptor.setMaxLimit(200L);// 限制每页最多显示200条记录。interceptor.addInnerInterceptor(paginationInnerInterceptor);return interceptor;
}

准备好数据库表，以及对应的实体类，并且准备好对应的mapper以及service。

@TableName("t_user") // 注解设置实体类对应数据库的表名
@Data
@ToString
@NoArgsConstructor
@AllArgsConstructor
public class User {// MyBatisPlus默认将主键 id作为主键，但是表的字段名可能不是 id，可能是 uid之类的// @TableId注解将该属性作为主键，如遇到表中字段名不为id且是主键是要通过 @TableId注解// 若实体类和表中表示主键的不是id，而是其他字段，例如uid,程序抛出异常，Field 'uid' doesn't have a default value，说明MyBatis-Plus没有将uid作为主键赋值// value 属性用于指定主键的字段// type 属性用于指定自增策略(默认雪花算法)// IdType.AUTO 根据数据库最大id值自增(前提是设置了该字段设置了 auto_increment)// IdType.ASSIGN_ID 雪花算法生成 id(默认)// IdType.ASSIGN_UUID 生成UUID 作为字段的 id// IdType.NONE 不使用任何主键生成策略，由程序自行生成主键。@TableId(value = "id", type = IdType.ASSIGN_ID)private Long id;//非主键 -> 通过 @TableField("name")注解将实体类的属性映射到表的对应字段@TableField("name")private String name;private Integer age;private String email;private SexEnum sex;//逻辑删除(用于数据恢复)@TableLogicprivate Integer isDelete;
}
@Repository
public interface UserMapper extends BaseMapper<User> {}

封装vo类返回Page对象

import com.baomidou.mybatisplus.core.metadata.OrderItem;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import lombok.Data;import java.util.Objects;@Data
public class PageQuery<T> {private final static Integer DEFAULT_PAGE_NUM = 1;private final static Integer DEFAULT_PAGE_SIZE = 5;private Integer pageNo = DEFAULT_PAGE_NUM;private Integer pageSize = DEFAULT_PAGE_SIZE;private String sortBy = "age";// 排序字段，默认使用 ageprivate Boolean isAsc = true;// 排序方式，默认升序public Page<T> toMpPage(String sortBy, Boolean isAsc, Integer pageNo, Integer pageSize) {if (!StringUtils.isBlank(sortBy)) {this.sortBy = sortBy;}if (!Objects.isNull(isAsc)) {this.isAsc = isAsc;}if (!Objects.isNull(pageNo)) {this.pageNo = pageNo;}if (!Objects.isNull(pageSize)) {this.pageSize = pageSize;}Page<T> page = new Page<>(this.pageNo, this.pageSize);OrderItem orderItem = new OrderItem();orderItem.setAsc(this.isAsc);orderItem.setColumn(this.sortBy);page.addOrder(orderItem);return page;}
}

测试分页结果

public class TestPage {@Autowiredprivate UserMapper userMapper;@Testpublic void testPage() {PageQuery<User> pageQuery = new PageQuery<>();Page<User> page = pageQuery.toMpPage("age", true, 1, 5);Page<User> resPage = userMapper.selectPage(page, new LambdaQueryWrapper<>());// 传入page对象以及LambdaQueryWrapperSystem.out.println(resPage.getCurrent());// 当前页码System.out.println(resPage.getSize());// 每页显示条数System.out.println(resPage.getPages());// 总页数System.out.println(resPage.getTotal());// 总记录数List<User> records = resPage.getRecords();// 符合条件的记录records.forEach(System.out::println);}
}