美文网首页
MyBatis入门之分页插件PageHelper

MyBatis入门之分页插件PageHelper

作者: 80b7b6115d87 | 来源:发表于2017-11-10 11:32 被阅读288次

第一节. 项目前准备

1.PageHelper版本5.0.1
2.PageHelper官网地址
https://github.com/pagehelper/Mybatis-PageHelper/blob/master/README_zh.md

第二节. 创建项目

1.项目名称
mybatis-demo3

第三节. 添加依赖

<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.4.5</version>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>6.0.6</version>
    <scope>runtime</scope>
</dependency>
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>1.1.4</version>
</dependency>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-context</artifactId>
    <version>4.3.12.RELEASE</version>
</dependency>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-tx</artifactId>
    <version>4.3.12.RELEASE</version>
</dependency>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-jdbc</artifactId>
    <version>4.3.12.RELEASE</version>
</dependency>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-expression</artifactId>
    <version>4.3.12.RELEASE</version>
</dependency>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-test</artifactId>
    <version>4.3.12.RELEASE</version>
</dependency>
<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis-spring</artifactId>
    <version>1.3.1</version>
</dependency>
<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper</artifactId>
    <version>5.0.1</version>
</dependency>
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-core</artifactId>
    <version>1.1.7</version>
</dependency>
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.1.7</version>
</dependency>

第四节. 数据库sql文件

CREATE DATABASE mybatis_demo default character set utf8;

CREATE TABLE user(
 id INT(11) PRIMARY KEY AUTO_INCREMENT,
 username VARCHAR(100) NOT NULL COMMENT '用户名',
 email VARCHAR(100) COMMENT '邮件地址',
 age INT(11) COMMENT '性别',
 gender tinyint(1) COMMENT '性别',
 create_time timestamp NULL DEFAULT NULL COMMENT '创建时间',
 update_time timestamp NULL DEFAULT NULL ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间'
)ENGINE=InnoDB AUTO_INCREMENT=1000 DEFAULT CHARSET=utf8 COMMENT='用户表';

第五节. 代码部分

0.创建包路径
cn.im.domain  存放映射数据库表的实体对象类
cn.im.mapper  存放操作数据库表的基础接口
1.创建映射数据库表的实体对象User
package cn.im.domain;
import java.util.Date;
/**
 * Created by mybatis-demo
 * Author: hushuang
 * Date: 2017/11/9
 * Time: 上午10:11
 * Email: hd1611756908@163.com
 * Description :创建映射数据库的实体对象
 */
public class User {
    //用户ID
    private Integer id;
    //用户名称
    private String username;
    //用户邮箱
    private String email;
    //用户年龄
    private int age;
    //用户性别
    private int gender;
    //创建时间
    private Date createTime;
    //更新时间
    private Date updateTime;
    public User() {
    }
    public Integer getId() {
        return id;
    }
    public void setId(Integer id) {
        this.id = id;
    }
    public String getUsername() {
        return username;
    }
    public void setUsername(String username) {
        this.username = username;
    }
    public String getEmail() {
        return email;
    }
    public void setEmail(String email) {
        this.email = email;
    }
    public int getAge() {
        return age;
    }
    public void setAge(int age) {
        this.age = age;
    }
    public int getGender() {
        return gender;
    }
    public void setGender(int gender) {
        this.gender = gender;
    }
    public Date getCreateTime() {
        return createTime;
    }
    public void setCreateTime(Date createTime) {
        this.createTime = createTime;
    }
    public Date getUpdateTime() {
        return updateTime;
    }
    public void setUpdateTime(Date updateTime) {
        this.updateTime = updateTime;
    }
    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", username='" + username + '\'' +
                ", email='" + email + '\'' +
                ", age=" + age +
                ", gender=" + gender +
                ", createTime=" + createTime +
                ", updateTime=" + updateTime +
                '}';
    }
}
2.创建操作映射数据库基础接口UserMapper
package cn.im.mapper;
import cn.im.domain.User;
import com.github.pagehelper.PageRowBounds;
import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.session.RowBounds;
import java.util.List;
/**
 * Created by mybatis-demo
 * Author: hushuang
 * Date: 2017/11/9
 * Time: 下午1:48
 * Email: hd1611756908@163.com
 * Description : 测试分页查询
 */
