前言
在当今快速发展的软件开发领域,Java作为一种广泛使用的编程语言,以其强大的生态系统和丰富的框架而备受推崇。而在Java开发中,Spring框架几乎成为了事实上的标准,它为开发者提供了一种优雅且高效的方式来构建企业级应用程序。
而对于数据持久化方面,MyBatis作为一种流行的ORM(Object-Relational Mapping)框架,也成为了Java开发者的首选之一。它不仅提供了简单易用的SQL映射功能,还具备动态SQL、一级缓存、延迟加载等高级特性。
然而,在实际项目中,我们通常需要实现分页查询以处理大量数据。而Spring和MyBatis共同配合,可以实现简单而强大的分页功能。本文将介绍如何在Spring框架中整合MyBatis,并使用MyBatis的分页插件来实现分页查询功能。
在接下来的内容中,我们将逐步讲解如何设置环境、配置数据源和整合MyBatis。然后,我们将介绍如何使用MyBatis分页插件来实现分页查询,并提供实例演示。最后,我们将总结所学内容,并讨论一些可能遇到的常见问题和解决方案。
通过本文的学习,您将了解到使用Spring整合MyBatis(分页)的基本步骤和技巧,以及如何在实际项目中应用它们。希望本文能够帮助您更好地理解和使用这两个优秀的框架,并加快您的开发效率。
请继续阅读下文,我们将一步步引导您完成整合过程。
一、使用 pagehelper 插件
PageHelper是一个开源的MyBatis分页插件,可以轻松地在MyBatis应用中实现分页查询功能。它提供了丰富的分页参数配置项,支持多种数据库(包括MySQL、Oracle、SqlServer等)和多种分页方式(包括普通分页、滚动分页、局部分页等),同时也提供了与Spring框架和SpringBoot框架的无缝集成。使用PageHelper可以大大简化分页查询的编写,提高代码的可读性和可维护性。
二、新建项目,结构如下
1、导入 spring 依赖
<dependencies>
<!-- https://mvnrepository.com/artifact/com.alibaba/druid -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.2.15</version>
</dependency>
<!-- spring 的核心依赖 -->
<!-- https://mvnrepository.com/artifact/org.springframework/spring-context -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>5.3.23</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
<version>5.3.23</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.4.5</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.33</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.30</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.13.2</version>
<scope>test</scope>
</dependency>
<!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
<!-- Mybatis 依赖 -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.6</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.mybatis/mybatis-spring -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis-spring</artifactId>
<version>2.0.6</version>
</dependency>
<!-- pagehelper 分页插件 -->
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper</artifactId>
<version>5.3.2</version>
</dependency>
</dependencies>
3、在 dao 包下的 CityDao 接口中添加一个方法
public interface CityDao {
/**
* 分页查询
* @param pageNum
* @param pageSize
* @return
*/
List<City> page(@Param("pageNum") Integer pageNum, @Param("pageSize") Integer pageSize);
}
4、在 service 包下的 CityService 接口中,添加一个方法
public interface CityService {
PageInfo<City> page(Integer pageNum, Integer pageSize);
}
5、在 CityServiceImpl 实现类中添加一个方法
@Service
@Slf4j
@RequiredArgsConstructor
public class CityServiceImpl implements CityService {
/**
* 这里注入的是代理对象
*/
private final CityDao cityDao;
@Override
public PageInfo<City> page(Integer pageNum, Integer pageSize) {
List<City> list = cityDao.page(pageNum, pageSize);
return new PageInfo<>(list);
}
}
在该示例中,CityServiceImpl
类的主要逻辑如下:
使用
@Service
注解将CityServiceImpl
类标识为一个Spring的服务组件。使用
@Slf4j
注解引入lombok
库提供的日志功能,可以通过log
对象输出日志信息。使用
@RequiredArgsConstructor
注解,通过Lombok生成带有final
字段的构造函数。这里用于注入CityDao
的代理对象。实现
page
方法,该方法接收两个参数:pageNum
和pageSize
,用于指定当前页码和每页的数据量。在
page
方法中调用cityDao
对象的page
方法进行分页查询,传入pageNum
和pageSize
作为参数。将查询结果列表封装为
PageInfo
对象,并返回。
需要注意的是,CityDao
的注入是通过构造函数注入的,而且注入的是代理对象,这是使用Spring整合MyBatis后的一种常见配置方案。
三、xml 配置
1、在 resources 包下新建一个 beans.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:mybatis="http://mybatis.org/schema/mybatis-spring"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://mybatis.org/schema/mybatis-spring http://mybatis.org/schema/mybatis-spring.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd">
<!-- 启用扫描 -->
<context:component-scan base-package="edu.nf.ch02"/>
<!-- 整合 druid 数据源连接池,其中将 DruidDataSource 核心类纳入
spring 容器中管理,并指定相关的初始化方法以及销毁方法
-->
<bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close">
<!-- 注入相关的连接属性 -->
<property name="driverClassName" value="com.mysql.cj.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/psm"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
<!-- 注入连接池的相关配置属性 -->
<!-- 最大连接池数量 -->
<property name="maxActive" value="200"/>
<!-- 预先初始化 5 个连接放入连接池 -->
<property name="initialSize" value="5"/>
<!-- 最小空闲连接数 -->
<property name="minIdle" value="5"/>
<!-- 获取连接的最大等待时间,单位:毫秒 -->
<property name="maxWait" value="2000"/>
<!-- 连接保持空闲而不被驱逐出连接池的最小时间,单位:毫秒 -->
<property name="minEvictableIdleTimeMillis" value="300000"/>
<!-- 检测连接的间隔时间,单位:毫秒 -->
<property name="timeBetweenEvictionRunsMillis" value="60000"/>
<!-- 检测连接是否有效 -->
<property name="testWhileIdle" value="true"/>
<!-- 放回连接池时是否检查连接的有效性 -->
<property name="testOnReturn" value="false"/>
<!-- 定义一条伪 SQL,用于检查连接时是否可用 -->
<property name="validationQuery" value="select 1"/>
<!-- 是否缓存 PreparedStatements,MySQL 建议关闭 -->
<property name="poolPreparedStatements" value="false"/>
</bean>
<!-- 装配 sqlSessionFactory ,也就是整合 mybatis 到 spring
关键点在于将 mybatis 的相关配置放在 spring 中设置,并由
容器来管理 sqlSessionFactory
-->
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<!-- SqlSessionFactoryBean 需要注入 DataSource -->
<property name="dataSource" ref="dataSource"/>
<!-- 注入其他配置属性值 -->
<!-- 指定实体类的包,用于创建别名 -->
<property name="typeAliasesPackage" value="edu.nf.ch02"/>
<!-- mapper 映射配置文件的路径 -->
<property name="mapperLocations" value="classpath:mappers/*.xml"/>
<!-- 设置分页插件 -->
<property name="plugins">
<!-- 装配分页拦截器 -->
<bean class="com.github.pagehelper.PageInterceptor">
<!-- 给分页拦截器注入相关的属性值 -->
<property name="properties">
<props>
<!-- 设置数据库方言-->
<prop key="helperDialect">mysql</prop>
<!-- 启用分页参数注解支持 -->
<prop key="supportMethodsArguments">true</prop>
<!-- 分页合理化 -->
<prop key="reasonable">true</prop>
</props>
</property>
</bean>
</property>
</bean>
<!-- 配置扫描 dao 接口所在的包,这样会利用动态代理在
运行时创建所有 dao 接口的实现类 ,并自动注册到 spring 容器中
-->
<mybatis:scan base-package="edu.nf.ch02.dao"/>
</beans>
这是完整的 xml 配置,数据源、分页都在这里面交给容器管理。
以上是一个整合MyBatis和Spring的配置示例。主要包括以下几个关键点:
配置SqlSessionFactoryBean:通过该配置将MyBatis和Spring进行整合。需要注入DataSource,并设置其他属性值,比如实体类的包、mapper映射文件的路径等。
设置分页插件:在SqlSessionFactoryBean中配置分页插件。使用PageInterceptor作为分页拦截器,并注入相关属性值。可以设置数据库方言(如mysql)、启用分页参数注解支持和分页合理化等。
配置扫描dao接口包:通过mybatis:scan配置,指定扫描dao接口所在的包路径。这样会利用动态代理在运行时创建所有dao接口的实现类,并自动注册到Spring容器中。
通过以上配置,就可以完成MyBatis和Spring的整合,并且使用PageHelper插件实现方便的分页查询功能。
我们再来详细的分析每一个属性是干嘛的吧!
dataSource:指定SqlSessionFactory所需的数据源。
typeAliasesPackage:指定实体类(对应数据库表的映射类)的包路径,用于创建别名。
mapperLocations:指定mapper XML文件所在的路径(可以是文件系统路径或者classpath路径)。
plugins:设置MyBatis插件。可以配置多个插件,例如分页插件等。在该示例中,使用的是PageHelper分页插件。
PageInterceptor:PageHelper分页插件提供了一个名为PageInterceptor的分页拦截器。该拦截器会在执行SQL语句前,自动将分页参数封装为Page对象,并且在SQL语句后自动进行分页处理。
helperDialect:指定数据库方言(如mysql、oracle等),PageHelper根据不同的数据库方言自动选择相应的分页方法。
supportMethodsArguments:启用分页参数注解支持。在service层的方法(dao接口对应的方法)上添加@Param注解,并使用PageHelper.startPage(pageNum, pageSize)方法即可完成分页功能。
reasonable:分页合理化。如果该属性设置为true,则会在查询总记录数时,先判断当前查询是否是一个简单的查询(没有含有排序、聚合、子查询等特殊操作),如果是,则不进行count查询总记录数,直接返回limit查询结果。这样可以避免多余的count查询操作,提升性能。
base-package:指定dao接口所在的包路径,用于自动扫描并注册dao接口。
完整的 xml 配置已经完成了,现在我们来测试一下吧!
2、测试
@Slf4j
public class Main {
public static void main(String[] args) {
ApplicationContext context = new ClassPathXmlApplicationContext("beans.xml");
// 从容器中获取动态创建的 CityDao 的代理对象
CityService cityDao = context.getBean(CityService.class);
PageInfo<City> list = cityDao.page(1,10);
list.getList().forEach(page -> log.info(page.getCityName()));
}
}
page(1,10):大家是不是很疑惑,我们调用的这个方法并不是 CityService 的方法,而是 CityDao 接口的实现类的方法,那这个实现类是怎么来的呢?我们并没有实现呀,这个实现类是动态代理帮我们动态生成的,不用我们自己实现,这就是使用框架的好处,帮我们节省了很多的重复操作。
运行结果
四、使用 Java 配置类配置(推荐)
1、在 resources 包下新建一个 db.properties 文件
driver = com.mysql.cj.jdbc.Driver
url = jdbc:mysql://localhost:3306/psm
username= root
password = 123456
maxActive = 200
initialSize = 5
minIdle = 5
maxWait = 2000
minEvictableIdleTimeMillis = 300000
timeBetweenEvictionRunsMillis = 60000
testWhileIdle = true
testOnReturn = false
validationQuery = select 1
poolPreparedStatements = false
2、在 config 包下新建一个 AppConfig 类
@Configuration
// 扫描 dao 接口的包,动态生成 dao 接口的代理实现
// 等效于 xml 中的 <mybatis:scan>
@MapperScan(basePackages = "edu.nf.ch02.dao")
@ComponentScan(basePackages = "edu.nf.ch02")
public class AppConfig {
/**
* 装配 dataSource 数据源
*
* @return
* @throws Exception
*/
@Bean(initMethod = "init", destroyMethod = "close")
public DruidDataSource dateSource() throws Exception {
// 创建 Properties 对象
Properties prop = new Properties();
// 获取一个输入流来读取 properties 文件
InputStream input = AppConfig.class.getClassLoader().getResourceAsStream("db.properties");
// 将输入流加载到 properties 对象中
prop.load(input);
// 通过 DruidDataSourceFactory 来创建 DruidDataSource 实例
DruidDataSource ds = (DruidDataSource) DruidDataSourceFactory.createDataSource(prop);
return ds;
}
/**
* 整合 mybatis ,装配 SqlSessionFactory
*
* @return
*/
@Bean
public SqlSessionFactoryBean sqlSessionFactory(DataSource dataSource) throws Exception {
// 创建 SqlSessionFactoryBean
SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
// 注入数据源
sqlSessionFactoryBean.setDataSource(dataSource);
// 注入 mybatis 其他属性
// 设置包的别名
sqlSessionFactoryBean.setTypeAliasesPackage("edu.nf.ch02.entity");
// mapper 映射配置文件的路径
// 先创建一个资源路径解析器来查找源文件
PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
Resource[] resources = resolver.getResources("classpath:mappers/*.xml");
sqlSessionFactoryBean.setMapperLocations(resources);
// 设置分页插件
PageInterceptor interceptor = new PageInterceptor();
// 设置属性
Properties properties = new Properties();
properties.setProperty("helperDialect","mysql");
properties.setProperty("supportMethodsArguments","true");
properties.setProperty("reasonable","true");
// 将分页属性设置到分页拦截器中
interceptor.setProperties(properties);
// 最后将分页拦截器设置到 SqlSessionFactoryBean 插件中
sqlSessionFactoryBean.setPlugins(interceptor);
// 返回 SqlSessionFactoryBean 给容器
return sqlSessionFactoryBean;
}
}
我们来注重讲解一些分页的属性:
在这段代码中,首先创建了一个PageInterceptor
对象,作为PageHelper分页插件的拦截器。然后,通过Properties
对象设置了一些属性:
helperDialect
:指定数据库方言,这里设置为mysql
。
supportMethodsArguments
:启用分页参数注解支持,设置为true
。
reasonable
:分页合理化,设置为true
。
接下来,将这些分页属性设置到PageInterceptor
对象中,使用interceptor.setProperties(properties)
语句。
最后,通过sqlSessionFactoryBean.setPlugins(interceptor)
将分页拦截器设置到SqlSessionFactoryBean
中,以便在MyBatis的执行过程中应用分页插件。
通过这样的配置,就可以实现在MyBatis中使用PageHelper进行分页查询了。
3、测试
@Slf4j
public class Main {
public static void main(String[] args) {
ApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class);
// 从容器中获取动态创建的 CityDao 的代理对象
CityService cityDao = context.getBean(CityService.class);
PageInfo<City> list = cityDao.page(1,10);
list.getList().forEach(page -> log.info(page.getCityName()));
}
}
运行结果
五、xml 配置和 Java配置类,配置分页属性的区别
在配置分页属性时,可以使用两种方式:XML配置和Java配置类。下面是它们之间的区别:
-
XML配置:
- 在XML配置文件中,可以通过
<plugins>
元素来配置分页插件以及其属性。 - 使用XML配置时,需要手动编写XML配置文件,并指定插件的相关属性。
- 配置文件中的内容相对独立,可单独管理和维护。
- 在XML配置文件中,可以通过
-
Java配置类:
- 在Java配置类中,可以通过实例化分页插件对象并设置属性来配置分页插件。
- 使用Java配置类时,可以直接在代码中进行配置和设置,无需单独的配置文件。
- 配置类可以与其他配置类一起进行管理,方便集中管理和维护。
总体来说,XML配置适合于对配置文件进行统一管理的项目,而Java配置类适合于将配置与代码结合在一起的项目。选择使用哪种方式主要取决于项目的需求和个人偏好。无论选择哪种方式,配置的具体内容都是相同的,只是配置方式不同。
大家在开发中,根据自己的需求选择即可。
六、gitee 案例
完整代码地址:ch02 · qiuqiu/conformity-study - 码云 - 开源中国 (gitee.com)