SpringBoot+Mybatis+PageHelper深度整合

前提提示:
完整源代码参照这里

前面写过一篇文章:SpringBoot 配置多数据源,介绍了如果用SpringBoot自定义多数据源,有人可能发现了配置文件中启用了PageHelper-一个基于Mybatis的物理分页组件。但是,该文中的PageHelper只配置了mysql一种,也就是说这篇文章讲解的配置方案有局限,只能配置多数据源都是mysql数据库的配置。
那如果多数据源中有多种数据库(比如MySql+Oracle等)该如何配置呢,下面我就给大家讲讲SpringBoot、Mybatis和PageHelper的深度整合,实现它们的完美配置。
在讲之间,大家可以再看另一篇文章: SpringBoot+Mybatis完全基于注解开发MySql数据库,以为我讲解的方法已经完全去除Mybatis的xml配置文件了。
多数据源DataSource的配置基本与原文配置一样,只是改为了yml配置。但是要支持多种数据源,麻烦点就在PageHelper上。我们先来看看原因:

image.png

找到图中PageHelper的自动加载配置文件,找到如下代码:
image.png

它的意思比较易懂,就是对于所有的数据源(SqlSessionFactoryList)都是用同一个PageHelper!这明显与我们的要求是违背的!另外PageHelper有要求,同一个数据源(SqlSessionFactory)最多只能支持一个PageHelper!那我们只能废弃自动加载的PageInterceptor,然后在程序中手动加载我们自定义的PageInterceptor!
1.禁用PageHelperAutoConfiguration
image.png

我们还想用PageHelper的配置方式,但是这个禁用会导致下图中圈起来的代码的失效
image.png

也就是PageHelperAutoConfiguration所在的jar包定义的bean无法自动注册,因此,我们先在数据库配置文件中注册一个同名bean,同时为了使用yml配置文件属性,要定义一个Properties接收配置的属性
image.png

2.自定义PageInterceptor
好了,前期准备好了,该我们来定义PageInterceptor了
image.png

是不是与组件自定义的bean很相似~
3.注册到SqlSessionFactory中
我们先进入MybatisAutoConfiguration文件看一下Mybatis的SqlSessionFactory是如何初始化的
image.png

嗯...它带了@ConditionalOnMissingBean,那就意味着我们可以重新定义它!
为了保持功能不缺失,我们完全参照这个来定义

    @Bean(name = "sqlSessionFactory")
    public SqlSessionFactory sqlSessionFactorySecond(
            @Qualifier("dataSource") DataSource dataSource,
            @Qualifier("mybatisProperties") MybatisProperties properties,
            ResourceLoader resourceLoader,
            ObjectProvider<List<ConfigurationCustomizer>> configurationCustomizersProvider,
            ObjectProvider<Interceptor[]> interceptorsProvider,
            @Qualifier("pageInterceptor") Interceptor pageInterceptor,
            ObjectProvider<DatabaseIdProvider> databaseIdProvider) throws Exception {
        SqlSessionFactoryBean factory = new SqlSessionFactoryBean();
        factory.setDataSource(dataSource);
        
        factory.setVfs(SpringBootVFS.class);
        if (StringUtils.hasText(properties.getConfigLocation())) {
          factory.setConfigLocation(resourceLoader.getResource(properties.getConfigLocation()));
        }
        org.apache.ibatis.session.Configuration configuration = properties.getConfiguration();
        if (configuration == null && !StringUtils.hasText(properties.getConfigLocation())) {
          configuration = new org.apache.ibatis.session.Configuration();
        }
        List<ConfigurationCustomizer> configurationCustomizers = configurationCustomizersProvider.getIfAvailable();
        if (configuration != null && !CollectionUtils.isEmpty(configurationCustomizers)) {
          for (ConfigurationCustomizer customizer : configurationCustomizers) {
            customizer.customize(configuration);
          }
        }
        factory.setConfiguration(configuration);
        if (properties.getConfigurationProperties() != null) {
          factory.setConfigurationProperties(properties.getConfigurationProperties());
        }
        Interceptor[] interceptors = filterInterceptors(interceptorsProvider.getIfAvailable(), pageInterceptor);
        if (!ObjectUtils.isEmpty(interceptors)) {
          factory.setPlugins(interceptors);
        }
        DatabaseIdProvider _databaseIdProvider = databaseIdProvider.getIfAvailable();
        if (_databaseIdProvider != null) {
          factory.setDatabaseIdProvider(_databaseIdProvider);
        }
        if (StringUtils.hasLength(properties.getTypeAliasesPackage())) {
          factory.setTypeAliasesPackage(properties.getTypeAliasesPackage());
        }
        if (StringUtils.hasLength(properties.getTypeHandlersPackage())) {
          factory.setTypeHandlersPackage(properties.getTypeHandlersPackage());
        }
        if (!ObjectUtils.isEmpty(properties.resolveMapperLocations())) {
          factory.setMapperLocations(properties.resolveMapperLocations());
        }
        
        return factory.getObject();
    }

这个,有几个需要注意的点:
入参

image.png

我们定义的分页组件单独加了进来。
添加组件
image.png

这里,我们对单独添加的分页组件进行了处理
分页组件虑重
为了保证分页组件唯一,我们需要虑重
image.png

参数yml配置
我们重新定义了参数配置
image.png

OK,这样就完成了SpringBoot+Mybatis+PageHelper深度整合配置,完整源代码参照这里
如果你喜欢,可以点击收藏或关注,我会经常更新关于SpringBoot、SpringCloud等相关用法和技能。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。