public interface UserMapper {
    /**
     * 按页查询用户信息
     * @return
     */
    List<User> findPageUser();
    /**
     * Mapper接口方式的调用，推荐这种使用方式
     * 这种查询方式需要在xml配置文件中配置配置参数信息
     * @param pageNumKey : 当前页
     * @param pageSizeKey : 每页查询的数量
     * @return : 用户列表信息
     */
    List<User> findPageByNumAndSize(@Param("pageNumKey") int pageNumKey, @Param("pageSizeKey") int pageSizeKey);
    /**
     * 采用接口方式的配置RowBounds参数
     * PageRowBounds 是继承 RowBounds的子类，因为RowBounds没有提供查询数量总数，但是PageRowBounds可以获取到
     * @param rowBounds
     * @return
     */
    List<User> findPageByRowNum(RowBounds rowBounds);
}
3.在resources文件夹下创建mapper文件夹用于存放映射接口的xml文件UserMapper.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="cn.im.mapper.UserMapper">

    <select id="findPageUser" resultType="cn.im.domain.User">
        SELECT id,username,email,age,gender,create_time as createTime,update_time as updateTime FROM user
    </select>

    <select id="findPageByNumAndSize" resultType="cn.im.domain.User" parameterType="int">
        SELECT id,username,email,age,gender,create_time as createTime,update_time as updateTime FROM user
    </select>

    <select id="findPageByRowNum" resultType="cn.im.domain.User">
        SELECT id,username,email,age,gender,create_time as createTime,update_time as updateTime FROM user
    </select>
</mapper>
4.在resources文件夹下创建applicationContext.xml文件进行框架整合
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:tx="http://www.springframework.org/schema/tx"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
                           http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.3.xsd
                           http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.3.xsd">


    <!-- 导入数据库连接池配置的属性文件 -->
    <context:property-placeholder location="classpath:db.properties" />

    <!-- 数据库连接池设置
         设置参考链接官网：https://github.com/alibaba/druid/wiki/%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98
         下面的《9. Druid有没有参考配置》
         1.配置数据源Druid
     -->

    <bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource"
          init-method="init" destroy-method="close">
        <!-- 基本属性 url、user、password -->
        <property name="url" value="${jdbc.url}" />
        <property name="username" value="${jdbc.username}" />
        <property name="password" value="${jdbc.password}" />

        <!-- 配置初始化大小、最小、最大 -->
        <property name="initialSize" value="1" />
        <property name="minIdle" value="1" />
        <property name="maxActive" value="20" />

        <!-- 配置获取连接等待超时的时间 -->
        <property name="maxWait" value="60000" />

        <!-- 配置间隔多久才进行一次检测，检测需要关闭的空闲连接，单位是毫秒 -->
        <property name="timeBetweenEvictionRunsMillis" value="60000" />

        <!-- 配置一个连接在池中最小生存的时间，单位是毫秒 -->
        <property name="minEvictableIdleTimeMillis" value="300000" />
        <property name="validationQuery" value="SELECT 'x'" />
        <property name="testWhileIdle" value="true" />
        <property name="testOnBorrow" value="false" />
        <property name="testOnReturn" value="false" />
        <!-- 打开PSCache，并且指定每个连接上PSCache的大小 -->
        <property name="poolPreparedStatements" value="false" />
        <property name="maxPoolPreparedStatementPerConnectionSize" value="20" />
        <!-- 配置监控统计拦截的filters -->
        <property name="filters" value="stat" />
    </bean>
    <!--
        2.注册sqlsessionFactory
        俗话说为什么这么配置，我是怎么知道这么配置的：追本溯源当然是mybatis-spring这个依赖提供的整合方式
        中文官网地址：http://www.mybatis.org/spring/zh/index.html    官网介绍了下面的 2 3 4 步，都在官网中。
    -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <!-- 装配druid数据源 -->
        <property name="dataSource" ref="dataSource"></property>
        <!-- 导入mybatis全局配置文件 -->
        <property name="configLocation" value="classpath:mybatis-config.xml"></property>
        <!-- 扫描entity包，使用别名 -->
        <property name="typeAliasesPackage" value="cn.im.domain"></property>
        <!-- 配置sql映射文件位置 -->
        <property name="mapperLocations" value="classpath:mapper/*.xml"></property>
    </bean>
    <!-- 3.注册dao接口，动态实现dao接口配置，注入到spring容器中 -->
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <!-- 配置sqlSessionFactory -->
        <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"></property>
        <!-- 扫描mapper接口包，将里面的接口全部加入到IOC容器中 -->
        <property name="basePackage" value="cn.im.mapper"></property>
    </bean>
    <!-- 4.事务管理 -->
    <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
        <property name="dataSource" ref="dataSource"></property>
    </bean>
    <!-- 5.开启基于注解的声明式事物 -->
    <tx:annotation-driven transaction-manager="transactionManager"/>
