MyBatis全局配置文件的使用

偏执的太偏执、 2021-12-15 09:41 269阅读 0赞

# 0.前言 #

MyBatis涉及两个xml文件，一个是全局配置文件，另一个是映射文件。在官方文档中也有详细的解释：[MyBatis全局配置文件的官方文档][MyBatis]。通过看文档和写代码来学习全局配置文件的使用，全局配置文件的配置主要有以下：  
![配置][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FzY18xMjM0NTY_size_16_color_FFFFFF_t_70]

# 1.properties(属性) #

这个标签的作用是可以使用外部的properties文件，获取这他的子标签的配置，来对相应属性的赋值，通过OGNL表达式：$\{…\}来获取。下面的图中，第一个红框是通过属性文件的方式配置，第二个红框是通过子标签的方式。加载顺序是先加载子标签，在加载属性文件，相同名将会被覆盖。  
![在这里插入图片描述][20190705003541190.png]

# 2.setting(设置) #

从官方文档来看，setting中主要有这些

<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>延迟加载的全局开关。当开启时，所有关联对象都会延迟加载。 特定关联关系中可通过设置 fetchType 属性来覆盖该项的开关状态。</td> 
   <td>true|false</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>aggressiveLazyLoading</td> 
   <td>当开启时，任何方法的调用都会加载该对象的所有属性。 否则，每个属性会按需加载（参考 lazyLoadTriggerMethods)。</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 则这个设置强制使用自动生成主键，尽管一些驱动不能支持但仍可正常工作（比如 Derby）。</td> 
   <td>true|false</td> 
   <td>False</td> 
  </tr> 
  <tr> 
   <td>autoMappingBehavior</td> 
   <td>指定 MyBatis 应如何自动映射列到字段或属性。 NONE 表示取消自动映射；PARTIAL 只会自动映射没有定义嵌套结果集映射的结果集。 FULL 会自动映射任意复杂的结果集（无论是否嵌套）。</td> 
   <td>NONE,PARTIAL,FULL</td> 
   <td>PARTIAL</td> 
  </tr> 
  <tr> 
   <td>autoMappingUnknownColumnBehavior</td> 
   <td>指定发现自动映射目标未知列（或者未知属性类型）的行为。NONE: 不做任何反应 *WARNING :输出提醒日志 (‘org.apache.ibatis.session.AutoMappingUnknownColumnBehavior’ 的日志等级必须设置为 WARN) FAILING: 映射失败 (抛出 SqlSessionException)</td> 
   <td>NONE, WARNING, FAILING</td> 
   <td>NONE</td> 
  </tr> 
  <tr> 
   <td>autoMappingBehavior</td> 
   <td>指定 MyBatis 应如何自动映射列到字段或属性。 NONE 表示取消自动映射；PARTIAL 只会自动映射没有定义嵌套结果集映射的结果集。 FULL 会自动映射任意复杂的结果集（无论是否嵌套）。</td> 
   <td>NONE,PARTIAL,FULL</td> 
   <td>PARTIAL</td> 
  </tr> 
  <tr> 
   <td>autoMappingUnknownColumnBehavior</td> 
   <td>指定发现自动映射目标未知列（或者未知属性类型）的行为。NONE: 不做任何反应* WARNING:输出提醒日志 (‘org.apache.ibatis.session.AutoMappingUnknownColumnBehavior’ 的日志等级必须设置为 WARN)* FAILING:映射失败 (抛出 SqlSessionException)</td> 
   <td>NONE, WARNING, FAILING</td> 
   <td>NONE</td> 
  </tr> 
  <tr> 
   <td>defaultExecutorType</td> 
   <td>配置默认的执行器。SIMPLE 就是普通的执行器；REUSE 执行器会重用预处理语句（prepared statements）； 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>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>mapUnderscoreToCamelCase</td> 
   <td>是否开启自动驼峰命名规则（camel case）映射，即从经典数据库列名 A_COLUMN 到经典 Java 属性名 aColumn 的类似映射。</td> 
   <td>true|false</td> 
   <td>False</td> 
  </tr> 
  <tr> 
   <td>localCacheScope</td> 
   <td>MyBatis 利用本地缓存机制（Local Cache）防止循环引用（circular references）和加速重复嵌套查询。 默认值为 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>lazyLoadTriggerMethods</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 使用的默认 TypeHandler 。（新增于 3.4.5）</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>returnInstanceForEmptyRow</td> 
   <td>当返回行的所有列都是空时，MyBatis默认返回 null。 当开启这个设置时，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|LOG4J2|JDK_LOGGING|COMMONS_LOGGING|STDOUT_LOGGING|NO_LOGGING</td> 
   <td>未设置</td> 
  </tr> 
  <tr> 
   <td>proxyFactory</td> 
   <td>指定 Mybatis 创建具有延迟加载能力的对象所用到的代理工具。</td> 
   <td>CGLIB|JAVASSIST</td> 
   <td>JAVASSIST （MyBatis 3.3 以上）</td> 
  </tr> 
  <tr> 
   <td>vfsImpl</td> 
   <td>指定 VFS 的实现</td> 
   <td>自定义 VFS 的实现的类全限定名，以逗号分隔。</td> 
   <td>未设置</td> 
  </tr> 
  <tr> 
   <td>useActualParamName</td> 
   <td>允许使用方法签名中的名称作为语句参数名称。 为了使用该特性，你的项目必须采用 Java 8 编译，并且加上 -parameters 选项。（新增于 3.4.1）</td> 
   <td>true|false</td> 
   <td>true</td> 
  </tr> 
  <tr> 
   <td>configurationFactory</td> 
   <td>指定一个提供 Configuration 实例的类。 这个被返回的 Configuration 实例用来加载被反序列化对象的延迟加载属性值。 这个类必须包含一个签名为static Configuration getConfiguration() 的方法。（新增于 3.2.3）</td> 
   <td>类型别名或者全类名.</td> 
   <td>未设置</td> 
  </tr> 
 </tbody> 
