mybatis基于pagehelper插件实现分页功能

目录

一、背景

二、方法一

三、方法二

四、参考资料

五、总结

---

一、背景

        之前实现了下面的功能，现在就来实现一下mybatis的分页查询功能。提供两种实现方式，都是基于pagehelper插件实现的。项目地址见文末。

（1） spring boot整合mybatis 

（2）基于注解实现mybatis查询

---

二、方法一

1、引入pagehelper依赖

        <!--mybatis pagerhelper分页-->
        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper-spring-boot-starter</artifactId>
            <version>1.2.5</version>
        </dependency>

2、yml配置mybatis

pagehelper:
  helperDialect: mysql
  reasonable: true
  supportMethodsArguments: true
  params: count=countSql

3、基于mybatis注解实现user类的查询

/**
 * TestMapper
 *
 * @author jiankang.xu
 * @date 2021/9/20
 */
@Mapper
public interface TestMapper {

    @Results(id="getusers",value = {
            @Result(column = "uid",property = "uid"),
            @Result(column = "uname",property = "uname"),
            @Result(column = "upwd",property = "upwd")
    })
    @Select("select * from user ")
    List<User> selectUser();

}

4、controller实现如下。

（1）我们需要前端传数字类型的pageNum，pageSize

（2）在调用查询方法之前使用 PageHelper.startPage方法传入pageNum，pageSize值。

（3）只有在 PageHelper.startPage 方法之后立即执行的第一个 Mybatis 查询(select)方法才会被分页。

（4）然后使用pageInfo类传入查询结果，返回pageInfo。

package com.example.demo.controller;


/**
 * UserMapperController
 *
 * @author jiankang.xu
 * @date 2021/8/29
 */
@Controller
@RequestMapping("/mapper")
public class UserMapperController {

    @Autowired
    private UserService userService;


    @Autowired
    private VerifyUtils verifyUtils;


    /**
     * 实现分页第一种方式
     * @param pageNum
     * @param pageSize
     * @return
     */
    @RequestMapping("all")
    @ResponseBody
    public PageInfo<User> getAllUser(@Param("pageNum") String pageNum, @Param("pageSize") String pageSize) {
        if (!verifyUtils.isNumber(pageNum)) {
            pageNum = "1";
        }
        if (!verifyUtils.isNumber(pageSize)) {
            pageSize = "10";
        }
        PageHelper.startPage(Integer.valueOf(pageNum), Integer.valueOf(pageSize));
        List<User> users = userService.selectUser();
        PageInfo<User> userPageInfo = new PageInfo<>(users);
        return userPageInfo;
    }

}

5、验证传参是否是数字方法如下。

@Component
public class VerifyUtils {

    public static boolean isNumber(String s) {
        if (s == null || s.equals("")) {
            return false;
        }
        Pattern pattern = Pattern.compile("[0-9]*");
        Matcher isNum = pattern.matcher(s);
        if (!isNum.matches()) {
            return false;
        }
        return true;
    }

}

6、请求接口结果如下.

（1）查询第二页，每页五条 http://localhost:8081/mapper/all?pageNum=2&pageSize=5

（2）前台会返回下面的json格式数据，包括总页数，第一页等等内容。

{
    "total":105,
    "list":[
        {
            "uid":6,
            "uname":"test",
            "upwd":"password"
        },
        {
            "uid":7,
            "uname":"test",
            "upwd":"password"
        },
        {
            "uid":8,
            "uname":"test",
            "upwd":"password"
        },
        {
            "uid":9,
            "uname":"test",
            "upwd":"password"
        },
        {
            "uid":10,
            "uname":"test",
            "upwd":"password"
        }
    ],
    "pageNum":2,
    "pageSize":5,
    "size":5,
    "startRow":6,
    "endRow":10,
    "pages":21,
    "prePage":1,
    "nextPage":3,
    "isFirstPage":false,
    "isLastPage":false,
    "hasPreviousPage":true,
    "hasNextPage":true,
    "navigatePages":8,
    "navigatepageNums":[
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8
    ],
    "navigateFirstPage":1,
    "navigateLastPage":8,
    "firstPage":1,
    "lastPage":8
}

---

三、方法二

1、前面的依赖配置步骤都一样，跳过

2、mapper类查询方法如下

（1）在方法中，我们添加两个参数，分别是pageNum，pageSize。带这两个参数的话，pageHeler插件会在查询时自动进行分页。

@Mapper
public interface TestMapper {

    @Results(id="getusers",value = {
            @Result(column = "uid",property = "uid"),
            @Result(column = "uname",property = "uname"),
            @Result(column = "upwd",property = "upwd")
    })

    @Select("select * from user ")
    List<User> selectByPageNumSize(
            @Param("pageNum") int pageNum,
            @Param("pageSize") int pageSize);

}

3、controller类查询如下。

（1）跟方法一的区别是我们不需要在查询方法之前调用使用 PageHelper.startPage方法传入pageNum，pageSize值，直接将这两个值传给mapper方法即可。

package com.example.demo.controller;

import com.example.demo.mapper.TestMapper;
import com.example.demo.model.User;
import com.example.demo.service.UserService;
import com.example.demo.util.VerifyUtils;
import com.github.pagehelper.Page;
import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;
import org.apache.ibatis.annotations.Param;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;

import java.util.List;

/**
 * UserMapperController
 *
 * @author jiankang.xu
 * @date 2021/8/29
 */
@Controller
@RequestMapping("/mapper")
public class UserMapperController {

    @Autowired
    private UserService userService;


    @Autowired
    private VerifyUtils verifyUtils;


    @RequestMapping("all2")
    @ResponseBody
    public PageInfo<User> getAllUser2(@Param("pageNum") String pageNum, @Param("pageSize") String pageSize) {
        if (!verifyUtils.isNumber(pageNum)) {
            pageNum = "1";
        }
        if (!verifyUtils.isNumber(pageSize)) {
            pageSize = "10";
        }
        List<User> users = userService.selectByPageNumSize(Integer.valueOf(pageNum),Integer.valueOf(pageSize));
        PageInfo<User> userPageInfo = new PageInfo<>(users);
        return userPageInfo;
    }


}

4、当然还有其他方式，比如在实体类上添加pageNum，pageSize等等。

---

四、参考资料

1、how to use mybatis

https://github.com/pagehelper/Mybatis-PageHelper/blob/master/wikis/en/HowToUse.md#how-to-use

---

五、总结

以上就是实现mybatis基于pagehelper插件实现分页功能所有内容，希望能够帮到大家，可以git下载下来，参考一下，下面地址，切换到fenye-mybatis分支，觉得不错的话，欢迎微信搜索关注java基础笔记，后面会不断更新相关知识，大家一起进步。

GitHub - xujiankang6/spring-boot-researchhttps://github.com/xujiankang6/spring-boot-research.git