MyBatis-Plus和SpringBoot的整合

最新推荐文章于 2024-04-16 15:40:43 发布
最新推荐文章于 2024-04-16 15:40:43 发布
阅读量2.8k 收藏 4
点赞数 2
分类专栏： MyBatis
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_41071876/article/details/119656550
版权

简介

MyBatis-Plus是一个 MyBatis (opens new window)的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

一、MyBatis-Plus和SpringBoot整合应用
1.1 项目依赖

在原项目依赖上，加上下面依赖

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.4.3</version>
</dependency>
1.2 项目配置

使用mybatis-plus-boot-starter后，spring将扫描所有标准@Mapper的类（不需要使用@MapperScan），所以我们直接使用mybatis-plus的功能，不需要手动配置SqlSessionTemplate，MybatisSqlSessionFactoryBean，dataSource，因为MyBatis-Spring-Boot-Starter帮我们配置好了。

mybatis-plus-boot-starter在其spring.factories文件中配置2个配置类，mybatis-plus主要配置都在MybatisPlusAutoConfiguration中

org.springframework.boot.env.EnvironmentPostProcessor=\
  com.baomidou.mybatisplus.autoconfigure.SafetyEncryptProcessor
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.baomidou.mybatisplus.autoconfigure.IdentifierGeneratorAutoConfiguration,\
  com.baomidou.mybatisplus.autoconfigure.MybatisPlusLanguageDriverAutoConfiguration,\
  com.baomidou.mybatisplus.autoconfigure.MybatisPlusAutoConfiguration
二、Mybatis和Spring整合源码分析

其数据源配置和事务都已经配置好了，一般情况下不用我们自己配置

以下代码都在MybatisPlusAutoConfiguration中

2.1 SqlSessionFactory的注册
@Configuration
@ConditionalOnClass({SqlSessionFactory.class, SqlSessionFactoryBean.class})
@ConditionalOnSingleCandidate(DataSource.class)
@EnableConfigurationProperties(MybatisPlusProperties.class)
@AutoConfigureAfter({DataSourceAutoConfiguration.class, MybatisPlusLanguageDriverAutoConfiguration.class})
public class MybatisPlusAutoConfiguration implements InitializingBean {

    private static final Logger logger = LoggerFactory.getLogger(MybatisPlusAutoConfiguration.class);

    private final MybatisPlusProperties properties;

    private final Interceptor[] interceptors;

    private final TypeHandler[] typeHandlers;

    private final LanguageDriver[] languageDrivers;

    private final ResourceLoader resourceLoader;

    private final DatabaseIdProvider databaseIdProvider;

    private final List<ConfigurationCustomizer> configurationCustomizers;

    private final List<MybatisPlusPropertiesCustomizer> mybatisPlusPropertiesCustomizers;

    private final ApplicationContext applicationContext;

    //构造器注入
    public MybatisPlusAutoConfiguration(MybatisPlusProperties properties,
                                        ObjectProvider<Interceptor[]> interceptorsProvider,
                                        ObjectProvider<TypeHandler[]> typeHandlersProvider,
                                        ObjectProvider<LanguageDriver[]> languageDriversProvider,
                                        ResourceLoader resourceLoader,
                                        ObjectProvider<DatabaseIdProvider> databaseIdProvider,
                                        ObjectProvider<List<ConfigurationCustomizer>> configurationCustomizersProvider,
                                        ObjectProvider<List<MybatisPlusPropertiesCustomizer>> mybatisPlusPropertiesCustomizerProvider,
                                        ApplicationContext applicationContext) {
        this.properties = properties;
        this.interceptors = interceptorsProvider.getIfAvailable();
        this.typeHandlers = typeHandlersProvider.getIfAvailable();
        this.languageDrivers = languageDriversProvider.getIfAvailable();
        this.resourceLoader = resourceLoader;
        this.databaseIdProvider = databaseIdProvider.getIfAvailable();
        this.configurationCustomizers = configurationCustomizersProvider.getIfAvailable();
        this.mybatisPlusPropertiesCustomizers = mybatisPlusPropertiesCustomizerProvider.getIfAvailable();
        this.applicationContext = applicationContext;
    }