</beans>
5.在resources文件夹下创建db.properties文件用于保存数据库基础数据
#数据库基本配置
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://127.0.0.1:3306/mybatis_demo?useUnicode=true&characterEncoding=UTF-8&useSSL=false&allowMultiQueries=true
jdbc.username=root
jdbc.password=root
6.在resources文件夹下创建mybatis-config.xml配置文件，永不设置mybatis基本配置信息
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <!-- mybatis的配置 -->

    
    <!-- 配置分页插件pageHelper -->
    <plugins>
        <plugin interceptor="com.github.pagehelper.PageInterceptor">
            <!--
                当 offsetAsPageNum=false 的时候，由于 PageNum 问题，
                RowBounds查询的时候 reasonable 会强制为 false。
                使用 PageHelper.startPage 方法不受影响
                所以我这里直接设置成true，防止造成reasonable属性失效
            -->
            <property name="offsetAsPageNum" value="true"></property>
            <!--

                参数设置的官网地址:https://github.com/pagehelper/Mybatis-PageHelper/blob/master/wikis/zh/HowToUse.md
                pageHelper提供了很多参数设置，可以根据自己的需求进行各种设置
                这里只设置了一个参数合理化设置的参数
                reasonable：当该参数设置为 true 时，pageNum<=0 时会查询第一页，
                            pageNum>pages（超过总数时），会查询最后一页。默认false 时，直接根据参数进行查询
            -->
            <property name="reasonable" value="true"></property>
            <!--
                为了支持startPage(Object params)方法，增加了该参数来配置参数映射，用于从对象中根据属性名取值，
                可以配置 pageNum,pageSize,count,pageSizeZero,reasonable，不配置映射的用默认值，
                默认值为pageNum=pageNum;pageSize=pageSize;
                count=countSql;reasonable=reasonable;pageSizeZero=pageSizeZero

                支持通过 Mapper 接口参数来传递分页参数，默认值false，分页插件会从查询方法的参数值中，
                自动根据上面 params 配置的字段中取值，查找到合适的值时就会自动分页

            -->
            <property name="supportMethodsArguments" value="true"></property>
            <property name="params" value="pageNum=pageNumKey;pageSize=pageSizeKey;"/>
        </plugin>
    </plugins>
</configuration>

第六节. 项目结构如图

image.png

 

*** 以上就是MyBatis的代码部分***

 

第七节. 测试代码如下UserMapperTest

package cn.im;

import cn.im.domain.User;
import cn.im.mapper.UserMapper;
import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;
import com.github.pagehelper.PageRowBounds;
import org.apache.ibatis.session.RowBounds;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

import java.util.List;

/**
 * Created by mybatis-demo
 * Author: hushuang
 * Date: 2017/11/10
 * Time: 上午9:38
 * Email: hd1611756908@163.com
 * Description : 分页插件的测试类
 */
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = {"classpath:applicationContext.xml"})
public class UserMapperTest {

    /**
     * 日志slf4j
     */
    private static final Logger LOG = LoggerFactory.getLogger(UserMapperTest.class);
    @Autowired
    private UserMapper userMapper;

    /**
     * 方式一
     * Mapper接口方式的调用
     * 采用PageHelper.startPage(1, 10);方式调用
     * 使用方式如下
     */
    @Test
    public void testStartPage(){
        /*
            startPage方法的第一个参数为页码，第二个参数为每页显示数量
            查询语句必须紧跟着PageHelper.startPage(2, 1)后面，否则会报错
         */
        PageHelper.startPage(1, 2);
        List<User> pageUser = userMapper.findPageUser();
        for (User user : pageUser) {
            LOG.info("========={}",user);
        }
        LOG.info("查询数量为count={},pageUser={}",pageUser.size(),pageUser);

    }


