zhizhiqiuya

Spring framework day 03:Spring 整合 Mybatis(分页)

前言

在当今快速发展的软件开发领域，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 依赖

  
        
        
            com.alibaba
            druid
            1.2.15
        
 
 
        
        
        
            org.springframework
            spring-context
            5.3.23
        
 
        
            org.springframework
            spring-jdbc
            5.3.23
        
 
        
            ch.qos.logback
            logback-classic
            1.4.5
        
 
 
        
            mysql
            mysql-connector-java
            8.0.33
        
 
 
            org.projectlombok
            lombok
            1.18.30
        
 
      
            junit
            junit
            4.13.2
            test
        
 

        
        
            org.mybatis
            mybatis
            3.5.6
        
 
        
        
            org.mybatis
            mybatis-spring
            2.0.6
        

           
        
            com.github.pagehelper
            pagehelper
            5.3.2

3、在 dao 包下的 CityDao 接口中添加一个方法

public interface CityDao {


    /**
     * 分页查询
     * @param pageNum
     * @param pageSize
     * @return
     */
    List page(@Param("pageNum") Integer pageNum, @Param("pageSize") Integer pageSize);


}

4、在 service 包下的 CityService 接口中，添加一个方法

public interface CityService {


    PageInfo page(Integer pageNum, Integer pageSize);

}

5、在 CityServiceImpl 实现类中添加一个方法


@Service
@Slf4j
@RequiredArgsConstructor
public class CityServiceImpl implements CityService {

    /**
     * 这里注入的是代理对象
     */
    private final CityDao cityDao;


    @Override
    public PageInfo page(Integer pageNum, Integer pageSize) {
        List 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 配置，数据源、分页都在这里面交给容器管理。

以上是一个整合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 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 中的 
@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 list = cityDao.page(1,10);
        list.getList().forEach(page -> log.info(page.getCityName()));

    }

}