MyBatis配置文件XML介绍（一）

蔚落 2024-02-20 12:03 12阅读 0赞

## 三、MyBatis配置文件XML介绍（一） ##

#### 文章目录 ####

*  三、MyBatis配置文件XML介绍（一）
 *   *  一、propertis属性使用
     *  二、settings全局参数设置
     *   *  参数及说明
         *  设置示例
     *  三、typeAliases类型别名

### 一、propertis属性使用 ###

此属性可以在外部进行配置，并可以进行动态替换。

设置好的属性可以在整个配置文件中用来替换需要动态配置的属性值

这个例子中的 username 和 password 将会由 properties 元素中设置的相应值来替换。 driver 和 url 属性将会由 config.properties 文件中对应的值来替换。这样就为配置提供了诸多灵活选择

属性值可以在SqlSessionFactoryBuilder.build()方法中传入属性值：

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

或者

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

如果一个属性在不只一个地方进行了配置，那么，MyBatis 将按照下面的顺序来加载：

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

因此，通过方法参数传递的属性具有**最高优先级**，resource/url 属性中指定的配置文件**次之**，**最低优先级**的则是 properties 元素中指定的属性。

在MyBatis 3.4.2 及其更高的版本中，可以使用占位符指定一个默认值

这个特性默认是关闭的。添加一个特定的属性来开启这个特性。如：

如果你在属性名中使用了 “:” 字符（如：db:username），或者在 SQL 映射中使用了 OGNL 表达式的三元运算符（如： $\{tableName != null ? tableName : ‘global\_constants’\}），就需要设置特定的属性来修改分隔属性名和默认值的字符。例如：

### 二、settings全局参数设置 ###

这是 MyBatis 中极为重要的调整设置，它们会改变 MyBatis 的运行时行为

#### 参数及说明 ####

