mybatis常用的配置内容有哪些（一文带你掌握mybatis的所有全局配置）

可以在全局配置文件中配置properties标签来进行外部配置，我来为大家科普一下关于mybatis常用的配置内容有哪些?下面希望有你要的答案，我们一起来看看吧!

mybatis常用的配置内容有哪些

mybatis全局配置文件配置properties

可以在全局配置文件中配置properties标签来进行外部配置

设置属性的方式有三种

在properties的属性节点resource或url所指定的资源文件中配置

在properties的子节点property中配置

在构建SqlSessionFactory时通过方法传入参数

外部配置文件引入

jdbc.driver=com.mysql.jdbc.Driver jdbc.url=jdbc:mysql://localhost:3306/test jdbc.username=root jdbc.password=123456

<!-- 使用 properties来引入外部配置文件内容--> <!-- resource 引入类路径下的资源 url 引入网路或磁盘路径下的资源 --> <properties resource="jdbc.properties"> </properties> <!-- 数据库配置 --> <environments default="development"> <environment id="development"> <transactionManager type="JDBC"/> <dataSource type="POOLED"> <property name="driver" value="${jdbc.driver}"/> <property name="url" value="${jdbc.url}"/> <property name="username" value="${jdbc.username}"/> <property name="password" value="${jdbc.password}"/> </dataSource> </environment> </environments>

property子节点配置

<!-- 也可以使用property子节点来进行配置 --> <properties resource="jdbc.properties"> <property name="jdbc.password" value="123456"/> <!-- 启用默认值特性 --> <property name="org.apache.ibatis.parsing.PropertyParser.enable-default-value" value="true"/> <!-- 修改默认值的分隔符 --> <property name="org.apache.ibatis.parsing.PropertyParser.default-value-separator" value="?:"/> </properties> <!-- 数据库配置 --> <environments default="development"> <environment id="development"> <transactionManager type="JDBC"/> <dataSource type="POOLED"> <property name="driver" value="${jdbc.driver}"/> <property name="url" value="${jdbc.url}"/> <property name="username" value="${jdbc.username}"/> <!-- 可以使用:来为占位符设置默认值，如果没有读取到该属性的值，会使用该默认值 该特性默认关闭，需要配置 <property name="org.apache.ibatis.parsing.PropertyParser.enable-default-value" value="true"/> 如果开启该特性，默认使用:分隔 可以使用 <property name="org.apache.ibatis.parsing.PropertyParser.default-value-separator" value="?:"/> 来修改默认分隔符 --> <property name="password" value="${jdbc.password?:123456}"/> </dataSource> </environment> </environments>

实例化时方法传参

public static SqlSessionFactory createFactory(){ // 获取到mybatis-config.xml配置文件，进而构建SqlSessionFactory InputStream is = Thread.currentThread().getContextClassLoader().getResourceAsStream("mybatis-config.xml"); Properties props = new Properties(); props.put("jdbc.password","123456"); return new SqlSessionFactoryBuilder().build(is,props); }

三种方式的顺序

首先读取property子节点中指定的属性

再读取使用resources或url引入的外部配置文件中属性，并覆盖之前的同名属性

最后读取作为方法传递的参数，并覆盖之前的同名属性

配置settings

进行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 | 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	Specifies an sql provider class that holds provider method (Since 3.5.6). This class apply to the type(or value) attribute on sql provider annotation(e.g. @SelectProvider), when these attribute was omitted.

配置typeAliases类型别名

类型别名可以为java类型设置别名，之后使用全类名时可以使用别名

<typeAliases> <!-- typeAlias为某个类起别名 --> <typeAlias type="com.zhanghe.study.mybatis.model.User" alias="User"/> <!-- 为某个包下所有类批量起别名 默认值为类名首字母小写 --> <package name="com.zhanghe.study.mybatis.model"/> </typeAliases>

也可以在类上使用@Alias注解来设置该类的别名

配置类型处理器typeHandlers

数据库类型和java类型进行转换

实现 org.apache.ibatis.type.TypeHandler 接口， 或继承 org.apache.ibatis.type.BaseTypeHandler， 并且可以将它映射到一个 JDBC 类型

@MappedJdbcTypes(JdbcType.VARCHAR) public class ExampleTypeHandler extends BaseTypeHandler<String> { @Override public void setNonNullParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType) throws SQLException { ps.setString(i, parameter); } @Override public String getNullableResult(ResultSet rs, String columnName) throws SQLException { return rs.getString(columnName); } @Override public String getNullableResult(ResultSet rs, int columnIndex) throws SQLException { return rs.getString(columnIndex); } @Override public String getNullableResult(CallableStatement cs, int columnIndex) throws SQLException { return cs.getString(columnIndex); } }

<typeHandlers> <typeHandler handler="org.mybatis.example.ExampleTypeHandler"/> </typeHandlers>

配置插件plugins

mybatis可以使用插件来在映射语句执行过程中的某一点进行拦截调用，包括

Executor (update、query、flushStatements、commit、rollback、getTransaction、close、isClose)

ParameterHandler (getParameterObject、setParameters)

ResultSetHandler (handleResultSets、handleOutputParameters)

StatementHandler (prepare、parameterize、batch、update、query)

需要实现Interceptor接口，并指定想要拦截的方法签名来使用插件

