欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Mybatis-Plus配置

程序员文章站 2022-12-20 14:30:51
在Mybatis-Plus中有大量的配置,其中有一部分是Mybatis原生的配置,另一部分是Mybatis-Plus的配置,文档:https://mybatis.plus/config/基本配置configLocationMyBatis 配置文件位置,如果有单独的 MyBatis 配置,请将其路径配置到 configLocation 中。 MyBatis Configuration 的具体内容请参考MyBatis 官方文档 Spring Boot# 指定全局的配置文件mybatis-plus...

在Mybatis-Plus中有大量的配置,其中有一部分是Mybatis原生的配置,另一部分是Mybatis-Plus的配置,文档:https://mybatis.plus/config/

基本配置

configLocation

MyBatis 配置文件位置,如果有单独的 MyBatis 配置,请将其路径配置到 configLocation 中。 MyBatis Configuration 的具体内容请参考MyBatis 官方文档

Spring Boot

# 指定全局的配置文件
mybatis-plus.config-location=classpath:mybatis-config.xml

Spring MVC

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

mapperLocations

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

Spring Boot

# 指定Mapper.xml文件的路径
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 文件)

UserMapper

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="cn.com.javakf.mapper.UserMapper">

	<select id="findById" resultType="cn.com.javakf.pojo.User">
		select * from tb_user where id = #{id}
	</select>

</mapper>
public interface UserMapper extends BaseMapper<User> {

	User findById(Long id);

}

测试用例

/**
 * 自定义的方法
 */
@Test
public void testFindById() {
	User user = this.userMapper.findById(2L);
	System.out.println(user);
}

测试结果

[main] [cn.com.javakf.mapper.UserMapper.findById]-[DEBUG] ==>  Preparing: select * from tb_user where id = ? 
[main] [cn.com.javakf.mapper.UserMapper.findById]-[DEBUG] ==> Parameters: 2(Long)
[main] [cn.com.javakf.mapper.UserMapper.findById]-[DEBUG] <==      Total: 1
[main] [org.mybatis.spring.SqlSessionUtils]-[DEBUG] Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@74dbb1ee]
User(id=2, userName=lisi, password=123456, name=李四, age=20, mail=null, address=null)

typeAliasesPackage

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

Spring Boot

# 实体对象的扫描包
mybatis-plus.type-aliases-package = cn.com.javakf.pojo

Spring MVC

<bean id="sqlSessionFactory"
	class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
	<property name="typeAliasesPackage"
		value="com.baomidou.mybatisplus.samples.quickstart.entity" />
</bean>

UserMapper

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="cn.com.javakf.mapper.UserMapper">

	<select id="findById" resultType="User">
		select * from tb_user where id = #{id}
	</select>

</mapper>

进阶配置

本部分(Configuration)的配置大都为 MyBatis 原生支持的配置,这意味着可以通过 MyBatis XML 配置文件的形式进行配置。

mapUnderscoreToCamelCase

  • 类型: boolean
  • 默认值: true


是否开启自动驼峰命名规则(camel case)映射,即从经典数据库列名 A_COLUMN(下划线命名) 到经典 Java 属性名 aColumn(驼峰命名) 的类似映射。

注意:
此属性在 MyBatis 中原默认值为 false,在 MyBatis-Plus 中,此属性也将用于生成最终的 SQL 的 select body
如果您的数据库命名符合规则,无需使用 @TableField 注解指定数据库字段名


Spring Boot

#关闭自动驼峰映射,该参数不能和mybatis-plus.config-location同时存在
mybatis-plus.configuration.map-underscore-to-camel-case=false

cacheEnabled

  • 类型: boolean
  • 默认值: true


全局地开启或关闭配置文件中的所有映射器已经配置的任何缓存,默认为 true。

Spring Boot

# 禁用缓存
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

<bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
	<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>

User配置

@Data
@NoArgsConstructor
@AllArgsConstructor
@TableName("tb_user")
public class User {

	// @TableId(type = IdType.AUTO) // 指定id类型为自增长
	private Long id;
	private String userName;
	@TableField(select = false) // 查询时不返回该字段的值
	private String password;
	private String name;
	private Integer age;
	@TableField(value = "email") // 指定数据表中字段名
	private String mail;
	@TableField(exist = false)
	private String address; // 在数据库表中是不存在的

}

tablePrefix

  • 类型: String
  • 默认值: null


表名前缀,全局配置后可省略@TableName()配置。

SpringBoot

# 全局的表名的前缀
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>

User配置

@Data
@NoArgsConstructor
@AllArgsConstructor
//@TableName("tb_user")
public class User {

	@TableId(type = IdType.AUTO) // 指定id类型为自增长
	private Long id;
	private String userName;
	@TableField(select = false) // 查询时不返回该字段的值
	private String password;
	private String name;
	private Integer age;
	@TableField(value = "email") // 指定数据表中字段名
	private String mail;
	@TableField(exist = false)
	private String address; // 在数据库表中是不存在的

}

本文地址:https://blog.csdn.net/weixin_45730091/article/details/107330927