MyBatis框架浅析之 XML配置文件

一.XML配置的顶级目录:

configuration 配置

properties 属性
settings 设置
typeAliases 类型别名
typeHandlers 类型处理器
objectFactory 对象工厂
plugins 插件
environments 环境
- environment 环境变量
  - transactionManager 事务管理器
  - dataSource 数据源
databaseIdProvider 数据库厂商标识
mappers 映射器

注意: configuration 节点下,所有的元素节点,必须按照上述规定的顺序自上而下定义 ,不可更改顺序

1.properties 属性

作用: 可以从配置文件读取属性键值对或者在properties节点内自定义属性键值对, 便于 xml配置文件中,可以通过${key}的形式获取属性值

形式一:从属性配置文件中读取 key value

<!--属性配置文件-->
<properties resource="jdbc.properties"/>

附上 jdbc.properties 配置文件详情:

#key=value 形式配置必须的参数
#建议每一个属性值后 不要留有空格
jdbc.driverClassName=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://127.0.0.1:3306/crm?serverTimezone=GMT%2B8
jdbc.username=root
jdbc.password=

形式二:properties 子元素定义

<properties>
        <property name="jdbc.driverClassName" value="com.mysql.jdbc.Driver"/>
        <property name="jdbc.url" value="jdbc:mysql://127.0.0.1:3306/crm?serverTimezone=GMT%2B8"/>
        <property name="jdbc.username" value="root"/>
        <property name="jdbc.password" value=""/>
</properties>

配置文件中在properties 元素后的任意处获取属性值的方式:

<environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/> <!--事务管理类型-->
            <dataSource type="POOLED">
                <property name="driver" value="${jdbc.driverClassName}"/>
                <property name="url" value="${jdbc.url}"/>
                <property name="username" value="${jdbc.username}"/>
                <property name="password" value="${jdbc.password}"/>
            </dataSource>
        </environment>
 </environments>

对于设计数据库的一些参数,通常写进jdbc.properties配置文件中, 因此推荐通过形式一的方式获取属性值

属性也可以通过参数的形式传递到 SqlSessionFactoryBuilder.build()方法中,官方给出的案例如下:

SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, props);

// ... or ...

SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment, props);

对于Properties的更进一步介绍,本文不做介绍 , 请参照:https://www.cnblogs.com/bakari/p/3562244.html

那么此时就会有一个疑问,如果传递属性值的三种方式同时使用,那么最终以哪个为准呢或者是哪个优先级最高呢?

首先先了解MyBatis的加载顺序:

在 properties 元素体内指定的属性首先被读取。
然后根据 properties 元素中的 resource 属性读取类路径下属性文件或根据 url 属性指定的路径读取属性文件，并覆盖已读取的同名属性。
最后读取作为方法参数传递的属性，并覆盖已读取的同名属性。

由于前者会被后者所覆盖

所以答案是: 方法传参 > resource读取属性配置文件 > properties 子节点自定义属性值

如果配置文件中没有定义相关的属性的key与value,则在MyBatis 3.4.2之后,通过${key}占位符的形式取值时可以指定默认值的方式

例如:${key:defaultValue} 如果通过占位符取的这个值,未被定义或提供,那么将会使用冒号后的默认值:defaultValue

使用这种方式前,需要开启一个配置,这种方式才会生效,开启方式如下:

<properties resource="jdbc.properties">
        <!-- Enable this feature -->
        <property name="org.apache.ibatis.parsing.PropertyParser.enable-default-value" value="true"/>
</properties>

具体配置实例如下:

<dataSource type="POOLED">
  <!-- ... -->
  <property name="username" value="${username:ut_user}"/> <!-- If 'username' property not present, username become 'ut_user' -->
</dataSource>

额外的,如果你不想使用默认的冒号作为分隔符, MyBatis也支持你配置其它自定义的符号,配置方式如下:

<properties resource="jdbc.properties">
        <!-- Enable this feature -->
        <property name="org.apache.ibatis.parsing.PropertyParser.enable-default-value" value="true"/>
        <!-- Change default value of separator -->
        <property name="org.apache.ibatis.parsing.PropertyParser.default-value-separator" value="?"/> 
</properties>

此时,使用方式为:

<dataSource type="POOLED">
                <property name="driver" value="${jdbc.driverClassName}"/>
                <property name="url" value="${jdbc.url}"/>
                <property name="username" value="${jdbc.username?root}"/>
                <property name="password" value="${jdbc.password}"/>
</dataSource>

2.settings 设置

