使用方式

Spring Boot:

  1. mybatis-plus:
  2. ......
  3. configuration:
  4. ......
  5. global-config:
  6. ......
  7. db-config:
  8. ......

Spring MVC:

  1. <bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
  2. <property name="configuration" ref="configuration"/> <!-- 非必须 -->
  3. <property name="globalConfig" ref="globalConfig"/> <!-- 非必须 -->
  4. ......
  5. </bean>
  6. <bean id="configuration" class="com.baomidou.mybatisplus.core.MybatisConfiguration">
  7. ......
  8. </bean>
  9. <bean id="globalConfig" class="com.baomidou.mybatisplus.core.config.GlobalConfig">
  10. <property name="dbConfig" ref="dbConfig"/> <!-- 非必须 -->
  11. ......
  12. </bean>
  13. <bean id="dbConfig" class="com.baomidou.mybatisplus.core.config.GlobalConfig.DbConfig">
  14. ......
  15. </bean>

configLocation

  • 类型:String
  • 默认值:nullMyBatis 配置文件位置,如果您有单独的 MyBatis 配置,请将其路径配置到 configLocation 中.MyBatis Configuration 的具体内容请参考MyBatis 官方文档使用方式 - 图1

mapperLocations

  • 类型:String[]
  • 默认值:[]MyBatis Mapper 所对应的 XML 文件位置,如果您在 Mapper 中有自定义方法(XML 中有自定义实现),需要进行该配置,告诉 Mapper 所对应的 XML 文件位置

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

typeAliasesPackage

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

typeAliasesSuperType

  • 类型:Class<?>
  • 默认值:null该配置请和 typeAliasesPackage 一起使用,如果配置了该属性,则仅仅会扫描路径下以该类作为父类的域对象

typeHandlersPackage

  • 类型:String
  • 默认值:nullTypeHandler 扫描路径,如果配置了该属性,SqlSessionFactoryBean 会把该包下面的类注册为对应的 TypeHandler

TypeHandler 通常用于自定义类型转换。

typeEnumsPackage

  • 类型:String
  • 默认值:null枚举类 扫描路径,如果配置了该属性,会将路径下的枚举类进行注入,让实体类字段能够简单快捷的使用枚举属性

checkConfigLocation Spring Boot Only

  • 类型:boolean
  • 默认值:false启动时是否检查 MyBatis XML 文件的存在,默认不检查

executorType Spring Boot Only

  • 类型:ExecutorType
  • 默认值:simple通过该属性可指定 MyBatis 的执行器,MyBatis 的执行器总共有三种:

  • ExecutorType.SIMPLE:该执行器类型不做特殊的事情,为每个语句的执行创建一个新的预处理语句(PreparedStatement)

  • ExecutorType.REUSE:该执行器类型会复用预处理语句(PreparedStatement)
  • ExecutorType.BATCH:该执行器类型会批量执行所有的更新语句

configurationProperties

  • 类型:Properties
  • 默认值:null指定外部化 MyBatis Properties 配置,通过该配置可以抽离配置,实现不同环境的配置部署

configuration

  • 类型:Configuration
  • 默认值:null原生 MyBatis 所支持的配置,具体请查看 Configuration

globalConfig

  • 类型:GlobalConfig
  • 默认值:nullMyBatis-Plus 全局策略配置,具体请查看 GlobalConfig