MyBatis-Plus配置项

最新推荐文章于 2025-02-21 16:28:46 发布
最新推荐文章于 2025-02-21 16:28:46 发布
阅读量1.7k 收藏 3
点赞数
分类专栏： MyBatis 文章标签： java Mybatis-Plus配置
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Be_insighted/article/details/120031339
版权

来看下MyBatis-Plus可以支持哪些配置项(可配置的属性)

####################  mybatis-plus配置  ###################
mybatis-plus:
  #外部化xml配置
  #config-location: classpath:mybatis-config.xml
  #指定外部化 MyBatis Properties 配置，通过该配置可以抽离配置，实现不同环境的配置部署
  #configuration-properties: classpath:mybatis/config/properties
  #xml扫描，多个目录用逗号或者分号分割（告诉 Mapper 所对应的 XML 文件位置）
  mapper-locations: classpath*:com/wongoing/sys/mapper/xml/*.xml
  #MyBatis 别名包扫描路径，通过该属性可以给包中的类注册别名，多个路径用逗号分割
  type-aliases-package: com.wongoing.sys.model
  #如果配置了该属性，则仅仅会扫描路径下以该类作为父类的域对象
  type-aliases-super-type: java.lang.Object
  #枚举类 扫描路径，如果配置了该属性，会将路径下的枚举类进行注入，让实体类字段能够简单快捷的使用枚举属性
  #type-enums-package: com.wongoing.sys.model
  #项目启动会检查xml配置存在（只在开发时打开）
  check-config-location: true
  #SIMPLE：该执行器类型不做特殊的事情，为每个语句的执行创建一个新的预处理语句，REUSE：改执行器类会复用预处理语句，BATCH：该执行器类型会批量执行所有的更新语句
  default-executor-type: REUSE
  configuration:
    # 是否开启自动驼峰命名规则（camel case）映射，即从经典数据库列名 A_COLUMN（下划线命名） 到经典 Java 属性名 aColumn（驼峰命名） 的类似映射
    map-underscore-to-camel-case: true
    # 全局地开启或关闭配置文件中的所有映射器已经配置的任何缓存，默认为 true
    cache-enabled: true
    #懒加载
    aggressive-lazy-loading: true
    #none：不启用自动映射 partial：只对非嵌套的 resultMap 进行自动映射 full：对所有的 resultMap 都进行自动映射
    auto-mapping-behavior: partial
    #none：不做任何处理 (默认值)warning：以日志的形式打印相关警告信息 failing：当作映射失败处理，并抛出异常和详细信息
    auto-mapping-unknown-column-behavior: none
    #如果查询结果中包含空值的列，则 MyBatis 在映射的时候，会不会映射这个字段
    call-setters-on-nulls: true   #允许在resultType="map"时映射null值
    #这个配置会将执行的sql打印出来，在开发或测试的时候可以用
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
    #是否允许映射结果为多个数据集
    multiple-result-sets-enabled: false
  global-config:
    db-config:
      #表名下划线命名默认为true
      table-underline: false
      #id类型: 0  # 0:数据库ID自增   1:用户输入id  2:全局唯一id(IdWorker)  3:全局唯一ID(uuid)
      id-type: auto
      #是否开启大写命名，默认不开启
      capital-mode: false
      #逻辑已删除值,(逻辑删除下有效) 需要注入逻辑策略LogicSqlInjector 以@Bean方式注入
      logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)
      #逻辑未删除值,(逻辑删除下有效)
      logic-delete-value: 1 # 逻辑已删除值(默认为 1)

配置类所在的位置

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.baomidou.mybatisplus.autoconfigure.MybatisPlusAutoConfiguration
@ConfigurationProperties(
    prefix = "mybatis-plus"
)
public class MybatisPlusProperties {
    private static final ResourcePatternResolver resourceResolver = new PathMatchingResourcePatternResolver();
    private String configLocation;
    private String[] mapperLocations;
    private String typeAliasesPackage;
    private Class<?> typeAliasesSuperType;
    private String typeHandlersPackage;
    private String typeEnumsPackage;
    private boolean checkConfigLocation = false;
    private ExecutorType executorType;
    private Properties configurationProperties;
    @NestedConfigurationProperty
    private MybatisConfiguration configuration;
    @NestedConfigurationProperty
    private GlobalConfig globalConfig = GlobalConfigUtils.defaults();
}
@Configuration
@ConditionalOnClass({SqlSessionFactory.class, SqlSessionFactoryBean.class})
@ConditionalOnSingleCandidate(DataSource.class)
@EnableConfigurationProperties({MybatisPlusProperties.class})
@AutoConfigureAfter({DataSourceAutoConfiguration.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 ResourceLoader resourceLoader;
    private final DatabaseIdProvider databaseIdProvider;
    private final List<ConfigurationCustomizer> configurationCustomizers;
    private final ApplicationContext applicationContext;

    public MybatisPlusAutoConfiguration(MybatisPlusProperties properties, ObjectProvider<Interceptor[]> interceptorsProvider, ResourceLoader resourceLoader, ObjectProvider<DatabaseIdProvider> databaseIdProvider, ObjectProvider<List<ConfigurationCustomizer>> configurationCustomizersProvider, ApplicationContext applicationContext) {
        this.properties = properties;
        this.interceptors = (Interceptor[])interceptorsProvider.getIfAvailable();
        this.resourceLoader = resourceLoader;
        this.databaseIdProvider = (DatabaseIdProvider)databaseIdProvider.getIfAvailable();
        this.configurationCustomizers = (List)configurationCustomizersProvider.getIfAvailable();
        this.applicationContext = applicationContext;
    }

    public void afterPropertiesSet() {
        this.checkConfigFileExists();
    }

    private void checkConfigFileExists() {
        if (this.properties.isCheckConfigLocation() && StringUtils.hasText(this.properties.getConfigLocation())) {
            Resource resource = this.resourceLoader.getResource(this.properties.getConfigLocation());
            Assert.state(resource.exists(), "Cannot find config location: " + resource + " (please add config file or check your Mybatis configuration)");
        }

    }

    @Bean
    @ConditionalOnMissingBean
    public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {
        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()));
        }

        this.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 (StringUtils.hasLength(this.properties.getTypeEnumsPackage())) {
            factory.setTypeEnumsPackage(this.properties.getTypeEnumsPackage());
        }

        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.properties.resolveMapperLocations())) {
            factory.setMapperLocations(this.properties.resolveMapperLocations());
        }

        GlobalConfig globalConfig = this.properties.getGlobalConfig();
        if (this.applicationContext.getBeanNamesForType(MetaObjectHandler.class, false, false).length > 0) {
            MetaObjectHandler metaObjectHandler = (MetaObjectHandler)this.applicationContext.getBean(MetaObjectHandler.class);
            globalConfig.setMetaObjectHandler(metaObjectHandler);
        }

        if (this.applicationContext.getBeanNamesForType(IKeyGenerator.class, false, false).length > 0) {
            IKeyGenerator keyGenerator = (IKeyGenerator)this.applicationContext.getBean(IKeyGenerator.class);
            globalConfig.getDbConfig().setKeyGenerator(keyGenerator);
        }

        if (this.applicationContext.getBeanNamesForType(ISqlInjector.class, false, false).length > 0) {
            ISqlInjector iSqlInjector = (ISqlInjector)this.applicationContext.getBean(ISqlInjector.class);
            globalConfig.setSqlInjector(iSqlInjector);
        }

        factory.setGlobalConfig(globalConfig);
        return factory.getObject();
    }

    private void applyConfiguration(MybatisSqlSessionFactoryBean factory) {
        MybatisConfiguration configuration = this.properties.getConfiguration();
        if (configuration == null && !StringUtils.hasText(this.properties.getConfigLocation())) {
            configuration = new MybatisConfiguration();
        }

        if (configuration != null && !CollectionUtils.isEmpty(this.configurationCustomizers)) {
            Iterator var3 = this.configurationCustomizers.iterator();

            while(var3.hasNext()) {
                ConfigurationCustomizer customizer = (ConfigurationCustomizer)var3.next();
                customizer.customize(configuration);
            }
        }

        factory.setConfiguration(configuration);
    }

    @Bean
    @ConditionalOnMissingBean
    public SqlSessionTemplate sqlSessionTemplate(SqlSessionFactory sqlSessionFactory) {
        ExecutorType executorType = this.properties.getExecutorType();
        return executorType != null ? new SqlSessionTemplate(sqlSessionFactory, executorType) : new SqlSessionTemplate(sqlSessionFactory);
    }

    @Configuration
    @Import({MybatisPlusAutoConfiguration.AutoConfiguredMapperScannerRegistrar.class})
    @ConditionalOnMissingBean({MapperFactoryBean.class})
    public static class MapperScannerRegistrarNotFoundConfiguration implements InitializingBean {
        public MapperScannerRegistrarNotFoundConfiguration() {
        }

        public void afterPropertiesSet() {
            MybatisPlusAutoConfiguration.logger.debug("No {} found.", MapperFactoryBean.class.getName());
        }
    }

    public static class AutoConfiguredMapperScannerRegistrar implements BeanFactoryAware, ImportBeanDefinitionRegistrar, ResourceLoaderAware {
        private BeanFactory beanFactory;
        private ResourceLoader resourceLoader;

        public AutoConfiguredMapperScannerRegistrar() {
        }

        public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
            if (!AutoConfigurationPackages.has(this.beanFactory)) {
                MybatisPlusAutoConfiguration.logger.debug("Could not determine auto-configuration package, automatic mapper scanning disabled.");
            } else {
                MybatisPlusAutoConfiguration.logger.debug("Searching for mappers annotated with @Mapper");
                List<String> packages = AutoConfigurationPackages.get(this.beanFactory);
                if (MybatisPlusAutoConfiguration.logger.isDebugEnabled()) {
                    packages.forEach((pkg) -> {
                        MybatisPlusAutoConfiguration.logger.debug("Using auto-configuration base package '{}'", pkg);
                    });
                }

                ClassPathMapperScanner scanner = new ClassPathMapperScanner(registry);
                if (this.resourceLoader != null) {
                    scanner.setResourceLoader(this.resourceLoader);
                }

                scanner.setAnnotationClass(Mapper.class);
                scanner.registerFilters();
                scanner.doScan(StringUtils.toStringArray(packages));
            }
        }

        public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
            this.beanFactory = beanFactory;
        }

        public void setResourceLoader(ResourceLoader resourceLoader) {
            this.resourceLoader = resourceLoader;
        }
    }
}

@ConditionalOnClass({SqlSessionFactory.class, SqlSessionFactoryBean.class})
@ConditionalOnSingleCandidate(DataSource.class)
@EnableConfigurationProperties({MybatisPlusProperties.class})
@AutoConfigureAfter({DataSourceAutoConfiguration.class})

mybatis-plus源码（mybatis-plus-3.5.1.zip）
03-03
4. **GlobalConfig**：全局配置类，包含了MyBatis-Plus的各种配置项。 5. **BaseMapper**和**BaseService**：这两个接口定义了基本的数据库操作方法。 6. **Wrapper**系列：QueryWrapper、UpdateWrapper等，用于构建...
Mybatis迁移到Mybatis-Plus的实现方法
09-07
在应用的配置文件中，添加Mybatis-Plus的配置项，指定类型别名包和Mapper的扫描路径。例如，`type-aliases-package`用于指定所有实体类所在的包，`mapper-locations`定义了Mapper XML文件的路径。 5. **删除...
Mybatis——配置解析
ouyangkq666的博客
01-07 520
一、配置解析 1、核心配置文件 2、环境配置（environments） 3、属性（properties） 4、类型别名（typeAliases） 5、设置（settings） 6、其他配置 7、映射器（mappers） 8、生命周期和作用域 二、解决属性名和字段名不一致的问题 1、问题 2、resultMap
MyBatis-Plus配置全局属性，并在xml中引用
甘蓝的专栏
12-25 1917
MyBatis-Plus配置全局属性，并在xml中引用。源码解读属性被解析的过程。
SpringBoot中使用MyBatis-Plus详细介绍
最新发布
m0_74824780的博客
02-21 1066
在该接口中，提供了许多基本的sql增删改查方法，我们无需写sql语句，直接调用这些方法即可完成对数据的增删改查；
Mybatis-Plus的使用（三）——注解与配置文件
橙子和栗子的的博客
09-03 9572
原文链接：橙子&栗子&世界——Mybatis-Plus的使用（三）——注解与配置文件 Mybatis-Plus的有些注解和配置文件是相辅相成的，比如:@TableField的insertStrategy、updateStrategy等属性，如果没有单独设置，则就会跟随全局配置，具体的常用配置（.yml）在文章的后半部分有写。 常用注解 对于我来说最常用的注解有三个@TableN...
MyBatis-Plus进阶之常用配置，看完别说不懂MyBatis-Plus配置
热门推荐
qq_36551991的博客
01-26 2万+
目录前言基础配置Configuration配置GlobalConfig配置dbConfig配置 前言 下面介绍下MyBatis-Plus在使用过程中的常用配置选项，其中，部分配置继承自MyBatis原生所支持的配置 下面是在两种不同配置文件配置的示例： yml文件： mybatis-plus: ...... configuration: ...... global-config: ...... db-config: ...... properties文件
MyBatis-Plus（三）~使用过程中的配置选项（基本配置）
chengxi2031的博客
12-08 3345
一、基本配置 本部分配置包含了大部分用户的常用配置，其中一部分为 MyBatis 原生所支持的配置。 （1）、configLocation 类型：String 默认值：null MyBatis 配置文件位置，如果您有单独的 MyBatis 配置，请将其路径...
Mybatis-plus自动注入属性
qq_32388061的博客
07-01 1447
记录mybatis-plus如何自动注入属性
MyBatis-Plus Generator配置详解
09-07
接下来，还有其他重要的配置项： 8. **全局配置**： 你可以设置全局变量，比如命名策略（`NamingStrategy`），字段策略（`FieldStrategy`），是否开启驼峰命名（`entityTableFieldNaming`），是否生成Lombok注解等...
mybatis-plus代码生成器模版代码
08-17
使用Mybatis-Plus代码生成器时，要注意与Mybatis的配置保持一致，确保Mybatis的mapper扫描路径包含了生成的Mapper接口，同时在Spring Boot的配置文件（application.yml或application.properties）中添加相应的数据源...
mybatis-plus 表名添加前缀的实现方法
09-07
MyBatis-Plus 提供了一个全局配置项 `table-prefix` 来设置表名前缀。在你的项目配置文件（如 YAML 或 XML）中，你可以这样设置： ```yaml mybatis-plus: mapper-locations: classpath:mappers/*Mapper.xml # ...
MyBatis-Plus——超详细讲解配置文件
sunqinshan的博客
01-11 6369
以上的【MyBatis-Plus配置详解】是一心同学是在网上阅读了不少【文章】，同时也有参考了几位【牛人】的讲解，最后【整理】出来的，大家也看到，这配置是非常的多，我们只需要大概知道其配置有什么功能，然后在开发过程中直接【应用】即可。通俗的讲，即 MyBatis 在使用 resultMap 来映射查询结果中的列，如果查询结果中包含空值的列，则 MyBatis 在映射的时候，不会映射这个字段，这就导致在调用到该字段的时候由于没有映射，取不到而报空指针异常。
MyBatis-Plus配置
好好学习
11-28 1万+
在Mybatis-Plus中有大量配置，其中有一部分是Mybatis原生的配置，另一部分是Mybatis-Plus的配置 基本配置 configLocation MyBatis配置文件位置，如果有单独单独的MyBatis配置，请将其路径配置到configLocation中。MyBatisConfiguration的具体内容请参考MyBatis官方文档 Spring Boot mybatis-plus.config-location=classpath:mybatis-config.xml Spring
mybatisplus动态schema配置
lengxia0的博客
04-21 4025
查询测试环境数据库与生产环境数据库时，sql中的schema一致。
Mybatis-Plus（二）—— 配置
weixin_56697114的博客
07-17 1962
1、配置 在MP中有大量的配置，其中有一部分是Mybatis原生的配置，另一部分是MP的配置，详情：https://mybatis.plus/config/ 1、 基本配置 1、MyBatis 配置文件位置 如果您有单独的 MyBatis 配置，请将其路径配置到 configLocation 中。 MyBatisConfiguration 的具体内容请参考MyBatis 官方文档 Spring Boot： mybatis-plus.config-location = classpat...
MyBatis-Plus 学习笔记-配置(二) Configuration
咕德猫宁的博客
11-13 1735
MyBatis-Plus 的 Configuration 配置继承自 MyBatis 原生支持的配置，这意味着您可以通过 MyBatis XML 配置文件的形式进行配置，也可以通过 Spring Boot 的配置文件进行设置。
Mybatis-Plus（三）--Mybatis-Plus配置和条件构造器
bjjx123456的博客
07-23 3398
在MP中有大量的配置，其中有一部分是Mybatis原生的配置，另一部分是MP的配置，详情：https://mybatis.plus/config。
# mybatis-plus配置
09-09
MyBatis-Plus 是一个基于 MyBatis 的增强工具，提供了一些额外的功能和便利的配置。下面是一些常见的 MyBatis-Plus 配置： 1. 添加依赖：在项目的 `pom.xml` 文件中添加 MyBatis-Plus 的依赖： ```xml <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>latest-version</version> </dependency> ``` 2. 配置数据源：在 Spring Boot 的配置文件（`application.properties` 或 `application.yml`）中配置数据源信息，例如： ```yaml spring: datasource: url: jdbc:mysql://localhost:3306/my_database username: root password: my_password driver-class-name: com.mysql.cj.jdbc.Driver ``` 3. 配置 MyBatis-Plus：创建一个配置类，用于配置 MyBatis-Plus 相关的配置项，例如： ```java @Configuration @MapperScan("com.example.mapper") // 指定 Mapper 类所在的包路径 public class MybatisPlusConfig { @Bean public PaginationInterceptor paginationInterceptor() { return new PaginationInterceptor(); } } ``` 4. 创建实体类和 Mapper 接口：创建与数据库表对应的实体类和对应的 Mapper 接口，使用 MyBatis-Plus 的注解进行配置。例如： ```java @Data @TableName("user") public class UserEntity { @TableId(type = IdType.AUTO) private Long id; private String username; private Integer age; // 省略 getter 和 setter } ``` ```java public interface UserMapper extends BaseMapper<UserEntity> { // 可以直接使用 MyBatis-Plus 提供的方法，也可以自定义 SQL 方法 } ``` 这些是 MyBatis-Plus 的基本配置，你还可以根据需求进行一些高级配置，例如分页插件、逻辑删除、多租户等。具体的配置和使用方法可以参考 MyBatis-Plus 的官方文档。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值