    @SuppressWarnings("SpringJavaInjectionPointsAutowiringInspection")
    @Bean
    @ConditionalOnMissingBean
    public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {
        // TODO 使用 MybatisSqlSessionFactoryBean 而不是 SqlSessionFactoryBean
        MybatisSqlSessionFactoryBean factory = new MybatisSqlSessionFactoryBean();
        factory.setDataSource(dataSource);
        factory.setVfs(SpringBootVFS.class);
        if (StringUtils.hasText(this.properties.getConfigLocation())) {
            factory.setConfigLocation(this.resourceLoader.getResource(this.properties.getConfigLocation()));
        }
        applyConfiguration(factory);
        if (this.properties.getConfigurationProperties() != null) {
            factory.setConfigurationProperties(this.properties.getConfigurationProperties());
        }
        //插件
        if (!ObjectUtils.isEmpty(this.interceptors)) {
            factory.setPlugins(this.interceptors);
        }
        if (this.databaseIdProvider != null) {
            factory.setDatabaseIdProvider(this.databaseIdProvider);
        }
        if (StringUtils.hasLength(this.properties.getTypeAliasesPackage())) {
            factory.setTypeAliasesPackage(this.properties.getTypeAliasesPackage());
        }
        if (this.properties.getTypeAliasesSuperType() != null) {
            factory.setTypeAliasesSuperType(this.properties.getTypeAliasesSuperType());
        }
        if (StringUtils.hasLength(this.properties.getTypeHandlersPackage())) {
            factory.setTypeHandlersPackage(this.properties.getTypeHandlersPackage());
        }
        if (!ObjectUtils.isEmpty(this.typeHandlers)) {
            factory.setTypeHandlers(this.typeHandlers);
        }
        Resource[] mapperLocations = this.properties.resolveMapperLocations();
        if (!ObjectUtils.isEmpty(mapperLocations)) {
            factory.setMapperLocations(mapperLocations);
        }
        // TODO 修改源码支持定义 TransactionFactory
        this.getBeanThen(TransactionFactory.class, factory::setTransactionFactory);

        // TODO 对源码做了一定的修改(因为源码适配了老旧的mybatis版本,但我们不需要适配)
        Class<? extends LanguageDriver> defaultLanguageDriver = this.properties.getDefaultScriptingLanguageDriver();
        if (!ObjectUtils.isEmpty(this.languageDrivers)) {
            factory.setScriptingLanguageDrivers(this.languageDrivers);
        }
        Optional.ofNullable(defaultLanguageDriver).ifPresent(factory::setDefaultScriptingLanguageDriver);

        // TODO 自定义枚举包
        //获取配置文件
        if (StringUtils.hasLength(this.properties.getTypeEnumsPackage())) {
            factory.setTypeEnumsPackage(this.properties.getTypeEnumsPackage());
        }
        // TODO 此处必为非 NULL
        //获取配置文件
        GlobalConfig globalConfig = this.properties.getGlobalConfig();
        // TODO 注入填充器 //从容器中找MetaObjectHandler
        this.getBeanThen(MetaObjectHandler.class, globalConfig::setMetaObjectHandler);
        // TODO 注入主键生成器 //从容器中找IKeyGenerator
        this.getBeansThen(IKeyGenerator.class, i -> globalConfig.getDbConfig().setKeyGenerators(i));
        // TODO 注入sql注入器 //从容器中找ISqlInjector
        this.getBeanThen(ISqlInjector.class, globalConfig::setSqlInjector);
        // TODO 注入ID生成器 //从容器中找IdentifierGenerator
        this.getBeanThen(IdentifierGenerator.class, globalConfig::setIdentifierGenerator);
        // TODO 设置 GlobalConfig 到 MybatisSqlSessionFactoryBean
        factory.setGlobalConfig(globalConfig);
        return factory.getObject();
}

1、springBoot通过构造器主人会在容器中寻找Interceptor，所以我们可以用以下方式开启分页功能，这和其与springMVC整合有点不同

@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
    MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
    interceptor.addInnerInterceptor(new PaginationInnerInterceptor());
    return interceptor;
}

