目录
剩余的节点我们在下一篇博文中进行分析。手写不易，看过有收获的话请点赞。
一、说明
在Mybatis源码解析SqlSessionFactory对象初始化中 主要分析了spring+mybatis 在程序启动过程中初始化生成我们操作mybatis最重要SqlSession的工厂对象（工厂对象如果创建成功，则sqlsession对象的获取也就水到渠成了），其中重点介绍了Configuration对象的初始化过程(创建SqlSessionFactory对象的配置对象)，在其Configuration对象初始化过程中设置到若干TypeAlias，properties.setting,plugins 这些节点的配置，首先解释一下为什么需要进行这些配置，读者可能会有疑惑，这些相关的配置我都没有配置过,但是依旧可以使用mybatis框架。这是因为mybatis对于这些配置提供了默认的相关设置和实现。关于mybatisp配置的详细介绍请参考：mybatis-config.xml配置详解 mybatis提供这些相关的配置，是让我们更好的扩展符合我们业务的配置，从而灵活的改变mybatis的运行方式。
在这里我们主要通过代码demo来分别验证不同子节点的使用方式，以及相关原理的描述解读。涉及到的节点比较多，这里笔者主要针对常用的 properties、settings、typeAliases、typeHandlers、objectFactory、plugins、environments、mappers进行了解。为避免篇幅过长会使用两篇博文的形式来分析。
二、properties节点
1、properties节点配置
<!-- 方法一： 从外部指定properties配置文件, 除了使用resource属性指定外，还可通过url属性指定url
<properties resource="dbConfig.properties"></properties>
-->
<properties>
<!-- 方法二： 直接配置为xml -->
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/crawlinng"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
<property name="password" value="123456"/>
<property name="cacheEnabled" value="true"/>
</properties>
在上面配置完成后，就可以针对上面的属性名称进行复用
如上所示配置了属性，则在下面如果用到上门属性的地方 都可以使用${propertiesName}的形式
这里我们设置开启了全局缓存，在上面设置了一个cacheEnabled属性值，在下面的配置中使用${cacheEnabled}
<!-- 如上所示配置了属性，则在下面如果用到上门属性的地方 都可以使用${propertiesName}的形式-->
<settings>
<!-- 这个配置使全局的映射器启用或禁用缓存 默认不开启二级缓存
只是用mybatis的一级缓存（同一个sqlsession下的多次相同的查询需要使用缓存）-->
<setting name="cacheEnabled" value="${cacheEnabled}" />
</settings>
2、配置的代码分析
2.1、解析逻辑
mybatis-config.xml支持两种方式的properties 一种是properties下的resource/url属性引用第三方的属性配置文件，一种是在properties的property属性显示指定，在解析的时候针对其两中方式分别解析，最终和configuration对象中的variables合并到一起重新赋值给configuration对象的variables属性中（我们最终也知晓了properties设置的相关属性值最终解析为configuration的variables（Property对象）属性）。
/**
* 解析configuration.xml下的properties节点
*/
private void propertiesElement(XNode context) throws Exception {
if (context != null) {
//获取<properties>下的所有<property>节点
Properties defaults = context.getChildrenAsProperties();
//获取<properties>中的resource/url属性
//（从其他的文件资源中获取相关的属性信息 且url/resource两者只能使用其一 否则保存错误）
String resource = context.getStringAttribute("resource");
String url = context.getStringAttribute("url");
if (resource != null && url != null) {
throw new BuilderException("The properties element cannot specify both a URL and a resource based property file reference. Please specify one or the other.");
}
if (resource != null) {
defaults.putAll(Resources.getResourceAsProperties(resource));
} else if (url != null) {
defaults.putAll(Resources.getUrlAsProperties(url));
}
//合并其Configuration对象中原有的属性并重新赋值给configuration对象中
Properties vars = this.configuration.getVariables();
if (vars != null) {
defaults.putAll(vars);
}
this.parser.setVariables(defaults);
this.configuration.setVariables(defaults);
}
}2.2、结果验证
通过debug断点调试发现${cacheEnabled}被退换成了真实值true
三、settings节点
setting 标签的配置是配置 MyBatis 框架运行时的一些行为的，例如缓存、延迟加载、结果集控制、执行器、分页设置、命名规则等一系列控制性参数。
1、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, 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 |
2、代码分析
/**
* 解析mybatis配置文件的setting节点
*/
private void settingsElement(XNode context) throws Exception {
if (context != null) {
//获取<settings>下的所有<setting>子节点
Properties props = context.getChildrenAsProperties();
MetaClass metaConfig = MetaClass.forClass(Configuration.class, this.localReflectorFactory);
Iterator i$ = props.keySet().iterator();
//用户设置的setting值是否在configutation对象中存在，不存在抛出异常。
while (i$.hasNext()) {
Object key = i$.next();
if (!metaConfig.hasSetter(String.valueOf(key))) {
throw new BuilderException("The setting " + key + " is not known.
Make sure you spelled it correctly (case sensitive).");
}
}
//mybatis中设置所有的setting配置，如果用户在配置文件中没有进行设置，
//则使用mybatis提供的默认值
this.configuration.setAutoMappingBehavior(
AutoMappingBehavior.valueOf(
props.getProperty("autoMappingBehavior", "PARTIAL")
)
);
......
......
.....
}
}四、typeAliases节点
1、typeAliases配置
<!-- 设置别名 则在其BookMapper.xml和MovieMapper.xml中
所有引用com.soecode.lyf.entity.Book都可以使用别名book或者movie
-->
<typeAliases>
<!-- 方式一、直接针对该对应包下的所有javaBean使用默认的设置别名方式批量设置别名-->
<!--
<package name="com.soecode.lyf.entity"/>
-->
<!-- 方式二、单独为不同的java对象设置别名 -->
<typeAlias type="com.soecode.lyf.entity.Book" alias="book"/>
<typeAlias type="com.soecode.lyf.entity.Movie" alias="movie" />
</typeAliases>2、代码分析
解析逻辑: 1、获取typeAliases下的子节点信息包含<package>子标签或者<typeAlias> 2、分别针对这两个子节点进行设置 3、遍历所有的子节点 3.1、解析package节点 3.2、解析typeAlias节点 4、如果alias不为空则将class和alias存放在Map<String,Class>中 如果alias为空则使用默认的设置别名规则（类的简单类名首字母小写）
在进行别名设置过程中需要使用到别名注册器TypeAliasRegister，它主要用于将基本类型和用户自定义的类型进行别名注册，将别名及其对应类类型保存在一个HashMap中，方便存取，是映射器映射功能实现的基础
配置typeAliases节点
private void typeAliasesElement(XNode parent) {
if (parent != null) {
//获取typeAliases下的子节点信息包含<package>子标签或者<typeAlias>
//分别针对这两个子节点进行设置
Iterator i$ = parent.getChildren().iterator();
//遍历所有的子节点
while(i$.hasNext()) {
XNode child = (XNode)i$.next();
String alias;
//解析package节点
if ("package".equals(child.getName())) {
alias = child.getStringAttribute("name");
this.configuration.getTypeAliasRegistry().registerAliases(alias);
} else { //解析typeAlias节点
//获取alias别名
alias = child.getStringAttribute("alias");
//获取type类型
String type = child.getStringAttribute("type");
//如果alias不为空则将class和alias存放在Map<String,Class>中
//如果alias为空则使用默认的设置别名规则（类的简单类名首字母小写）
try {
Class<?> clazz = Resources.classForName(type);
if (alias == null) {
this.typeAliasRegistry.registerAlias(clazz);
} else {
this.typeAliasRegistry.registerAlias(alias, clazz);
}
} catch (ClassNotFoundException var7) {
throw new BuilderException("Error registering typeAlias for '" + alias + "'. Cause: " + var7, var7);
}
}
}
}
}五、TypeHandler节点
1、typeHandlers配置
TypeHandler（类型处理器）简单点说就是用于处理javaType与jdbcType之间类型转换用的处理器，MyBatis针对诸多Java类型与数据库类型进行了匹配处理。
它主要用于映射器配置文件的工作，在通过类型别名注册器获取类型别名代表的类型之后，就可以使用获取的类型通过类型处理器注册器来得到其对应的JdbcType和对应的类型处理器。
由此可见每个类型处理器都针对两个类型，一个Java类型，一个数据库类型。而类型处理器的作用就是进行二者之间的匹配、对应、转换。
如下配置一个我们自定义的typeHandler ------MyStringTypehandler类
<!--设置typeHandler -->
<typeHandlers>
<typeHandler handler="com.soecode.lyf.mybatisConfig.MyStringTypeHandler" javaType="String"/>
</typeHandlers>MyStringTypeHandler.java
/**
* 设置自己的自定义的TypeHandler
* 完成的功能是在指定price字段上添加-typeHandler字符串（进行修改）
*/
//设置需要转换的jdbcType为varchar
@MappedJdbcTypes(JdbcType.VARCHAR)
//设置需要转换为javaType为String //可以不用设置，因为BaseTypeHandler泛型对象已经表名其javaType为String
@MappedTypes(String.class)
//这里可以实现TypeHandler接口中的方法，也可以继承BaseTypeHandler<T> 该类是实现了TypeHandler
public class MyStringTypeHandler extends BaseTypeHandler<String> {
/**
* 设置sql中parameterType中参数的类型 String 表明参数为字符串类型
*/
public void setNonNullParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType) throws SQLException {
ps.setString(i,parameter);
}
/**
* 根据列名从ResultSet中获取结果信息
* @param rs
* @param columnName
* @return
* @throws SQLException
*/
public String getNullableResult(ResultSet rs, String columnName) throws SQLException {
//获取列名中的字符（获取价格中的数字）
if(columnName.equals("price")){
String priceStr = rs.getString(columnName);
return priceStr+"-tyHandler";
}
return rs.getString(columnName);
}
public String getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
if(columnIndex==6){
String priceStr = rs.getString(columnIndex);
return priceStr+"-tyHandler";
}
return rs.getString(columnIndex);
}
public String getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
if(columnIndex==6){
String priceStr = cs.getString(columnIndex);
return priceStr+"-tyHandler";
}
return cs.getString(columnIndex);
}
}
2、代码分析
总的来说类型处理器就是两方面的作用，一方面将Java类型的参数（T prarameter）设置到数据库操作脚本中（匹配数据库类型jdbcType），另一种是获取操作结果到Java类型（T）中。
逻辑: 遍历<typeHandlers>的所有子节点，该子节点的类型有两种
一种是<package/>，批量扫描包下的所有实现Typehandler接口的使用typeHandlerRegietry（类型处理器注册器）的register 注册其实是保存在该typeHandlerRegietry类中的hashMap容器中
另一种是<typeHandler> 获取该节点的javaType，jdbcType 和handler 名称和对应的class信息进行注册
在这里都用到了typeHandlerRegietry该类实现注册，有关该类的解释参考：https://www.cnblogs.com/V1haoge/p/6709157.html
/**
* 配置TypeHandler（解析typeHandlers节点）
*/
private void typeHandlerElement(XNode parent) throws Exception {
if (parent != null) {
//遍历<typeHandlers>的所有子节点，该子节点的类型有两种
// 一种是<package/>，批量扫描包下的所有实现Typehandler接口的使用typeHandlerRegietry（类型处理器注册器）的register
// 注册其实是保存在该typeHandlerRegietry类中的hashMap容器中
//另一种是<typeHandler> 获取该节点的javaType，jdbcType 和handler 名称和对应的class信息进行注册
for (XNode child : parent.getChildren()) {
if ("package".equals(child.getName())) {
String typeHandlerPackage = child.getStringAttribute("name");
typeHandlerRegistry.register(typeHandlerPackage);
} else {
String javaTypeName = child.getStringAttribute("javaType");
String jdbcTypeName = child.getStringAttribute("jdbcType");
String handlerTypeName = child.getStringAttribute("handler");
Class<?> javaTypeClass = resolveClass(javaTypeName);
JdbcType jdbcType = resolveJdbcType(jdbcTypeName);
Class<?> typeHandlerClass = resolveClass(handlerTypeName);
if (javaTypeClass != null) {
if (jdbcType == null) {
typeHandlerRegistry.register(javaTypeClass, typeHandlerClass);
} else {
typeHandlerRegistry.register(javaTypeClass, jdbcType, typeHandlerClass);
}
} else {
typeHandlerRegistry.register(typeHandlerClass);
}
}
}
}代码验证
5万+
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