Intercepts({@Signature( type= Executor.class, method = "update", args = {MappedStatement.class,Object.class})}) public class ExamplePlugin implements Interceptor { private Properties properties = new Properties(); public Object intercept(Invocation invocation) throws Throwable { // implement pre processing if need Object returnObject = invocation.proceed(); // implement post processing if need return returnObject; } public void setProperties(Properties properties) { this.properties = properties; } }

<plugins> <plugin interceptor="org.mybatis.example.ExamplePlugin"> <property name="someProperty" value="100"/> </plugin> </plugins>

注意：如果有多个插件拦截相同方法的时候，会按照配置的先后顺序来进行包装代理，在执行时会执行最外层的插件，也就是逆向执行

配置环境environments

mybatis可以配置多个环境，可以连接多个数据库，但是每个SqlSessionFactory实例只可以选择一种环境

在构建sqlSessionFactory的时候可以指定选择创建哪个环境

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

<!-- 环境 default表示默认使用环境 --> <environments default="development"> <environment id="development"> <!-- 事务管理器有两种类型 1、JDBC 该配置直接使用了JDBC的提交和回滚，依赖从数据源获得的连接来管理事务作用域 2、MANAGED 使用容器来管理事务的整个生命周期(spring会使用自带的管理器，不需要配置mybatis的事务管理器) --> <transactionManager type="JDBC"/> <!-- 数据源有三种类型 1、UNPOOLED 每次请求时打开和关闭连接 额外属性 - defaultTransactionIsolationLevel 默认的连接事务隔离级别 - defaultNetworkTimeout 等待数据库操作完成的默认网络超时时间 2、POOLED 利用连接池的概念将JDBC连接对象组织起来，避免了创建新的连接实例 额外属性 - poolMaximumActiveConnections 在任意时间可存在的活动连接数，默认10 - poolMaximumIdleConnections 任意时间可能存在的空闲连接数 - poolMaximumCheckoutTime 在被强制返回之前，池中连接被检出时间，默认20000毫秒 - poolTimeToWait 如果获取连接花费了很长的时间，连接池会打印状态日志并重新尝试获取一个连接，默认20000毫秒 - poolMaximumLocalBadConnectionTolerance 如果一个线程获取到一个坏的连接，数据源允许这个线程尝试重新获取一个新的连接， 尝试次数不应该超过poolMaximumIdleConnections与poolMaximumLocalBadConnectionTolerance之和，默认为3 - poolPingQuery 发送到数据库的侦测查询，用来检验连接是否正常工作 默认 NO PING QUERY SET - poolPingEnabled 是否启用侦测查询 默认false - poolPingConnectionsNotUsedFor 配置poolPingQuery的频率(可以设置为和数据库连接超时时间一样，避免不必要的侦测) 默认0 3、JNDI 在外部配置数据源，然后一个JNDI上下文数据源引用 额外属性 - initial_context 用来在InitialContext中寻找上下文 - data_source 引用数据源实例的上下文路径 --> <dataSource type="POOLED"> <property name="driver" value="${jdbc.driver}"/> <property name="url" value="${jdbc.url}"/> <property name="username" value="${jdbc.username}"/> <!-- 可以使用:来为占位符设置默认值，如果没有读取到该属性的值，会使用该默认值 该特性默认关闭，需要配置 <property name="org.apache.ibatis.parsing.PropertyParser.enable-default-value" value="true"/> 如果开启该特性，默认使用:分隔 可以使用 <property name="org.apache.ibatis.parsing.PropertyParser.default-value-separator" value="?:"/> 来修改默认分隔符 --> <property name="password" value="${jdbc.password?:123456}"/> </dataSource> </environment>

也可以实现org.apache.ibatis.datasource.DataSourceFactory接口来自定义数据源实现，然后进行配置

配置数据库厂商标识 databaseIdProvider

mybatis可以根据不同的数据库厂商执行不同的语句，基于映射语句中的databaseId属性。mybatis会加载带有匹配当前数据库databaseId属性个所有不带databaseId属性的语句。如果同时找到带有databaseId的不带databaseId的相同语句，后者会被舍弃

<!-- 数据库厂商标识 --> <databaseIdProvider type="DB_VENDOR"> <!-- name为使用DatabaseMetaData#getDatabaseProductName()返回的厂商名称 value为所设置的别名,使用databaseId时使用别名即可 --> <property name="MySQL" value="mysql"/> <property name="Oracle" value="oracle"/> </databaseIdProvider>

在mapper.xml中可以配置不同数据库的sql语句

<!-- 查询数据的方法 --> <!-- mysql --> <select id="selectUser" resultType="User" databaseId="mysql"> select * from users where id = #{id} </select> <!-- oracle --> <select id="selectUser" resultType="User" databaseId="oracle"> select * from users where id = #{id} </select>

可以实现org.apache.ibatis.mapping.DatabaseIdProvider接口自定义DatabaseIdProvider

配置映射器mappers

将写好的sql映射文件(mapper.xml)注册到全局配置文件中

<!-- mapper配置 --> <mappers> <!-- resource 引入类路径下的资源 --> <mapper resource="mapper/UserMapper.xml"/> <!-- url 引入网络或者磁盘路径下的sql映射文件 --> <mapper url=""/> <!-- class 基于注解的方式，注册类文件 --> <mapper class="com.zhanghe.study.mybatis.mapper.UserMapper"/> <!-- 批量注册 注册整个包下的--> <package name="com.zhanghe.study.mybatis.mapper"/> </mappers>