Mybatis配置
1.前言
学习mybatis,想要灵活运用起来,肯定嘚学习mybatis的核心配置文件mybatis-config.xml,它会深深影响 MyBatis 行为的设置和属性信息。配置文档的顶层结构如下:
configuration(配置)
-
properties(属性)(重要)
-
settings(设置)(重要)
-
typeAliases(类型别名)(重要)
-
typeHandlers(类型处理器)
-
objectFactory(对象工厂)
-
plugins(插件)
-
environments(环境配置)(重要)
-
environment(环境变量)
-
transactionManager(事务管理器)
-
dataSource(数据源)
-
-
databaseIdProvider(数据库厂商标识)
-
mappers(映射器)(重要)
下文会根据个人的想法,讲解觉得重要,需要了解的几个配置
2.properties(属性)
properties属性既可以在外部进行配置,并可以进行动态替换(即在典型的 Java 属性文件中配置这些属性db.properties),也可以在 properties 元素的子元素中设置。
-
外部配置法(编写一个db.properties文件)
driver=com.mysql.cj.jdbc.Driver url=jdbc:mysql://localhost:3306/mybatis?useUnicode=true&characterEncoding=utf8&serverTimezone=UTC username=root password=123456
<configuration> <properties resource="db.properties"></properties> <environments default="development"> <environment id="development"> <transactionManager type="JDBC"/> <dataSource type="POOLED"> <property name="driver" value="${driver}"/> <property name="url" value="${url}"/> <property name="username" value="${username}"/> <property name="password" value="${password}"/> </dataSource> </environment> </environments> </configuration>
**!注:**resource=“db.properties” 我的是因为它跟我的mybatis-config.xml文件在同一个目录下,才可以直接填文件名。不然要填好相对路径。
-
properties 元素的子元素配置法
<properties resource="db.properties">
<property name="username" value="root"/>
<property name="password" value="123456"/>
</properties>
-
如果一个属性在不只一个地方进行了配置,将按照下面的顺序来加载:
- 首先读取在 properties 元素体内指定的属性。
- 然后根据 properties 元素中的 resource 属性读取类路径下属性文件,或根据 url 属性指定的路径读取属性文件,并覆盖之前读取过的同名属性。
- 最后读取作为方法参数传递的属性,并覆盖之前读取过的同名属性。
因此,通过方法参数传递的属性具有最高优先级,resource/url 属性中指定的配置文件次之,最低优先级的则是 properties 元素中指定的属性。
3.settings(设置)
settings是 MyBatis 中极为重要的调整设置,它们会改变 MyBatis 的运行时行为。该配置比较好理解,没有什么好讲解的,主要是嘚了解和记住各项设置的含义、默认值。下面我挑几个个人觉得比较重要的设置:
设置名 | 描述 | 有效值 | 默认值 |
---|---|---|---|
cacheEnabled | 全局性地开启或关闭所有映射器配置文件中已配置的任何缓存。 | true | false | true |
lazyLoadingEnabled | 延迟加载的全局开关。 | true | false | true |
useGeneratedKeys | 允许 JDBC 支持自动生成主键,需要数据库驱动支持。如果设置为 true,将强制使用自动生成主键。 | true | false | false |
safeResultHandlerEnabled | 是否允许在嵌套语句中使用结果处理器(ResultHandler)。如果允许使用则设置为 false。 | true | false | true |
mapUnderscoreToCamelCase | 是否开启驼峰命名自动映射,即从经典数据库列名 A_COLUMN 映射到经典 Java 属性名 aColumn。 | true | false | false |
logImpl | 指定 MyBatis 所用日志的具体实现,未指定时将自动查找。 | SLF4J | LOG4J2 JDK_LOGGING | COMMONS_LOGGING |STDOUT_LOGGINGNO_LOGGING | 未设置 |
4.typeAliases(类型别名)
类型别名可为 Java 类型设置一个缩写名字。 它仅用于 XML 配置,意在降低冗余的全限定类名书写。
-
指定实体类起别名
<typeAliases> <typeAlias type="com.yg.pojo.Person" alias="Person" /> </typeAliases>
-
指定包名起别名,会使用 Bean 的首字母小写的非限定类名来作为它的别名
<typeAliases> <package name="com.yg.pojo"/> </typeAliases>
-
推荐使用原则
-
实体类比较少的时候使用指定类名方式
-
实体类比较多的时候推荐使用指定包名方式
-
指定类名方式可以自定义别名,而指定包名方式不可以(若想,则嘚在相应的实体类使用注解)
@Alias("person") public class Person { }
**!注意:**注解自定义别名需要和指定包名起别名连同使用
-
5.environments(环境配置)
MyBatis 可以配置成适应多种环境,这种机制有助于将 SQL 映射应用于多种数据库之中。例如,开发、测试和生产环境需要有不同的配置;或者想在具有相同 Schema 的多个生产数据库中使用相同的 SQL 映射。
!不过要记住:尽管可以配置多个环境,但每个 SqlSessionFactory 实例只能选择一种环境。
如:
<environments default="development"(通过这里选择要使用的环境)>
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="${driver}"/>
<property name="url" value="${url}"/>
<property name="username" value="${username}"/>
<property name="password" value="${password}"/>
</dataSource>
</environment>
<environment id="test">
<transactionManager type="JDBC"></transactionManager>
<dataSource type="POOLED">
<property name="driver" value="${driver}"/>
<property name="url" value="${url}"/>
<property name="username" value="${username2}"/>
<property name="password" value="${password2}"/>
</dataSource>
</environment>
</environments>
事务管理器(transactionManager)
MyBatis 默认的事务管理器就是JDBC,这个配置直接使用了 JDBC 的提交和回滚功能,它依赖从数据源获得的连接来管理事务作用域。如果你正在使用 Spring + MyBatis,则没有必要配置事务管理器,因为Spring 模块会使用自带的管理器来覆盖前面的配置。
数据源(dataSource)
虽然数据源配置是可选的,但如果要启用延迟加载特性,就必须配置数据源。 MyBatis 默认 使用的数据源就是 POOLED– 这种数据源的实现利用“连接池”的概念将 JDBC 连接对象组织起来,避免了创建新的连接实例时所必需的初始化和认证时间。
6.mappers(映射器)
mappers(映射器)是用来定义 SQL 映射语句的。所以首先,我们需要告诉 MyBatis 到哪里去找到这些语句。你可以使用相对于类路径的资源引用,或完全限定资源定位符(包括 file:///
形式的 URL),或类名和包名等。
例如:
- 方法一
<!-- 使用相对于类路径的资源引用(推荐使用) -->
<mappers>
<mapper resource="org/mybatis/builder/AuthorMapper.xml"/>
<mapper resource="org/mybatis/builder/BlogMapper.xml"/>
<mapper resource="org/mybatis/builder/PostMapper.xml"/>
</mappers>
- 方法二 (过时不推荐使用)
<!-- 使用完全限定资源定位符(URL) -->
<mappers>
<mapper url="file:///var/mappers/AuthorMapper.xml"/>
<mapper url="file:///var/mappers/BlogMapper.xml"/>
<mapper url="file:///var/mappers/PostMapper.xml"/>
</mappers>
- 方法三
<!-- 使用映射器接口实现类的完全限定类名 -->
<mappers>
<mapper class="org.mybatis.builder.AuthorMapper"/>
<mapper class="org.mybatis.builder.BlogMapper"/>
<mapper class="org.mybatis.builder.PostMapper"/>
</mappers>
- 方法四
<!-- 将包内的映射器接口全部注册为映射器 -->
<mappers>
<package name="org.mybatis.builder"/>
</mappers>
- **注:**方法三和方法四有着限制条件
- 接口和它的Mapper配置文件必须同名
- 接口和它的Mapper配置文件必须在同一个包下