一. 基礎配置
1. configLocation
MyBatis 配置文件位置,如果您有單獨的 MyBatis 配置,請將其路徑配置到 configLocation 中。 MyBatisConfiguration 的具體內容請參考MyBatis 官方文檔。
SpringBoot:
mybatis-plus.config-location = classpath:mybatis-config.xml
Spring MVC:
1 < bean id="sqlSessionFactory" 2 class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean"> 3 <property name="configLocation" value="classpath:mybatis-config.xml"/> 4 </bean
2. mapperLocations
MyBatis Mapper 所對應的 XML 文件位置,如果您在 Mapper 中有自定義方法(XML 中有自定義實現),需要進行該配置,告訴 Mapper 所對應的 XML 文件位置。
SpringBoot:
mybatis-plus.mapper-locations = classpath*:mybatis/*.xml
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
MyBaits 別名包掃描路徑,通過該屬性可以給包中的類注冊別名,注冊后在 Mapper 對應的 XML 文件中可以直接使用類名,而不用使用全限定的類名(即 XML 中調用的時候不用包含包名)。
SpringBoot:
mybatis-plus.type-aliases-package = cn.itcast.mp.pojo
Spring MVC:
< bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean"> <property name="typeAliasesPackage" value="com.baomidou.mybatisplus.samples.quickstart.entity"/> </bean>
二、進階配置
1. mapUnderscoreToCamelCase
是否開啟自動駝峰命名規則(camel case)映射,即從經典數據庫列名 A_COLUMN(下划線命名) 到經典 Java 屬性名 aColumn(駝峰命名) 的類似映射。
注意:此屬性在 MyBatis 中原默認值為 false,在 MyBatis-Plus 中,此屬性也將用於生成最終的 SQL 的 select body如果您的數據庫命名符合規則無需使用 @TableField 注解指定數據庫字段名
示例:
# 關閉自動駝峰映射,該參數不能和mybatis-plus.config-location同時存在
mybatis-plus.configuration.map-underscore-to-camel-case=false
2. cacheEnabled
全局地開啟或關閉配置文件中的所有映射器已經配置的任何緩存,默認值: true。
示例:
mybatis-plus.configuration.cache-enabled =false
三、DB策略配置
1. idType
全局默認主鍵類型,設置后,即可省略實體對象中的@TableId(type = IdType.AUTO)配置。默認值:ID_WORKER
SpringBoot示例:
mybatis-plus.global-config.db-config.id-type =auto
Spring MVC示例:
<!-- 這里使用MP提供的sqlSessionFactory,完成了Spring與MP的整合--> <bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean"> <property name="dataSource" ref="dataSource"/> <property name="globalConfig"> <bean class="com.baomidou.mybatisplus.core.config.GlobalConfig"> <property name="dbConfig"> <bean class="com.baomidou.mybatisplus.core.config.GlobalConfig$DbConfig"> <property name="idType" value="AUTO"/> </bean> </property> </bean> </property> </bean
2. tablePrefix
表名前綴,全局配置后可省略 @TableName()配置。默認值:null
SpringBoot示例:
mybatis-plus.global-config.db-config.table-prefix =tb_
Spring MVC示例:
<bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean"> <property name="dataSource" ref="dataSource"/> <property name="globalConfig"> <bean class="com.baomidou.mybatisplus.core.config.GlobalConfig"> <property name="dbConfig"> <bean class="com.baomidou.mybatisplus.core.config.GlobalConfig$DbConfig"> <property name="idType" value="AUTO"/> <property name="tablePrefix" value="tb_"/> </bean> </property> </bean> </property> </bean
四、配置參考
# 指定全局的配置文件 #mybatis-plus.config-location=classpath:mybatis-config.xml # 指定Mapper.xml文件的路徑 mybatis-plus.mapper-locations = classpath*:mybatis/*.xml # 實體對象的掃描包 mybatis-plus.type-aliases-package = cn.itcast.mp.pojo # 禁用自定的駝峰映射 mybatis-plus.configuration.map-underscore-to-camel-case=true # 禁用緩存 mybatis-plus.configuration.cache-enabled=false # 全局的id生成策略 mybatis-plus.global-config.db-config.id-type=auto # 全局的表名的前綴 mybatis-plus.global-config.db-config.table-prefix=tb_