    /**
     * 方式二
     * Mapper接口方式的调用
     * 采用PageHelper.offsetPage(1, 10);方式调用
     * 使用方式如下
     */
    @Test
    public void testOffsetPag(){
        /*
            offsetPage方法的第一个参数为页码，第二个参数为每页显示数量
            查询语句必须紧跟着PageHelper.offsetPage(2, 1)后面
            注意offsetPage 方法的第一页数据的当前页为0不是1，这点和startPage不同
         */
        PageHelper.offsetPage(0,1);
        List<User> pageUser = userMapper.findPageUser();
        for (User user : pageUser) {
            LOG.info("========={}",user);
        }
        LOG.info("查询数量为count={},pageUser={}",pageUser.size(),pageUser);

    }


    /**
     * 方式三 参数方法调用
     * Mapper接口中存在类似于
     * List<User> findPageByNumAndSize(@Param("pageNumKey") int pageNumKey, @Param("pageSizeKey") int pageSizeKey);
     * 的方法，只需要在xml配置文件中配置supportMethodsArguments=true即可,
     * 官网说还需要配置<property name="params" value="pageNum=pageNumKey;pageSize=pageSizeKey;"/>,
     * 但是我这里测试了一下，配置和不配置都是可以的，如果配置，注意参数的问题，要对应上
     * 使用方式如下
     */
    @Test
    public void testParmerPage(){

        List<User> pageUser = userMapper.findPageByNumAndSize(2,2);
        for (User user : pageUser) {
            LOG.info("========={}",user);
        }
        LOG.info("查询数量为count={},pageUser={}",pageUser.size(),pageUser);

    }

    /**
     * 方式四  RowBounds方式分页
     * 使用方式如下
     * 注意：RowBounds 这种接口查询方式返回数据中没有总记录数，
     * 官网说可以通过PageRowBounds对象获取，但是我这里没有获取到不知道是因为什么原因
     * 所以我这里不建议使用
     */
    @Test
    public void testRowNumPage(){

        PageRowBounds rowBounds = new PageRowBounds(1,2);
        List<User> pageUser = userMapper.findPageByRowNum(rowBounds);
        for (User user : pageUser) {
            LOG.info("========={}",user);
        }
        LOG.info("查询数量为count={},pageUser={}",pageUser.size(),pageUser);

    }


    /**
     * 方式四  PageInfo方式
     * 这种方式不属于分页，是一种封装分页的方式，
     * 就是说，将已经分页查询之后的数据进行再一次的封装，这样会获取到非常全面的分页属性
     * 使用方式如下
     */
    @Test
    public void testPageInfo(){

        List<User> pageUser = userMapper.findPageByNumAndSize(1,2);
        PageInfo page = new PageInfo(pageUser);

        LOG.info("PageNum={}",page.getPageNum());
        LOG.info("PageSize={}",page.getPageSize());
        LOG.info("Total={}",page.getTotal());
        LOG.info("Users={}",page.getList());
        //…………
    }
}

第八节. MyBatis基本总结

mybatis基本教程算是写完了没多少，mybatis框架不是很难，后面还会有一章来说一下mybatis的一些配置信息，主要用于实际项目中。写的不是很详细，如果有什么错误的地方欢迎大家指出，我这里会尽快作出修改，如果有什么不懂的地方，可以在下方评论，一起交流。

代码已经上传到github

git clone https://github.com/hd1611756908/mybatis-demo.git

下面的mybatis-demo3子项目

相关文章

网友评论

      本文标题：MyBatis入门之分页插件PageHelper

      本文链接：https://www.haomeiwen.com/subject/lifbmxtx.html

      延伸阅读

      深度阅读

      • 您也可以注册成为美文阅读网的作者，发表您的原创作品、分享您的心情！

      栏目导航

      热点阅读

      关于我们|服务条款|联系我们|MyBatis入门之分页插件PageHelper|投稿指南|网站地图|RSS订阅|排版工具|手机版

      提供经典美文摘抄,优美散文欣赏,现代诗歌精选,短篇小说,心情随笔,表白情书范文,故事会在线阅读欣赏

      Copyright © 2014-2023 Haomeiwen.com All Rights Reserved. 好美文阅读网 版权所有

      备案信息：桂公网安备 45052102000051号 · 桂ICP备13007215号-3

      本站所收录作品、热点评论等信息部分来源互联网，目的只是为了系统归纳学习和传递资讯

      所有作品版权归原创作者所有，与本站立场无关，如不慎侵犯了你的权益，请联系我们告知，我们将做删除处理！