MybatisPlus分页查询【如何使用自定义sql语句】

前言

MybatisPlus结合了Mybatis和JPA的精华，让我们操作数据库非常的方便。具体的使用方式参考官网。

在使用MybatisPlus时，对于分页传搜索条件这块甚是苦恼。因为分页方法MybatisPlus提供了两个。如下：

    /**
     * 根据 entity 条件，查询全部记录（并翻页）
     *
     * @param page         分页查询条件（可以为 RowBounds.DEFAULT）
     * @param queryWrapper 实体对象封装操作类（可以为 null）
     */
    <E extends IPage<T>> E selectPage(E page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

    /**
     * 根据 Wrapper 条件，查询全部记录（并翻页）
     *
     * @param page         分页查询条件
     * @param queryWrapper 实体对象封装操作类
     */
    <E extends IPage<Map<String, Object>>> E selectMapsPage(E page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

从方法中可知，我们要想传搜索条件，只能封装成QueryWrapper对象去查询。

但是从前端传参数一般都习惯使用sql语句来传，到Mybatis这块还需要解析sql，然后转化成QueryWrapper对象，简直要疯掉。

那么如何解决呢？

分页查询配置及使用

参考官网我们知道，假如使用分页查询，需要先做一个配置，假如项目是基于springboot，配置如下：

@Configuration
public class MybatisPlusConfig {

    /**
     * 配置分页插件
     * @return
     */
    @Bean
    public PaginationInterceptor paginationInterceptor() {
        PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
        // 设置请求的页面大于最大页后操作， true调回到首页，false 继续请求  默认false
        // paginationInterceptor.setOverflow(false);
        // 设置最大单页限制数量，默认 500 条，-1 不受限制
        // paginationInterceptor.setLimit(500);
        // 开启 count 的 join 优化,只针对部分 left join
        paginationInterceptor.setCountSqlParser(new JsqlParserCountOptimize(true));
        return paginationInterceptor;
    }
}

然后就愉快的使用下边这两个方法即可：

    /**
     * 根据 entity 条件，查询全部记录（并翻页）
     *
     * @param page         分页查询条件（可以为 RowBounds.DEFAULT）
     * @param queryWrapper 实体对象封装操作类（可以为 null）
     */
    <E extends IPage<T>> E selectPage(E page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

    /**
     * 根据 Wrapper 条件，查询全部记录（并翻页）
     *
     * @param page         分页查询条件
     * @param queryWrapper 实体对象封装操作类
     */
    <E extends IPage<Map<String, Object>>> E selectMapsPage(E page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

简单的调用：

//创建查询条件对象
QueryWrapper<VAssetInfo> queryWrapper=new QueryWrapper<>();
queryWrapper.eq("menu_id",VAssetInfo.getParentNodeId());
//根据条件查询分页
Page<VAssetInfo> pageInfo=new Page<>(pageIndex,pageSize);
Page<VAssetInfo> pageInfo = vAssetInfoMapper.selectPage(pageInfo, queryWrapper);

这种方式的局限性也体现出来，就是需要将sql转化为对象去查询。查询条件简单的还好，稍微繁琐点就麻烦了，前后端需要定义一个规范才能做相应的转化。

前端传where后的条件sql，后端直接用sql查询多方便？

自定义sql实现

首先，需要在自己的Mapper接口对象中，自定义一个方法，比如：

public interface VAssetInfoMapper extends BaseMapper<VAssetInfo> {
    Page<VAssetInfo> getDataListBySql(Page page,String sql);
}

重点就是方法参数中的page以及返回类型Page<VAssetInfo>

接着在对应的mapper.xml文件中，配置对应方法，比如：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.ming.assetmanagement.mapper.asset.VAssetInfoMapper">
    <select id="getDataListBySql" parameterType="String" resultType="com.ming.entity.asset.VAssetInfo">
        select * from v_asset_info
        <if test="sql != null and sql != ''">
            where ${sql}
        </if>
    </select>
</mapper>

或者使用where标签

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.ming.assetmanagement.mapper.asset.VAssetInfoMapper">
    <select id="getDataListBySql" parameterType="String" resultType="com.ming.entity.asset.VAssetInfo">
        select * from v_asset_info
        <where>
              <if test="sql != null and sql != ''">
                ${sql}
              </if>
        </where>
    </select>
</mapper>

然后就是愉快的调用了，如下：

    Page<VAssetInfo> pageInfo=new Page<>(pageIndex,pageSize);
    pageInfo = vAssetInfoMapper.getDataListBySql(pageInfo,sql);

看上边三段代码，其实传入的page参数没用使用过，但神奇的就是，从数据库查询的返回结果就是你要的分页结果。

其实知道mybatis-plus分页原理的同学就不会惊讶，因为拦截器检测到Page对象后就做了相应的分页处理，所以会得到想要的结果，就是利用这个原理，实现了直传sql的方法。

总结

主要因为我遇到这个问题，想了半天，所以自己写一篇，给遇到类似困难的同学做个参考。