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

简介: 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基础笔记,后面会不断更新相关知识,大家一起进步。


https://github.com/xujiankang6/spring-boot-research.git

目录
相关文章
|
10天前
|
SQL Java 数据库连接
MyBatis分页
MyBatis作为Java持久层框架,需结合数据库特性或插件实现分页。分页分为物理分页(如MySQL的LIMIT)和逻辑分页(内存截取),推荐使用PageHelper插件自动注入分页语句,提升开发效率与性能。需注意索引优化、深分页问题及多表关联时的兼容性,结合业务场景选择合适方案。
49 4
|
6月前
|
SQL Java 数据库连接
微服务——MyBatis分页
本文介绍了分页的多种实现方式,包括自带RowBounds分页、第三方插件PageHelper分页、SQL分页、数组分页及拦截器分页。其中,RowBounds是先查询全部结果再内存分页;PageHelper通过修改SQL动态添加分页关键字;SQL分页依赖数据库自身的分页功能如`LIMIT`;数组分页则是查询全量数据后用`subList`方法截取;拦截器分页则统一在SQL后添加分页语句。最后总结逻辑分页适合小数据量,但大数据量易内存溢出;物理分页虽小数据量效率较低,但更适合大数据场景,优先推荐使用。
89 0
|
6月前
|
SQL Oracle 关系型数据库
【YashanDB知识库】Mybatis-Plus调用YashanDB怎么设置分页
【YashanDB知识库】Mybatis-Plus调用YashanDB怎么设置分页
|
3月前
|
Java 数据库连接 数据库
Spring boot 使用mybatis generator 自动生成代码插件
本文介绍了在Spring Boot项目中使用MyBatis Generator插件自动生成代码的详细步骤。首先创建一个新的Spring Boot项目,接着引入MyBatis Generator插件并配置`pom.xml`文件。然后删除默认的`application.properties`文件,创建`application.yml`进行相关配置,如设置Mapper路径和实体类包名。重点在于配置`generatorConfig.xml`文件,包括数据库驱动、连接信息、生成模型、映射文件及DAO的包名和位置。最后通过IDE配置运行插件生成代码,并在主类添加`@MapperScan`注解完成整合
598 1
Spring boot 使用mybatis generator 自动生成代码插件
|
4月前
|
SQL Java 数据安全/隐私保护
发现问题:Mybatis-plus的分页总数为0,分页功能失效,以及多租户插件的使用。
总的来说,使用 Mybatis-plus 确实可以极大地方便我们的开发,但也需要我们理解其工作原理,掌握如何合适地使用各种插件。分页插件和多租户插件是其中典型,它们的运用可以让我们的代码更为简洁、高效,理解和掌握好它们的用法对我们的开发过程有着极其重要的意义。
499 15
|
6月前
|
SQL Java 关系型数据库
MyBatis篇-分页
本文介绍了多种分页方式,包括自带rowbound内存分页、第三方插件pagehelper(通过修改SQL实现分页)、SQL分页(依赖limit或rownum等关键字)、数组分页(先查询全部数据再用subList分页)、拦截器分页(自定义拦截器为SQL添加分页语句)。最后总结了逻辑分页(内存分页,适合小数据量)和物理分页(直接在数据库层面分页,适合大数据量)的优缺点,强调物理分页优先于逻辑分页。
|
6月前
|
XML Java 数据库连接
微服务——SpringBoot使用归纳——Spring Boot集成MyBatis——基于注解的整合
本文介绍了Spring Boot集成MyBatis的两种方式:基于XML和注解的形式。重点讲解了注解方式,包括@Select、@Insert、@Update、@Delete等常用注解的使用方法,以及多参数时@Param注解的应用。同时,针对字段映射不一致的问题,提供了@Results和@ResultMap的解决方案。文章还提到实际项目中常结合XML与注解的优点,灵活使用两者以提高开发效率,并附带课程源码供下载学习。
528 0
|
8月前
|
前端开发 Java 数据库连接
Java后端开发-使用springboot进行Mybatis连接数据库步骤
本文介绍了使用Java和IDEA进行数据库操作的详细步骤,涵盖从数据库准备到测试类编写及运行的全过程。主要内容包括: 1. **数据库准备**:创建数据库和表。 2. **查询数据库**:验证数据库是否可用。 3. **IDEA代码配置**:构建实体类并配置数据库连接。 4. **测试类编写**:编写并运行测试类以确保一切正常。
314 2
|
11月前
|
Java 数据库连接 Maven
mybatis使用一:springboot整合mybatis、mybatis generator,使用逆向工程生成java代码。
这篇文章介绍了如何在Spring Boot项目中整合MyBatis和MyBatis Generator,使用逆向工程来自动生成Java代码,包括实体类、Mapper文件和Example文件,以提高开发效率。
448 2
mybatis使用一:springboot整合mybatis、mybatis generator,使用逆向工程生成java代码。
|
11月前
|
SQL JSON Java
mybatis使用三:springboot整合mybatis,使用PageHelper 进行分页操作,并整合swagger2。使用正规的开发模式:定义统一的数据返回格式和请求模块
这篇文章介绍了如何在Spring Boot项目中整合MyBatis和PageHelper进行分页操作,并且集成Swagger2来生成API文档,同时定义了统一的数据返回格式和请求模块。
341 1
mybatis使用三:springboot整合mybatis,使用PageHelper 进行分页操作,并整合swagger2。使用正规的开发模式:定义统一的数据返回格式和请求模块