</table>

# 3.类型别名（typeAliases） #

类型别名是为 Java 类型设置一个短的名字。 它只和 XML 配置有关，存在的意义仅在于用来减少类完全限定名的冗余。例如：

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

# 4.类型处理器（typeHandlers） #

主要用于java的数据类型与JDBC数据类型的转换。比如java中的String和数据库中的char类型

<table> 
 <thead> 
  <tr> 
   <th>类型处理器</th> 
   <th>Java 类型</th> 
   <th>JDBC 类型</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>BooleanTypeHandler</td> 
   <td>java.lang.Boolean, boolean</td> 
   <td>数据库兼容的 BOOLEAN</td> 
  </tr> 
  <tr> 
   <td>LongTypeHandler</td> 
   <td>java.lang.Long, long</td> 
   <td>数据库兼容的 NUMERIC 或 BIGINT</td> 
  </tr> 
 </tbody> 
</table>

# 5.插件（plugins） #

MyBatis 允许你在已映射语句执行过程中的某一点进行拦截调用。默认情况下，MyBatis 允许使用插件来拦截的方法调用包括：

*  Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
 *  ParameterHandler (getParameterObject, setParameters)
 *  ResultSetHandler (handleResultSets, handleOutputParameters)
 *  StatementHandler (prepare, parameterize, batch, update, query)

这些类中方法的细节可以通过查看每个方法的签名来发现，或者直接查看 MyBatis 发行包中的源代码。 如果你想做的不仅仅是监控方法的调用，那么你最好相当了解要重写的方法的行为。 因为如果在试图修改或重写已有方法的行为的时候，你很可能在破坏 MyBatis 的核心模块。 这些都是更低层的类和方法，所以使用插件的时候要特别当心。

# 6.环境配置（environments） #

MyBatis可以配置多个环境。开发、测试等使用不同的数据库，可以通过environments标签配置不同的环境。

这里配置了两个环境， < environment id=“test” >和< environment id=“development” >是环境配置的唯一标识。通过< environments default=“development” >中的default来选择默认使用什么。**事务管理器（transactionManager）**：有两个值JDBC和MANAGED。事务管理器一般交给spring来做。**数据源（dataSource）**：共有UNPOOLED（不使用连接池）、POOLED（使用连接池）、JNDI 。也可以自定义。

# 7.数据库厂商标识（databaseIdProvider） #

MyBatis 可以根据不同的数据库厂商执行不同的语句，这种多厂商的支持是基于映射语句中的 databaseId 属性。

前面的name是数据库厂商的标识，通过value来为他们取一个别名。那么怎么来使用呢，我们在编写映射文件的时候使用databaseID来指定使用什么数据库厂商。  
![在这里插入图片描述][20190705144656978.png]

# 8.映射器（mappers） #

将映射文件注册到全局配置文件中：

还可以通过url的方式来配置网络文件。  
此外，通过mapper的class属性配置接口的全类名也可以但是，同样需要映射文件，而且映射文件和接口文件的名要相同，并且在同一个包下。另外一种不需要映射文件的方式，就是直接在接口方法中添加写sql语句的注解。

另外需要注意的是这些标签的配置都是有顺序的。

# 9.结束语 #

全局配置文件在官方文档中有详细的使用说明：[http://www.mybatis.org/mybatis-3/zh/configuration.html][MyBatis]  
里面也有中文版。  
不对之处，请多指教！

[MyBatis]: http://www.mybatis.org/mybatis-3/zh/configuration.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FzY18xMjM0NTY_size_16_color_FFFFFF_t_70]: /images/20211214/afde55ef01d64321b09f61851f1065df.png
[20190705003541190.png]: /images/20211214/d26abdfad5c64584af43edf15a0f812c.png
[20190705144656978.png]: /images/20211214/c7a930cf7b2b4d2096f90c77113b2f25.png