这是 MyBatis 中极为重要的调整设置，它们会改变 MyBatis 的运行时行为。完整的setting元素实例如下:

<settings>
  <setting name="cacheEnabled" value="true"/>
  <setting name="lazyLoadingEnabled" value="true"/>
  <setting name="multipleResultSetsEnabled" value="true"/>
  <setting name="useColumnLabel" value="true"/>
  <setting name="useGeneratedKeys" value="false"/>
  <setting name="autoMappingBehavior" value="PARTIAL"/>
  <setting name="autoMappingUnknownColumnBehavior" value="WARNING"/>
  <setting name="defaultExecutorType" value="SIMPLE"/>
  <setting name="defaultStatementTimeout" value="25"/>
  <setting name="defaultFetchSize" value="100"/>
  <setting name="safeRowBoundsEnabled" value="false"/>
  <setting name="mapUnderscoreToCamelCase" value="false"/>
  <setting name="localCacheScope" value="SESSION"/>
  <setting name="jdbcTypeForNull" value="OTHER"/>
  <setting name="lazyLoadTriggerMethods" value="equals,clone,hashCode,toString"/>
</settings>

下表描述了设置中各个参数的作用、默认值等

设置参数	描述	有效值	默认值
cacheEnabled	全局地开启或关闭配置文件中的所有映射器已经配置的任何缓存。	true \| false	true
lazyLoadingEnabled	延迟加载的全局开关。当开启时，所有关联对象都会延迟加载。特定关联关系中可通过设置`fetchType`属性来覆盖该项的开关状态。	true \| false	false
aggressiveLazyLoading	当开启时，任何方法的调用都会加载该对象的所有属性。否则，每个属性会按需加载（参考`lazyLoadTriggerMethods`).	true \| false	false (true in ≤3.4.1)
multipleResultSetsEnabled	是否允许单一语句返回多结果集（需要兼容驱动）。	true \| false	true
useColumnLabel	使用列标签代替列名。不同的驱动在这方面会有不同的表现，具体可参考相关驱动文档或通过测试这两种不同的模式来观察所用驱动的结果。	true \| false	true
useGeneratedKeys	允许 JDBC 支持自动生成主键，需要驱动兼容。如果设置为 true 则这个设置强制使用自动生成主键，尽管一些驱动不能兼容但仍可正常工作（比如 Derby）。	true \| false	False
autoMappingBehavior	指定 MyBatis 应如何自动映射列到字段或属性。 NONE 表示取消自动映射；PARTIAL 只会自动映射没有定义嵌套结果集映射的结果集。 FULL 会自动映射任意复杂的结果集（无论是否嵌套）。	NONE, PARTIAL, FULL	PARTIAL
autoMappingUnknownColumnBehavior	指定发现自动映射目标未知列（或者未知属性类型）的行为。 `NONE`: 不做任何反应 `WARNING`: 输出提醒日志 (`'org.apache.ibatis.session.AutoMappingUnknownColumnBehavior'`的日志等级必须设置为 `WARN`) `FAILING`: 映射失败 (抛出 `SqlSessionException`)	NONE, WARNING, FAILING	NONE
defaultExecutorType	配置默认的执行器。SIMPLE 就是普通的执行器；REUSE 执行器会重用预处理语句（prepared statements）； BATCH 执行器将重用语句并执行批量更新。	SIMPLE REUSE BATCH	SIMPLE
defaultStatementTimeout	设置超时时间，它决定驱动等待数据库响应的秒数。	任意正整数	Not Set (null)
defaultFetchSize	为驱动的结果集获取数量（fetchSize）设置一个提示值。此参数只可以在查询设置中被覆盖。	任意正整数	Not Set (null)
safeRowBoundsEnabled	允许在嵌套语句中使用分页（RowBounds）。如果允许使用则设置为false。	true \| false	False
safeResultHandlerEnabled	允许在嵌套语句中使用分页（ResultHandler）。如果允许使用则设置为false。	true \| false	True
mapUnderscoreToCamelCase	是否开启自动驼峰命名规则（camel case）映射，即从经典数据库列名 A_COLUMN 到经典 Java 属性名 aColumn 的类似映射。	true \| false	False
localCacheScope	MyBatis 利用本地缓存机制（Local Cache）防止循环引用（circular references）和加速重复嵌套查询。默认值为 SESSION，这种情况下会缓存一个会话中执行的所有查询。若设置值为 STATEMENT，本地会话仅用在语句执行上，对相同 SqlSession 的不同调用将不会共享数据。	SESSION \| STATEMENT	SESSION
jdbcTypeForNull	当没有为参数提供特定的 JDBC 类型时，为空值指定 JDBC 类型。某些驱动需要指定列的 JDBC 类型，多数情况直接用一般类型即可，比如 NULL、VARCHAR 或 OTHER。	JdbcType 常量. 大多都为: NULL, VARCHAR and OTHER	OTHER
lazyLoadTriggerMethods	指定哪个对象的方法触发一次延迟加载。	用逗号分隔的方法列表。	equals,clone,hashCode,toString
defaultScriptingLanguage	指定动态 SQL 生成的默认语言。	一个类型别名或完全限定类名。	org.apache.ibatis.scripting.xmltags.XMLLanguageDriver
defaultEnumTypeHandler	指定 Enum 使用的默认 `TypeHandler` 。 (从3.4.5开始)	一个类型别名或完全限定类名。	org.apache.ibatis.type.EnumTypeHandler
callSettersOnNulls	指定当结果集中值为 null 的时候是否调用映射对象的 setter（map 对象时为 put）方法，这对于有 Map.keySet() 依赖或 null 值初始化的时候是有用的。注意基本类型（int、boolean等）是不能设置成 null 的。	true \| false	false
returnInstanceForEmptyRow	当返回行的所有列都是空时，MyBatis默认返回`null`。当开启这个设置时，MyBatis会返回一个空实例。请注意，它也适用于嵌套的结果集 (i.e. collectioin and association)。（从3.4.2开始）	true \| false	false
logPrefix	指定 MyBatis 增加到日志名称的前缀。	任何字符串	Not set
logImpl	指定 MyBatis 所用日志的具体实现，未指定时将自动查找。	SLF4J \| LOG4J \| LOG4J2 \| JDK_LOGGING \| COMMONS_LOGGING \| STDOUT_LOGGING \| NO_LOGGING	Not set
proxyFactory	指定 Mybatis 创建具有延迟加载能力的对象所用到的代理工具。	CGLIB \| JAVASSIST	JAVASSIST (MyBatis 3.3 or above)
vfsImpl	指定VFS的实现	自定义VFS的实现的类全限定名，以逗号分隔。	Not set
useActualParamName	允许使用方法签名中的名称作为语句参数名称。为了使用该特性，你的工程必须采用Java 8编译，并且加上`-parameters`选项。（从3.4.1开始）	true \| false	true
configurationFactory	指定一个提供`Configuration`实例的类。这个被返回的Configuration实例用来加载被反序列化对象的懒加载属性值。这个类必须包含一个签名方法`static Configuration getConfiguration()`. (从 3.2.3 版本开始)	类型别名或者全类名.	Not set

3.typeAliases 类型别名

上篇文章中已经介绍 typeAliases 的作用, 他的主要作用是为全限定名起一个简短的名字 ,这样在Mapper.xml文件中, 就可以使用别名代替全限定名:

<!--为类的权限定名称设置简短的别名-->
    <typeAliases>
        <typeAlias type="com.baoxian.domain.UserInfo" alias="UserInfo"/>
    </typeAliases>

使用时:

<!--
    正常情况下 type 需要写上实体类的全限定名称，但是由于在 mybatis的配置文件中，即 mybatis_config.xml中指定了别名，所以可以使用别名的方式
    <resultMap id="BaseResultMap" type="com.baoxian.domain.UserInfo" >
    -->
  <resultMap id="BaseResultMap" type="UserInfo" >
    <id column="id" property="id"  />
    <result column="username" property="userName"  />
    <result column="age" property="age"  />
  </resultMap>

如果在 domain包下有非常多的类都需要使用别名, 那么一一配置, 就显得过于繁琐 ,此时需要提供需要被检索的包名,MyBatis就会扫描这个包下所有的类,并为他们设置别名:

<typeAliases>
  <package name="domain.blog"/>
</typeAliases>

MyBatis 设置别名的默认规则为:会使用 Bean 的首字母小写的非限定类名来作为它的别名。比如 domain.blog.Author 的别名为 author

如果希望自定义别名,则只需要在对应的Java Bean上添加@Alias(aliasName) 注解,如下:

@Alias("UserInfo")
public class UserInfo {
    
}

另外.别名是不区分大小写的,比如设置的别名为UserInfo ,那么在Mapper.xml文件中指定别名,可以写成UserInfo ,也可以写成 userinfo

但是建议保持一致

MyBatis框架浅析之 XML配置文件

猜你喜欢