MyBatis settings

秒速五厘米 2024-03-23 23:04 23阅读 0赞

在 MyBatis 中 settings 是最复杂的配置，它能深刻影响 MyBatis 底层的运行，但是在大部分情况下使用默认值便可以运行，所以在大部分情况下不需要大量配置它，只需要修改一些常用的规则即可，比如自动映射、驼峰命名映射、级联规则、是否启动缓存、执行器（Executor）类型等。settings 配置项说明，如表 1 所示。

<table> 表 1 settings 配置项说明 
 <tbody> 
 <tr> 
 <th>配置项</th> 
 <th>作用</th> 
 <th>配置选项</th> 
 <th>默认值</th> 
 </tr> 
 <tr> 
 <td>cacheEnabled</td> 
 <td>该配置影响所有映射器中配置缓存的全局开关</td> 
 <td>true|false</td> 
 <td>true</td> 
 </tr> 
 <tr> 
 <td>lazyLoadingEnabled</td> 
 <td>延迟加载的全局开关。当开启时，所有关联对象都会延迟加载。在特定关联关系中可通过设置 fetchType 属性来覆盖该项的开关状态&nbsp;</td> 
 <td>true|false</td> 
 <td>false</td> 
 </tr> 
 <tr> 
 <td>aggressiveLazyLoading</td> 
 <td>当启用时，对任意延迟属性的调用会使带有延迟加载属性的对象完整加载；反之，每种属性将会按需加载</td> 
 <td>true|felse</td> 
 <td>版本3.4.1 （不包含） 之前 true，之后 false</td> 
 </tr> 
 <tr> 
 <td>multipleResultSetsEnabled&nbsp;</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>autoMappingUnkno wnColumnBehavior</td> 
 <td>指定自动映射当中未知列（或未知属性类型）时的行为。 默认是不处理，只有当日志级别达到 WARN 级别或者以下，才会显示相关日志，如果处理失败会抛出 SqlSessionException 异常</td> 
 <td>NONE、WARNING、FAILING</td> 
 <td>NONE</td> 
 </tr> 
 <tr> 
 <td>defaultExecutorType</td> 
 <td>配置默认的执行器。SIMPLE 是普通的执行器；REUSE 会重用预处理语句（prepared statements）；BATCH 执行器将重用语句并执行批量更新&nbsp;</td> 
 <td>SIMPLE、REUSE、BATCH</td> 
 <td>SIMPLE</td> 
 </tr> 
 <tr> 
 <td>defaultStatementTimeout</td> 
 <td>设置超时时间，它决定驱动等待数据库响应的秒数</td> 
 <td>任何正整数</td> 
 <td>Not Set (null)</td> 
 </tr> 
 <tr> 
 <td>defaultFetchSize</td> 
 <td>设置数据库驱动程序默认返回的条数限制，此参数可以重新设置</td> 
 <td>任何正整数&nbsp;&nbsp;</td> 
 <td>Not Set (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>是否开启自动驼峰命名规则映射，即从经典数据库列名 A_COLUMN 到经典&nbsp;<a href="http://www.voidme.com/java" title="Java" rel="nofollow">Java</a>&nbsp;属性名 aColumn 的类似映射</td> 
 <td>true|false</td> 
 <td>false</td> 
 </tr> 
 <tr> 
 <td> localCacheScope </td> 
 <td>MyBatis 利用本地缓存机制（Local Cache）防止循环引用（circular references）和加速联复嵌套査询。 默认值为 SESSION，这种情况下会缓存一个会话中执行的所有查询。若设置值为 STATEMENT，本地会话仅用在语句执行上，对相同 SqlScssion 的不同调用将不会共享数据&nbsp;&nbsp;</td> 
 <td>SESSION|STATEMENT</td> 
 <td>SESSION</td> 
 </tr> 
 <tr> 
 <td> jdbcTypeForNull </td> 
 <td>当没有为参数提供特定的 JDBC 类型时，为空值指定 JDBC 类型。某些驱动需要指定列的 JDBC 类型，多数情况直接用一般类型即可，比如 NULL、VARCHAR 或 OTHER</td> 
 <td>NULL、VARCHAR、OTHER&nbsp;&nbsp;</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 .script.ing.xmltags .XMLDynamicLanguageDriver</td> 
 </tr> 
 <tr> 
 <td> callSettersOnNulls </td> 
 <td>指定当结果集中值为 null 时，是否调用映射对象的 setter（map 对象时为 put）方法，这对于 Map.kcySet() 依赖或 null 值初始化时是有用的。注意，基本类型（int、boolean 等）不能设置成 null</td> 
 <td>true|false</td> 
 <td>false</td> 
 </tr> 
 <tr> 
 <td> logPrefix </td> 
 <td>指定 MyBatis 增加到日志名称的前缀&nbsp;</td> 
 <td>任何字符串</td> 
 <td>Not set</td> 
 </tr> 
 <tr> 
 <td> loglmpl </td> 
 <td>指定 MyBatis 所用日志的具体实现，未指定时将自动査找</td> 
 <td>SLF4J|LOG4J|LOG4J2|JDK_LOGGING |COMMONS_LOGGING |ST DOUT_LOGGING|NO_LOGGING</td> 
 <td>Not set</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 的实现类&nbsp;&nbsp;</td> 
 <td>提供 VFS 类的全限定名，如果存在多个，可以使用逗号分隔&nbsp;</td> 
 <td>Not set</td> 
 </tr> 
 <tr> 
 <td>useActualParamName</td> 
 <td>允许用方法参数中声明的实际名称引用参数。要使用此功能，项目必须被编译为 Java 8 参数的选择。（从版本 3.4.1 开始可以使用）</td> 
 <td>true|false</td> 
 <td>true</td> 
 </tr> 
 </tbody> 
</table>

settings 的配置项很多，但是真正用到的不会太多，我们把常用的配置项研究清楚就可以了，比如关于缓存的 cacheEnabled，关于级联的 lazyLoadingEnabled 和 aggressiveLazy Loading，关于自动映射的 autoMappingBehavior 和 mapUnderscoreToCamelCase，关于执行器类型的 defaultExecutorType 等。  
  
这里给出一个全量的配置样例，如下所示。

> <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>