MybatisPlus快速上手1——MybatisPlus插件的介绍和整合
相关配置
在MP中有大量的配置,其中有一部分是Mybatis原生的配置,另一部分是MP的配置,详情:https://mybatis.plus/config/
基本配置
全局配置文件的配置 configLocation
MyBatis 配置文件位置
,如果您有单独的 MyBatis 配置,请将其路径配置到 configLocation 中
。 MyBatisConfiguration 的具体内容请参考MyBatis 官方文档
SpringBoot:
# 指定全局的配置文件
mybatis-plus.config-location=classpath:mybatis-config.xml
SpringMVC
<!--这里使用MybatisPlus提供的sqlSessionFactory,完成了Spring与MP的整合,不是mybatis提供的-->
<bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
<property name="dataSource" ref="dataSource"/>
<!--SpringMVC中全局配置文件的配置-->
<property name="configLocation" value="classpath:mybatis-config.xml"/>
</bean>
自定义方法的mapper.xml文件配置 mapperLocations
MyBatis Mapper 所对应的 XML 文件位置
,如果您在开发中mybatisPlus不足以满足需求,如多表之间的查询,届时我们需要自己在 Mapper 中有自定义方法(XML 中有自定义实现),需要进行该配置
,告诉 Mapper 所对应的 XML 文件位置。
SpringBoot:
# 指定mapper.xml文件的路径
mybatis-plus.mapper-locations = classpath*:mybatis/*.xml
SpringMVC
<bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
<property name="mapperLocations" value="classpath*:mybatis/*.xml"/>
</bean>
别名的扫描包 typeAliasesPackage
MyBaits 别名包扫描路径,通过该属性可以给包中的类注册别名,注册后在 Mapper 对应的 XML 文件中可以直接使用类名,而不用使用全限定的类名(即 XML 中调用的时候不用包含包名)。
SpringBoot:
# 指定实体对象的扫描包
mybatis-plus.type-aliases-package = com.zhuo.mp.pojo
SpringMVC:
<!--这里使用MybatisPlus提供的sqlSessionFactory,完成了Spring与MP的整合,不是mybatis提供的-->
<bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
<property name="dataSource" ref="dataSource"/>
<!--SpringMVC中全局配置文件的配置-->
<property name="configLocation" value="classpath:mybatis-config.xml"/>
<!--别名-->
<property name="typeAliasesPackage" value="com.zhuo.mp.simple.pojo"/>
<!-- sql映射文件路径 -->
<property name="mapperLocations" value="classpath*:mapper/*Mapper.xml"></property>
</bean>
进阶配置
本部分(Configuration)的配置大都为 MyBatis 原生支持的配置,这意味着您可以通过 MyBatis XML 配置文件的形式进行配置。
是否开启驼峰命名法的自动映射 mapUnderscoreToCamelCase
- 类型: boolean
- 默认值: true
是否开启自动驼峰命名规则(camel case)映射,即从经典数据库列名 A_COLUMN(下划线命名) 到经典 Java 属性名 aColumn(驼峰命名) 的类似映射。
注意:
此属性在 MyBatis 中原默认值为 false,在 MyBatis-Plus 中,此属性也将用于生成最终的 SQL 的 select body
如果您的数据库命名符合规则无需使用 @TableField 注解指定数据库字段名
示例(SpringBoot):
#关闭自动驼峰映射,该参数不能和mybatis-plus.config-location同时存在
mybatis-plus.configuration.map-underscore-to-camel-case=false
开启或关闭缓存 cacheEnabled
- 类型: boolean
- 默认值: true
全局地开启或关闭配置文件中的所有映射器已经配置的任何缓存,默认为 true。
示例:
# 禁用缓存
mybatis-plus.configuration.cache-enabled=false
DB 策略配置
设置默认主键类型 idType
- 类型: com.baomidou.mybatisplus.annotation.IdType
- 默认值: ID_WORKER
全局默认主键类型,设置后,即可省略实体对象中的@TableId(type = IdType.AUTO)配置。
示例:
SpringBoot:
# 全局的id生成策略
mybatis-plus.global-config.db-config.id-type=auto
SpringMVC:
<!--这里使用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>
设置表名前缀 tablePrefix
- 类型: String
- 默认值: null
表名前缀,全局配置后可省略@TableName()配置。
SpringBoot:
# 在实体类pojo中添加表名前缀,直接映射表,无需@TableName()
mybatis-plus.global-config.db-config.table-prefix=tb_
SpringMVC:
<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>