2、springBoot会在容器中寻找MetaObjectHandler类型注入GlobalConfig，所以元对象字段填充控制器对象我们可以交给spring管理，这和其与springMVC整合有点不同

IKeyGenerator,ISqlInjector,IdentifierGenerator 也一样

@Bean
public MyMetaObjectHandler metaObjectHandler() {
    return new MyMetaObjectHandler();
}

3、通用枚举，我们通过配置文件指定

mybatis-plus:
    # 支持统配符 * 或者 ; 分割
    typeEnumsPackage: com.baomidou.springboot.entity.enums

4、MyBatis-Plus数据库相关配置，我们通过配置文件指定

mybatis-plus:
  global-config:
    db-config:
      insert-strategy: not_null
      update-strategy: not_null
      select-strategy: not_null
      #  主键类型:
      #  AUTO(0),数据库ID自增
      #  NONE(1),未设置主键类型
      #  INPUT(2),用户输入ID
      #  ASSIGN_ID(3),全局唯一ID (数字类型唯一ID)
      #  ASSIGN_UUID(4),全局唯一ID UUID
      id-type: INPUT
      #  是否开启大写命名，默认不开启
      capital-mode: false
      logic-delete-field: deleteFlag
      logic-delete-value: 1
      logic-not-delete-value: 0
2.2 SqlSessionTemplate的注册
@Configuration
@ConditionalOnClass({SqlSessionFactory.class, SqlSessionFactoryBean.class})
@ConditionalOnSingleCandidate(DataSource.class)
@EnableConfigurationProperties(MybatisPlusProperties.class)
@AutoConfigureAfter({DataSourceAutoConfiguration.class, MybatisPlusLanguageDriverAutoConfiguration.class})
public class MybatisPlusAutoConfiguration implements InitializingBean {
    @Bean
    @ConditionalOnMissingBean
    public SqlSessionTemplate sqlSessionTemplate(SqlSessionFactory sqlSessionFactory) {
        ExecutorType executorType = this.properties.getExecutorType();
        if (executorType != null) {
            return new SqlSessionTemplate(sqlSessionFactory, executorType);
        } else {
            return new SqlSessionTemplate(sqlSessionFactory);
        }
    }
}

与MyBatis和SpringBoot整合的一样

2.3 扫描映射器类
@Configuration
@ConditionalOnClass({SqlSessionFactory.class, SqlSessionFactoryBean.class})
@ConditionalOnSingleCandidate(DataSource.class)
@EnableConfigurationProperties(MybatisPlusProperties.class)
@AutoConfigureAfter({DataSourceAutoConfiguration.class, MybatisPlusLanguageDriverAutoConfiguration.class})
public class MybatisPlusAutoConfiguration implements InitializingBean {
  public static class AutoConfiguredMapperScannerRegistrar implements BeanFactoryAware, ImportBeanDefinitionRegistrar {

        private BeanFactory beanFactory;

        @Override
        public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {

            if (!AutoConfigurationPackages.has(this.beanFactory)) {
                logger.debug("Could not determine auto-configuration package, automatic mapper scanning disabled.");
                return;
            }

            logger.debug("Searching for mappers annotated with @Mapper");

            List<String> packages = AutoConfigurationPackages.get(this.beanFactory);
            if (logger.isDebugEnabled()) {
                packages.forEach(pkg -> logger.debug("Using auto-configuration base package '{}'", pkg));
            }

            BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(MapperScannerConfigurer.class);
            builder.addPropertyValue("processPropertyPlaceHolders", true);
            builder.addPropertyValue("annotationClass", Mapper.class);
            builder.addPropertyValue("basePackage", StringUtils.collectionToCommaDelimitedString(packages));
            BeanWrapper beanWrapper = new BeanWrapperImpl(MapperScannerConfigurer.class);
            Set<String> propertyNames = Stream.of(beanWrapper.getPropertyDescriptors()).map(PropertyDescriptor::getName)
                .collect(Collectors.toSet());
            if (propertyNames.contains("lazyInitialization")) {
                // Need to mybatis-spring 2.0.2+
                // TODO 兼容了mybatis.lazy-initialization配置
                builder.addPropertyValue("lazyInitialization", "${mybatis-plus.lazy-initialization:${mybatis.lazy-initialization:false}}");
            }
            if (propertyNames.contains("defaultScope")) {
                // Need to mybatis-spring 2.0.6+
                builder.addPropertyValue("defaultScope", "${mybatis-plus.mapper-default-scope:}");
            }
            registry.registerBeanDefinition(MapperScannerConfigurer.class.getName(), builder.getBeanDefinition());
        }

