扫码一下
查看教程更方便
这是 mybatis 中极为重要的调整设置,它们会改变 mybatis 的运行时行为。 下表描述了设置中各项设置的含义、默认值等。
设置名 | 描述 | 有效值 | 默认值 |
---|---|---|---|
cacheenabled | 全局性地开启或关闭所有映射器配置文件中已配置的任何缓存。 | true | false | true |
lazyloadingenabled | 延迟加载的全局开关。当开启时,所有关联对象都会延迟加载。 特定关联关系中可通过设置 fetchtype 属性来覆盖该项的开关状态。 | true | false | false |
aggressivelazyloading | 开启时,任一方法的调用都会加载该对象的所有延迟加载属性。 否则,每个延迟加载属性会按需加载(参考 lazyloadtriggermethods)。 | true | false | false (在 3.4.1 及之前的版本中默认为 true) |
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 执行器会重用预处理语句(preparedstatement); batch 执行器不仅重用语句还会执行批量更新。 | simple reuse batch | simple |
defaultstatementtimeout | 设置超时时间,它决定数据库驱动等待数据库响应的秒数。 | 任意正整数 | 未设置 (null) |
defaultfetchsize | 为驱动的结果集获取数量(fetchsize)设置一个建议值。此参数只可以在查询设置中被覆盖。 | 任意正整数 | 未设置 (null) |
defaultresultsettype | 指定语句默认的滚动策略。(新增于 3.5.2) | forward_only | scroll_sensitive | scroll_insensitive |default(等同于未设置) | 未设置 (null) |
saferowboundsenabled | 是否允许在嵌套语句中使用分页(rowbounds)。如果允许使用则设置为 false。 | true| false | false |
saferesulthandlerenabled | 是否允许在嵌套语句中使用结果处理器(resulthandler)。如果允许使用则设置为 false。 | true |false | true |
mapunderscoretocamelcase | 是否开启驼峰命名自动映射,即从经典数据库列名 a_column 映射到经典 java 属性名 acolumn。 | true | false | false |
localcachescope | mybatis 利用本地缓存机制(local cache)防止循环引用和加速重复的嵌套查询。 默认值为 session,会缓存一个会话中执行的所有查询。 若设置值为 statement,本地缓存将仅用于执行语句,对相同 sqlsession 的不同查询将不会进行缓存。 | session | statement | session |
jdbctypefornull | 当没有为参数指定特定的 jdbc 类型时,空值的默认 jdbc 类型。 某些数据库驱动需要指定列的 jdbc 类型,多数情况直接用一般类型即可,比如 null、varchar 或 other。 | jdbctype 常量,常用值:null、varchar 或 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会返回一个空实例。 请注意,它也适用于嵌套的结果集(如集合或关联)。(新增于 3.4.2) | true | false | false |
logprefix | 指定 mybatis 增加到日志名称的前缀。 | 任何字符串 | 未设置 |
logimpl | 指定 mybatis 所用日志的具体实现,未指定时将自动查找。 | slf4j | log4j(deprecated since 3.5.9) | log4j2 | jdk_logging | commons_logging | stdout_logging | no_logging | 未设置 |
proxyfactory | 指定 mybatis 创建可延迟加载对象所用到的代理工具。 | cglib | javassist | javassist (mybatis 3.3 以上) |
vfsimpl | 指定 vfs 的实现 | 自定义 vfs 的实现的类全限定名,以逗号分隔。 | 未设置 |
useactualparamname | 允许使用方法签名中的名称作为语句参数名称。 为了使用该特性,你的项目必须采用 java 8 编译,并且加上 -parameters 选项。(新增于 3.4.1) | true | false | true |
configurationfactory | 指定一个提供 configuration 实例的类。 这个被返回的 configuration 实例用来加载被反序列化对象的延迟加载属性值。 这个类必须包含一个签名为static configuration getconfiguration() 的方法。(新增于 3.2.3) | 一个类型别名或完全限定类名。 | 未设置 |
shrinkwhitespacesinsql | 从sql中删除多余的空格字符。请注意,这也会影响sql中的文字字符串。 (新增于 3.5.5) | true | false | false |
defaultsqlprovidertype | 指定一个包含提供程序方法的 sql 提供程序类(自 3.5.6 起)。 当省略这些属性时,此类适用于 sql 提供程序注释(例如 @selectprovider)上的类型(或值)属性。 | 类型别名或完全限定的类名 | not set |
nullableonforeach | 指定 'foreach' 标记上的 'nullable' 属性的默认值。 (自 3.5.9 起) | true | false | false |
一个配置完整的 settings 元素的示例如下: