一、基本配置

 本部分配置包含了大部分用户的常用配置,其中一部分为 MyBatis 原生所支持的配置。    

(1)、configLocation

  • 类型:String
  • 默认值:null

MyBatis 配置文件位置,如果您有单独的 MyBatis 配置,请将其路径配置到 configLocation 中。

    1.Spring Boot:

mybatis-plus:
           config-location: classpath:mybatis-config.xml    2.Spring MVC:
    <bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
             <property name="configLocation" value="classpath:mybatis-config.xml"/>
     </bean>

(2)、mapperLocations

  • 类型:String[]
  • 默认值:[]

MyBatis Mapper 所对应的 XML 文件位置,如果您在 Mapper 中有自定义方法(XML 中有自定义实现),需要进行该配置,告诉 Mapper 所对应的 XML 文件位置。   

    1.Spring Boot:

mybatis-plus:
           mapper-locations: classpath*:mybatis/*.xml    2.Spring MVC:
    <bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
             <property name="mapperLocations" value="classpath*:mybatis/*.xml"/>
     </bean>

说明:Maven 多模块项目的扫描路径需以 classpath*: 开头 (即加载多个 jar 包下的 XML 文件)

(3)、typeAliasesPackage

  • 类型:String
  • 默认值:null

MyBaits 别名包扫描路径,通过该属性可以给包中的类注册别名,注册后在 Mapper 对应的 XML 文件中可以直接使用类名,而不用使用全限定的类名(即 XML 中调用的时候不用包含包名)。

    1.Spring Boot:

mybatis-plus:
               type-aliases-package: com.baomidou.mybatisplus.samples.quickstart.entity    2.Spring MVC:
    <bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
             <property name="typeAliasesPackage" value="com.baomidou.mybatisplus.samples.quickstart.entity"/>
     </bean>

(4)、typeAliasesSuperType

  • 类型:Class<?>
  • 默认值:null

该配置请和 typeAliasesPackage 一起使用,如果配置了该属性,则仅仅会扫描路径下以该类作为父类的域对象 。

    1.Spring Boot:

mybatis-plus:
           type-aliases-package: com.baomidou.mybatisplus.samples.quickstart.entity
           type-aliases-super-type: java.lang.Object    2.Spring MVC:
    <bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
             <property name="typeAliasesPackage" value="com.baomidou.mybatisplus.samples.quickstart.entity"/>
             <property name="typeAliasesSuperType" value="java.lang.Object"/>
     </bean>

(5)、typeHandlersPackage

  • 类型:String
  • 默认值:null

TypeHandler 扫描路径,如果配置了该属性,SqlSessionFactoryBean 会把该包下面的类注册为对应的 TypeHandler。(TypeHandler 通常用于自定义类型转换。)

    1.Spring Boot:

  

mybatis-plus:
           type-handlers-package: com.baomidou.mybatisplus.samples.quickstart.handler    2.Spring MVC:
    <bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
             <property name="typeHandlersPackage" value="com.baomidou.mybatisplus.samples.quickstart.handler"/>
     </bean>

(6)、typeEnumsPackage

  • 类型:String
  • 默认值:null

枚举类 扫描路径,如果配置了该属性,会将路径下的枚举类进行注入,让实体类字段能够简单快捷的使用枚举属性,具体使用请结合 枚举注入 查看。

    1.Spring Boot:

 

mybatis-plus:
           type-enums-package: com.baomidou.mybatisplus.samples.quickstart.enums    2.Spring MVC:
    <bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
             <property name="typeEnumsPackage" value="com.baomidou.mybatisplus.samples.quickstart.enums"/>
     </bean>(7)、checkConfigLoca

tion

  • 类型:boolean
  • 默认值:false

启动时是否检查 MyBatis XML 文件的存在,默认不检查。

Spring Boot Only)

    mybatis-plus:
          check-config-location: false

(8)、executorType

  • 类型:ExecutorType
  • 默认值:sample

通过该属性可指定 MyBatis 的执行器,MyBatis 的执行器总共有三种:

  • ExecutorType.SIMPLE:该执行器类型不做特殊的事情,为每个语句的执行创建一个新的预处理语句(PreparedStatement)
  • ExecutorType.REUSE:该执行器类型会复用预处理语句(PreparedStatement)
  • ExecutorType.BATCH:该执行器类型会批量执行所有的更新语句

Spring Boot Only)

    mybatis-plus:
          executor-type: simple

(9)、configurationProperties

  • 类型:Properties
  • 默认值:null

指定外部化 MyBatis Properties 配置,通过该配置可以抽离配置,实现不同环境的配置部署。

    1.Spring Boot:

mybatis-plus:
           configuration-properties: classpath:mybatis/config.properties    2.Spring MVC:
    <bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
             <property name="configurationProperties" value="classpath:mybatis/config.properties"/>
     </bean>

(10)、configuration

  • 类型:Configuration
  • 默认值:null

原生 MyBatis 所支持的配置。

(11)、globalConfig

  • 类型:GlobalConfig
  • 默认值:null

MyBatis-Plus 全局策略配置