        @Override
        public void setBeanFactory(BeanFactory beanFactory) {
            this.beanFactory = beanFactory;
        }
    }

    /**
     * If mapper registering configuration or mapper scanning configuration not present, this configuration allow to scan
     * mappers based on the same component-scanning path as Spring Boot itself.
     */
    @Configuration
    @Import(AutoConfiguredMapperScannerRegistrar.class)
    @ConditionalOnMissingBean({MapperFactoryBean.class, MapperScannerConfigurer.class})
    public static class MapperScannerRegistrarNotFoundConfiguration implements InitializingBean {

        @Override
        public void afterPropertiesSet() {
            logger.debug(
                "Not found configuration for registering mapper bean using @MapperScan, MapperFactoryBean and MapperScannerConfigurer.");
        }
    }
}

与MyBatis和SpringBoot整合的一样

这是一条海鱼
关注
  • 2
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
还不会用mybatis-plus，手把手教你
m0_66491772的博客
01-19 1085
本文主要介绍mybatis-plus这款插件，针对springboot用户。包括引入，配置，使用，以及扩展等常用的方面做一个汇总整理，尽量包含大家常用的场景内容。 本文项目代码gitee地址:gitee.com/wei_rong_xi… 关于mybatis-plus是什么，不多做介绍了，看官方文档：baomidou.com/，咱们直接代码撸起来。 一、快速开始 本文基于springboot、maven、jdk1.8、mysql开发，所以开始前我们需要准备好这套环境。我的环境使用了nacos作为.
002 springboot整合mybatis-plus
04-10
002 springboot整合mybatis-plus
整合案例springboot整合swagger+mybatis-plus
08-16
自己无聊时做的一套springboot整合swagger和mybatis-plus的案例，刚入门的小伙伴可以看一下，大家一起探讨探讨
SpringBoot整合Mybatis-Plus+Oracle+Mysql
01-05
注册中心为nacos SpringBoot整合Mybatis-Plus分页查询+Oracle+Mysql+swagger2
SpringBoot 3.1.10 整合Mybatis-plus（快速学会）
最新发布
m0_67245030的博客
04-16 1652
快速上手Mybatis-plus~
springboot整合mybatis-plus逆向工程的实现
09-07
主要介绍了springboot整合mybatis-plus逆向工程的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
SpringBoot整合MyBatis-Plus
06-17
SpringBoot整合MyBatis-Plus小Demo，含有MyBatis代码生成器
MyBatis-Plus框架
qq_42108331的博客
07-09 1025
MyBatis-Plus
springboot2.3 整合mybatis-plus 高级功能
胖虎儿的博客
08-06 9249
学习并使用mybatis-plus的一些高级功能的用法例如： AR模式、 乐观锁 、逻辑删除 、自动填充、性能分析等功能
完全解决idea中com.baomidou报错
热门推荐
weixin_45875257的博客
11-11 2万+
完全解决idea中com.baomidou报错 pom.xml里添加： <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.4.2<ersion> </dependency> 清除yml文件中所有mybatis、mybatis
springboot集成mybatis-plus
婲落ヽ红颜谇的博客
08-27 136
所需依赖 <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.4.2</version> </dependency> <dependency> <groupId>com.baomidou</gr.
Springboot整合Mybatis Plus【超详细】
玩转Java
05-31 1万+
springboot整合mybatis plus
Springboot+Mybatis-puls整合
柒七的博客
05-26 9017
一、MyBatis-Plus 1.1、简介 　　MyBatis-Plus 是一个 Mybatis 增强版工具，在 MyBatis 上扩充了其他功能没有改变其基本功能，为了简化开发提交效率而存在。 官网文档地址：https://mp.baomidou.com/guide/ MyBatis-Plus 特性：https://mp.baomidou.com/guide/#%E7%89%B9%E6%80%A7 1.2、使用 SpringBoot 快速使用 MyBatis-Plus （1）准备工作 需
MyBatisPlus--代码生成器
qq_45917176的博客
04-19 1498
官网地址：代码生成器（新） | MyBatis-Plus (baomidou.com) 1、引入依赖 在pom.xml中引入 <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-generator</artifactId> <version>3.5.1</version> </dependency>.
Mybatis-plus BindingException问题
qq_18398239的博客
12-03 3120
原因：找不到 ***mapper.xml 问题
SpringBoot 整合 MyBatisPlus
一个95后开发者，热爱编程，喜欢玩游戏. 希望可以结识更多的小伙伴...
06-30 6686
导包配置两大步骤-MyBatis-Plus生成代码
记录、总结
04-02 1561
MyBatis-Plus生成代码 注：以下代码生成演示基于springboot项目，如果用在SSM项目，记得修改*Mapper.xml路径 需要导入的包 <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-generator</artifactId> <version>3.5.1</version> </de
MyBatis Plus最全面的使用总结
谢小鱼的博客
10-22 5031
基本使用 填坑 1、逻辑删除：当使用@TableLogic注解给实体类标注了逻辑删除字段后，如果想要删除数据的话一定要用baseMapper.deleteById()，而不是根据id查询出来一个实体对象，然后将逻辑删除字段标记为删除（默认11为删除），然后通过updateById()去更新这个字段，因为mabatis将该字段设置为逻辑删除后，update操作会忽略这个字段，默认将它设置为0。 ...
com.baomidou.mybatisplus.autoconfigure.IdentifierGeneratorAutoConfiguration$InetUtilsAutoConfig.iden
Adobe Chow 的博客
04-21 5221
报错日志： *************************** APPLICATION FAILED TO START *************************** Description: An attempt was made to call a method that does not exist. The attempt was made from the following location: com.baomidou.mybatisplus.autoconfig
MyBatis-Plus springboot 整合配置
07-13
Spring Boot是一个快速开发框架，Mybatis-Plus是一个Mybatis的增强工具，可以简化Mybatis的开发。将它们整合起来可以更快速地开发出高质量的应用程序。 整合步骤如下： 1. 引入依赖 在pom.xml文件中添加以下依赖： ``` <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.4.2</version> </dependency> ``` 2. 配置数据源 在application.properties文件中配置数据源信息，例如： ``` spring.datasource.driver-class-name=com.mysql.jdbc.Driver spring.datasource.url=jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf-8&useSSL=false spring.datasource.username=root spring.datasource.password=root ``` 3. 配置Mybatis-Plus 在配置类中添加以下注解： ``` @Configuration @MapperScan("com.example.mapper") public class MybatisPlusConfig { } ``` 其中，@MapperScan注解指定了Mapper接口所在的包路径。 4. 编写Mapper接口 编写Mapper接口，例如： ``` @Mapper public interface UserMapper extends BaseMapper<User> { } ``` 其中，User是实体类，BaseMapper是Mybatis-Plus提供的基础Mapper接口。 5. 使用Mapper接口 在Service中注入Mapper接口，例如： ``` @Service public class UserServiceImpl implements UserService { @Autowired private UserMapper userMapper; @Override public User getUserById(Long id) { return userMapper.selectById(id); } } ``` 以上就是Spring Boot整合Mybatis-Plus的基本步骤。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值