PageHelper的简单使用

PageHelper是mybatis框架的一个插件,用于支持在mybatis执行分页操作,使用非常方便,在这儿写一下基本的使用.

github文档地址:https://github.com/pagehelper/Mybatis-PageHelper/blob/master/wikis/zh/HowToUse.md

1.准备一个maven项目,导入相关依赖

Mybatis

log4j(可以在控制台查看sql语句的执行)

mysql-connector(mysql的驱动包)

lombok(用于生成setter,getter方法)

<!-- mybatis依赖 -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.6</version>
        </dependency>

        <!-- mysql -->
        <!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.18</version>
        </dependency>

        <!-- 日志依赖 -->
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>

        <!-- lombok -->
        <!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.16.20</version>
            <scope>provided</scope>
        </dependency>

       
        <!-- pageHelper依赖 -->
        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper</artifactId>
            <version>5.1.10</version>
        </dependency>

2.准备一张表

名为student,三个字段,id,name,age,准备一些数据

3,配置项目

首先在resources目录下,创建一个Mybatis-config.xml文件,用于做一些全局的mybatis基本的配置,例如数据库连接信息,事务,mapper映射文件路径,日志实现,类的别名,也包含了分页插件的基本配置

<configuration>
	<properties resource="db.properties" />
	<settings>
        <!--日志的实现是LOG4J-->
		<setting name="logImpl" value="LOG4J" />
	</settings>
	<typeAliases>
		<package name="com.ren.domain" />
	</typeAliases>
    <!--mybatis的插件配置-->
	<plugins>
		<!-- com.github.pagehelper为PageHelper类所在包名 -->
		<plugin interceptor="com.github.pagehelper.PageInterceptor">
			<!-- 表示使用mysql的分页方法 -->
			<property name="helperDialect" value="mysql" />
			<!-- 表示当页码长度为0 的时候,就不进行分页查询 -->
			<property name="pageSizeZero" value="true"/>
		</plugin>
	</plugins>
	
	<!-- 配置连接数据库四要素 -->
	<environments default="dev">
		<environment id="dev">
			<transactionManager type="JDBC" />
			<dataSource type="POOLED">
				<property name="driver" value="${driverClassName}" />
				<property name="url" value="${url}" />
				<property name="username" value="${username}" />
				<property name="password" value="${password}" />
			</dataSource>
		</environment>
	</environments>

	<mappers>
		<mapper resource="com/ren/mapper/StudentMapper.xml" />
	</mappers>
</configuration>

4.编写mapper,domain类

Student类,字段名和数据库表中对应的字段名尽量一致

5.首先做高级查询(条件查询)编写StudentMapper类和QueryObject类,在StudentMapper类中编写一个高级查询的方法,名为queryByConditions,根据姓名关键字和年龄范围查询,把查询条件封装到QueryObject类中.QueryObject类包括了姓名的关键字,年龄的范围,QueryObject类中的currentPage,和pageSize用于存储分页的条件

StudentMapper类:

QueryObject类:

编写StudentMapper对应的mapper文件.StudentMapper.xml

4.在mybatis中引入一段配置

<plugins>
    <!-- com.github.pagehelper为PageHelper类所在包名 -->
    <plugin interceptor="com.github.pagehelper.PageInterceptor">
        <!-- 使用什么数据库 -->
        <property name="helperDialect" value="mysql"/>
	</plugin>
</plugins>

5.编写分页的业务,IStudentService,以及实现类StudentServiceImpl,page(qo)方法最终返回一个PageInfo对象

IStudentService的实现类StudentServiceImpl

PageHelper库中中有一个核心类PageInfo封装查询的list,包含了分页信息(结果总数,当前页,上一页,下一页,当前页的结果集),还有一个PageHelper类,在分页查询之前使用PageHelper.startPage(当前页,每一页的条数),完成分页查询操作

调用自己的查询方法queryByConditions()方法查询出的list对象封装到PageInfo中即可完成,PageInfo中包括了分页的结果集

把高级查询返回的list对象(list对象)作为构造器参数传入PageInfo中,即可.

使用Junit5单元测试编写一个StudentMapperTest类

可以观察sql语句,在mapper文件中并没有写limit,pageHelper已经帮我们加上了limit关键字完成了查询.OK了