MyBatisPlus分页的同时指定排序规则说明
作者：梁云亮
分页配置
MyBatis Plus要想使用分页，需要添加如下配置：
@Configuration
@ConditionalOnClass(value = {PaginationInterceptor.class})
public class MybatisPlusConfig {
/**
* 分页插件
* @return
*/
@Bean
public PaginationInterceptor paginationInterceptor() {
PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
return paginationInterceptor; //返回分布拦截器
}
}
指定排序规则：
方法一
public PageBean<Category> listPage(int pageNum, int pageSize) {
IPage<Category> page = new Page<>(pageNum,pageSize);
QueryWrapper<Category> queryWrapper = new QueryWrapper<>();
queryWrapper.eq("state",1)
.orderByDesc("level");
IPage<Category> categoryIPage = categoryMapper.selectPage(page, queryWrapper);
return PageBean.init(categoryIPage);
}
方法二（不建议）
public PageBean<Category> listPage(int pageNum, int pageSize) {
IPage<Category> page = new Page<>(pageNum,pageSize);
QueryWrapper<Category> queryWrapper = new QueryWrapper<>();
queryWrapper.eq("state",1)
.orderBy("level")
.last("desc"); // 手动把sql拼接到最后(有sql注入的风险,请谨慎使用)
IPage<Category> categoryIPage = categoryMapper.selectPage(page, queryWrapper);
return PageBean.init(categoryIPage);
}
补充知识：解决mybatis-plus排序异常：failed to concat orderBy from IPage, exception=null
解决方案
String sql = "xxx"; // 放入不能正常进行排序的SQL语句
CCJSqlParserUtil.parse(sql); // 调用该方法，查看报错信息
根据parse方法执行时所抛出的异常信息中的line和column，定位出SQL语句中有问题的那一块代码，然后进行修正
将修正过后的SQL语句放入mapper中
注意，不要只看line和column给出位置的代码，要把其位置左右两边的代码也进行排查。
问题复现
pom.xml
<parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.0.8.RELEASE</version> <relativePath/> <!-- lookup parent from repository --> </parent> <properties> <java.version>1.8</java.version> </properties> <dependencies> ... <!-- mysql --> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <scope>runtime</scope> <version>5.1.48</version> </dependency> <!-- mybatis --> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.2.0</version> </dependency> ... </dependencies>
service层
Page<UserVO> page = new Page<>(pageNum, pageSize); // 构建分页对象 page.setOrders(List<OrderItem>); // 设入排序项 userMapper.selectList(page); // 调用mybatis进行查询
dao层
IPage<UserVO> selectList(page);
mapper
<mapper> <select id="selectList" resultType="com.demo.springboottest.vo.UserVO"> SELECT CONCAT(u.id, '/', u.group) AS groups FROM `user` u </select> </mapper>
执行selectList方法后，控制台出现：
failed to concat orderBy from IPage, exception=null
返回结果数据也没有按预期进行排序
排查过程
为了定位failed to concat orderBy from IPage错误信息的输出位置：
将mybatis-plus的日志配置修改为
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.slf4j.Slf4jImpl
将spring-boot日志输出格式配置为
logging.pattern.console=%d{yyyy/MM/dd-HH:mm:ss} [%thread] %-5level %logger- %msg%n
根据控制台输出failed to concat orderBy from IPage日志信息中的类名，定位到mybatis-plus-extension-3.2.0.jar中
com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor类的concatOrderBy方法
调试过程
对concatOrderBy方法的执行过程进行debug，得知在调用CCJSqlParserUtil的parse方法对sql语句进行解析时抛出了JSQLParserException异常
concatOrderBy方法对上述异常进行捕获，并打印日志信息:
failed to concat orderBy from IPage, exception
解决过程
对SQL进行修改，手动调用CCJSqlParserUtil的parse方法对修改后的语句进行调试
调试没问题后，将修正过的SQL语句放入mapper文件中
修正过后的SQL语句
SELECT CONCAT(u.id, '/', u.`group`) AS groups FROM `user` u
以上这篇MyBatisPlus分页的同时指定排序规则说明就是小编分享给大家的全部内容了，希望能给大家一个参考，也希望大家多多支持脚本之家。