<table> 
 <thead> 
  <tr> 
   <th>设置名</th> 
   <th>描述</th> 
   <th>有限制</th> 
   <th>默认值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>cacheEnabled</td> 
   <td>全局性地开启或关闭所有映射器配置文件中已配置的任何缓存。</td> 
   <td>true|false</td> 
   <td>true</td> 
  </tr> 
  <tr> 
   <td>lazyLoadingEnabled</td> 
   <td>延迟加载的全局开关。当开启时，所有关联对象都会延迟加载。 特定关联关系中可通过设置 <code>fetchType</code> 属性来覆盖该项的开关状态。</td> 
   <td>true|false</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>aggressiveLazyLoading</td> 
   <td>开启时，任一方法的调用都会加载该对象的所有延迟加载属性。 否则，每个延迟加载属性会按需加载（参考 <code>lazyLoadTriggerMethods</code>)。</td> 
   <td>true|false</td> 
   <td>false （在 3.4.1 及之前的版本中默认为 true）</td> 
  </tr> 
  <tr> 
   <td>multipleResultSetsEnabled</td> 
   <td>是否允许单个语句返回多结果集（需要数据库驱动支持）。</td> 
   <td>true|false</td> 
   <td>true</td> 
  </tr> 
  <tr> 
   <td>useColumnLabel</td> 
   <td>使用列标签代替列名。实际表现依赖于数据库驱动，具体可参考数据库驱动的相关文档，或通过对比测试来观察。</td> 
   <td>true|false</td> 
   <td>true</td> 
  </tr> 
  <tr> 
   <td>useGeneratedKeys</td> 
   <td>允许 JDBC 支持自动生成主键，需要数据库驱动支持。如果设置为 true，将强制使用自动生成主键。尽管一些数据库驱动不支持此特性，但仍可正常工作。</td> 
   <td>true|false</td> 
   <td>true</td> 
  </tr> 
  <tr> 
   <td>autoMappingBehavior</td> 
   <td>指定 MyBatis 应如何自动映射列到字段或属性。 NONE 表示关闭自动映射；PARTIAL 只会自动映射没有定义嵌套结果映射的字段。 FULL 会自动映射任何复杂的结果集（无论是否嵌套）。</td> 
   <td>NONE, PARTIAL, FULL</td> 
   <td>PARTIAL</td> 
  </tr> 
  <tr> 
   <td>autoMappingUnknown ColumnBehavior</td> 
   <td>指定发现自动映射目标未知列（或未知属性类型）的行为。1). NONE: 不做任何反应.2).WARNING: 输出警告日志（‘org.apache.ibatis.session.AutoMappingUnknownColumnBehavior’ 的日志等级必须设置为 WARN）3.FAILING: 映射失败 (抛出 SqlSessionException)</td> 
   <td>NONE, WARNING, FAILING</td> 
   <td>NONE</td> 
  </tr> 
  <tr> 
   <td>defaultExecutorType</td> 
   <td>配置默认的执行器。SIMPLE 就是普通的执行器；REUSE 执行器会重用预处理语句（PreparedStatement）； BATCH 执行器不仅重用语句还会执行批量更新。</td> 
   <td>SIMPLE, REUSE, BATCH</td> 
   <td>SIMPLE</td> 
  </tr> 
  <tr> 
   <td>defaultStatementTimeout</td> 
   <td>设置超时时间，它决定数据库驱动等待数据库响应的秒数。</td> 
   <td>任意正整数</td> 
   <td>未设置 (null)</td> 
  </tr> 
  <tr> 
   <td>defaultFetchSize</td> 
   <td>为驱动的结果集获取数量（fetchSize）设置一个建议值。此参数只可以在查询设置中被覆盖。</td> 
   <td>任意正整数</td> 
   <td>未设置 (null)</td> 
  </tr> 
  <tr> 
   <td>defaultResultSetType</td> 
   <td>指定语句默认的滚动策略。（新增于 3.5.2）</td> 
   <td>FORWARD_ONLY ,SCROLL_SENSITIVE , SCROLL_INSENSITIVE , DEFAULT （等同于未设置）</td> 
   <td>未设置 (null)</td> 
  </tr> 
  <tr> 
   <td>safeRowBoundsEnabled</td> 
   <td>是否允许在嵌套语句中使用分页（RowBounds）。如果允许使用则设置为 false。</td> 
   <td>true|false</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>safeResultHandlerEnabled</td> 
   <td>是否允许在嵌套语句中使用结果处理器（ResultHandler）。如果允许使用则设置为 false。</td> 
   <td>true|false</td> 
   <td>true</td> 
  </tr> 
  <tr> 
   <td>mapUnderscoreTo CamelCase</td> 
   <td>是否开启驼峰命名自动映射，即从经典数据库列名 A_COLUMN 映射到经典 Java 属性名 aColumn。</td> 
   <td>true|false</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>localCacheScope</td> 
   <td>MyBatis 利用本地缓存机制（Local Cache）防止循环引用和加速重复的嵌套查询。 默认值为 SESSION，会缓存一个会话中执行的所有查询。 若设置值为 STATEMENT，本地缓存将仅用于执行语句，对相同 SqlSession 的不同查询将不会进行缓存。</td> 
   <td>SESSION| STATEMENT</td> 
   <td>SESSION</td> 
  </tr> 
  <tr> 
   <td>jdbcTypeForNull</td> 
   <td>当没有为参数指定特定的 JDBC 类型时，空值的默认 JDBC 类型。 某些数据库驱动需要指定列的 JDBC 类型，多数情况直接用一般类型即可，比如 NULL、VARCHAR 或 OTHER。</td> 
   <td>JdbcType 常量，常用值：NULL、VARCHAR 或 OTHER。</td> 
   <td>OTHER</td> 
  </tr> 
  <tr> 
   <td>lazyLoadTriggerMethod</td> 
   <td>指定对象的哪些方法触发一次延迟加载。</td> 
   <td>用逗号分隔的方法列表。</td> 
   <td>equals, clone, hashCode, toString</td> 
  </tr> 
  <tr> 
   <td>defaultScriptingLanguage</td> 
   <td>指定动态 SQL 生成使用的默认脚本语言。</td> 
   <td>一个类型别名或全限定类名。</td> 
   <td>org. apache. ibatis. scripting. xmltags. XMLLanguageDriver</td> 
  </tr> 
  <tr> 
   <td>defaultEnumTypeHandler</td> 
   <td>指定 Enum 使用的默认 <code>TypeHandler</code></td> 
   <td>一个类型别名或全限定类名</td> 
   <td>org. apache. ibatis. type. EnumTypeHandler</td> 
  </tr> 
  <tr> 
   <td>callSettersOnNulls</td> 
   <td>指定当结果集中值为 null 的时候是否调用映射对象的 setter（map 对象时为 put）方法，这在依赖于 Map.keySet() 或 null 值进行初始化时比较有用。注意基本类型（int、boolean 等）是不能设置成 null 的。</td> 
   <td>true|false</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>returnInstanceFor EmptyRow</td> 
   <td>当返回行的所有列都是空时，MyBatis默认返回 <code>null</code>。 当开启这个设置时，MyBatis会返回一个空实例。 请注意，它也适用于嵌套的结果集（如集合或关联）。（新增于 3.4.2）</td> 
   <td>true|false</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>logPrefix</td> 
   <td>指定 MyBatis 增加到日志名称的前缀。</td> 
   <td>任何字符串</td> 
   <td>未设置</td> 
  </tr> 
  <tr> 
   <td>logImpl</td> 
   <td>指定 MyBatis 所用日志的具体实现，未指定时将自动查找。</td> 
   <td>SLF4J , LOG4J（3.5.9 起废弃） ,LOG4J2 , JDK_LOGGING , COMMONS_ LOGGING , STDOUT_LOGGING , NO_LOGGING</td> 
   <td>未设置</td> 
  </tr> 
  <tr> 
   <td>proxyFactory</td> 
   <td>指定 Mybatis 创建可延迟加载对象所用到的代理工具</td> 
   <td>CGLIB （3.5.10 起废弃） , JAVASSIST</td> 
   <td>JAVASSIST</td> 
  </tr> 
  <tr> 
   <td>vfsImpl</td> 
   <td>指定 VFS 的实现</td> 
   <td>自定义 VFS 的实现的类全限定名，以逗号分隔。</td> 
   <td>未设置</td> 
  </tr> 
  <tr> 
   <td>useActualParamName</td> 
   <td>允许使用方法签名中的名称作为语句参数名称。 为了使用该特性，你的项目必须采用 Java 8 编译，并且加上 <code>-parameters</code> 选项。（新增于 3.4.1）</td> 
   <td>true,false</td> 
   <td>true</td> 
  </tr> 
  <tr> 
   <td>configurationFactory</td> 
   <td>指定一个提供 <code>Configuration</code> 实例的类。 这个被返回的 Configuration 实例用来加载被反序列化对象的延迟加载属性值。 这个类必须包含一个签名为<code>static Configuration getConfiguration()</code> 的方法。（新增于 3.2.3）</td> 
   <td>一个类型别名或完全限定类名</td> 
   <td>未设置</td> 
  </tr> 
  <tr> 
   <td>shrinkWhitespacesInSql</td> 
   <td>从SQL中删除多余的空格字符。请注意，这也会影响SQL中的文字字符串。 (新增于 3.5.5)</td> 
   <td>true,false</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>defaultSqlProviderType</td> 
   <td>指定一个拥有 provider 方法的 sql provider 类 （新增于 3.5.6）. 这个类适用于指定 sql provider 注解上的<code>type</code>（或 <code>value</code>） 属性（当这些属性在注解中被忽略时）。 (e.g. <code>@SelectProvider</code>)</td> 
   <td>类型别名或者全限定名</td> 
   <td>未设置</td> 
  </tr> 
  <tr> 
   <td>nullableOnForEach</td> 
   <td>为 ‘foreach’ 标签的 ‘nullable’ 属性指定默认值。（新增于 3.5.9）</td> 
   <td>true ,false</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>argNameBasedConstructor AutoMapping</td> 
   <td>当应用构造器自动映射时，参数名称被用来搜索要映射的列，而不再依赖列的顺序。（新增于 3.5.10）</td> 
   <td>true,false</td> 
   <td>false</td> 
  </tr> 
 </tbody> 
</table>

#### 设置示例 ####

### 三、typeAliases类型别名 ###

类型别名可为 Java 类型设置一个缩写名字。 它仅用于 XML 配置，意在降低冗余的全限定类名书写。例如：

当这样配置时，`Blog` 可以用在任何使用 `com.goyeer.Blog` 的地方。

也可以指定一个包名，MyBatis 会在包名下面搜索需要的 Java Bean，比如：

每一个在包 `com.goyeer` 中的 Java Bean，在没有注解的情况下，会使用 Bean 的首字母小写的非限定类名来作为它的别名。 比如 `com.goyeer.Author` 的别名为 `author`；若有注解，则别名为其注解值。见下面的例子：

@Alias("author")
    public class Author {
        
        ...
    }