Mybatis Plus 自定义方法实现分页

﹏ヽ暗。殇╰゛Y 2022-03-10 14:52 520阅读 0赞

一般物理分页，即通过sql语句分页，都是在sql语句后面添加limit分页语句，在xml文件里传入分页的参数，再多配置一条sql，用于查询总数：

<select id="queryStudentsBySql" parameterType="map" resultMap="studentmapper">        
             select * from student limit #{currIndex} , #{pageSize}     
         </select>
         <select id="queryStudentsCount" resultType="java.lang.Integer" parameterType="java.util.Map">       
            select count(*) from student     
         </select>

这样可以实现分页，但是每条sql都这样写，很冗余，而且不好维护，所以高级一点的方式就是自定义的一个拦截器，拦截所有需要分页的查询语句，并且利用获取到的分页相关参数统一在sql语句后面加上limit分页的相关语句，一劳永逸，不需要再每条语句都配置一下，拦截器具体怎么实现不说了，因为Mybatis Plus 已经有类似这样一个拦截器的分页插件，利用这个分页插件，不需要自己写拦截器就可以轻松实现分页查询：

[Mybatis-Plus][]（简称MP）是一个 Mybatis 的增强工具，在 Mybatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

**  1、 添加Mybatis-plus**

<dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus</artifactId>
                <version>2.1.8</version>
            </dependency>

2、配置拦截器

import com.baomidou.mybatisplus.plugins.PaginationInterceptor;    
    import org.springframework.context.annotation.Bean;    
    import org.springframework.context.annotation.Configuration;
        /**     
        * mybatis-plus配置     
        *     
        */    
        @Configuration    
        public class MybatisPlusConfig {
            /**         
            * 分页插件         
            */        
            @Bean        
            public PaginationInterceptor paginationInterceptor() {             
                PaginationInterceptor page = new PaginationInterceptor();             
                page.setDialectType("mysql");             
                return page;        
            }    
        }

3、service实现

传统的查询方式：

SELECT *
        FROM sys_user
        WHERE (name='张三' AND sex=0 AND age BETWEEN '18' AND '50')
        LIMIT 0,10

利用 Mybtis-plus,可以轻松实现分页查询

// 分页查询 10 条姓名为‘张三’、性别为男，且年龄在18至50之间的用户记录   
     List<User> userList = userMapper.selectPage(
            new Page<User>(1, 10),
            new EntityWrapper<User>().eq("name", "张三")
                    .eq("sex", 0)
                    .between("age", "18", "50")
     )

以上是单表查询的分页实现，多表查询，或者比较复杂的查询语句也可以轻松实现：

public Page<User> selectUserPage(Page<User> page, Integer state) {
            // 不进行 count sql 优化，解决 MP 无法自动优化 SQL 问题
            // page.setOptimizeCountSql(false);
            // 不查询总记录数
            // page.setSearchCount(false);
            // 注意！！ 分页 total 是经过插件自动 回写 到传入 page 对象
            return page.setRecords(userMapper.selectUserList(page, state));
        }

注意：需要根据前端传来的分页参数，当前第几页，每页多少条，构造一个page 对象，初始化这些参数，将page对象传递给mapper,拦截器会自动在sql语句加上limit查询，自动查询总记录数并写回page对象。

4 mapper 接口以及 xml

public interface UserMapper{//可以继承或者不继承BaseMapper
        /**
         * <p>
         * 查询 : 根据state状态查询用户列表，分页显示
         * </p>
         *
         * @param page
         *            翻页对象，可以作为 xml 参数直接使用，传递参数 Page 即自动分页
         * @param state
         *            状态
         * @return
         */
        List<User> selectUserList(Pagination page, Integer state);
    }

*  UserMapper.xml 等同于编写一个普通 list 查询，mybatis-plus 自动替你分页

<select id="selectUserList" resultType="User">
            SELECT * FROM user WHERE state=#{state}
        </select>

注意：一定要传递page参数，否则不能实现分页，查询sql 可以是多表联合查询的复杂语句。

[Mybatis-Plus]: https://baomidou.oschina.io/mybatis-plus-doc/#/quick-start