Mybatis全局配置文件
1 |
|
配置properties属性
可以在全局配置文件中配置properties标签来进行外部配置
设置属性的方式有三种
在properties的属性节点resource或url所指定的资源文件中配置
在properties的子节点property中配置
在构建SqlSessionFactory时通过方法传入参数
外部配置文件引入
1 | com.mysql.jdbc.Driver = |
1 | <!-- 使用 properties来引入外部配置文件内容--> |
property子节点配置
1 | <!-- 也可以使用property子节点来进行配置 --> |
实例化时方法传参
1 | public static SqlSessionFactory createFactory(){ |
使用
使用${}来引用配置好的属性值
1 | <!-- 数据库配置 --> |
三种方式的顺序
- 首先读取property子节点中指定的属性
- 再读取使用resources或url引入的外部配置文件中属性,并覆盖之前的同名属性
- 最后读取作为方法传递的参数,并覆盖之前的同名属性
配置settings设置
mybatis中有很多默认的配置,可以使用settings来进行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 \ | 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. |
A type alias or fully qualified class name | Not set |
1 | <settings> |
也可以使用java实现
1 | Configuration configuration = new Configuration(); |
配置typeAliases类型别名
由于在配置resultMap、resultType、parameterType的时候可能会用到类的全类名,而全类名一般又很长,可以为类来设置别名
系统定义别名
Mybatis中定义了一些经常使用的类型别名
1 | //TypeAliasRegistry类中 |
自定义别名
类型别名可以为java类型设置别名,之后使用全类名时可以使用别名
1 | <typeAliases> |
也可以在类上使用@Alias注解来设置该类的别名
也可以使用java来实现
1 | Configuration configuration = new Configuration(); |
配置typeHandlers类型处理器
作用是将参数从javaType转化为jdbcType,或者从数据库中取出结果时把jdbcType转化为javaType
在使用原生JDBC的时候使用PreparedStatement来设置参数时,是需要自己根据不同的类型来使用不同的方法的
1 | String sql = "insert into user (name) values (?)"; |
那么mybatis如何知道该使用什么方法呢,这里就用到了typeHandlers
系统定义typeHandler
mybatis中有很多类型处理器,对于所有的基本数据类型、基本数据类型包装类、byte[]、java.util.Date、java.sql.Date、java.sql.Time、java.sql.TimeStamp、java枚举等。
1 | // TypeHandlerRegistry |
自定义typeHandler
也可以来自定义一个typeHandler,通过实现 org.apache.ibatis.type.TypeHandler 接口, 或继承 org.apache.ibatis.type.BaseTypeHandler, 并且可以将它映射到一个 JDBC 类型
1 | // 定义的是javaType类型,可以指定哪些java类型被拦截 |
1 | <typeHandlers> |
也可以使用java实现
1 | Configuration configuration = new Configuration(); |
配置objectFactory对象工厂
每次 MyBatis 创建结果对象的新实例时,它都会使用一个ObjectFactory实例来完成实例化工作。 默认的objectFactory(DefaultObjectFactory)需要做的仅仅是实例化目标类,要么通过默认无参构造方法,要么通过存在的参数映射来调用带有参数的构造方法。 如果想覆盖对象工厂的默认行为,可以通过创建自己的对象工厂来实现
1 | public interface ObjectFactory { |
继承DefaultObjectFactory类
1 | public class ExampleObjectFactory extends DefaultObjectFactory { |
1 | <objectFactory type="org.mybatis.example.ExampleObjectFactory"> |
配置plugins插件
mybatis可以使用插件来在映射语句执行过程中的某一点进行拦截调用,包括
- Executor (update、query、flushStatements、commit、rollback、getTransaction、close、isClose)
- ParameterHandler (getParameterObject、setParameters)
- ResultSetHandler (handleResultSets、handleOutputParameters)
- StatementHandler (prepare、parameterize、batch、update、query)
需要实现Interceptor接口,并指定想要拦截的方法签名来使用插件
1 | Intercepts({ |
1 | <plugins> |
注意:如果有多个插件拦截相同方法的时候,会按照配置的先后顺序来进行包装代理,在执行时会执行最外层的插件,也就是逆向执行
配置environments环境
mybatis可以配置多个环境,可以连接多个数据源,每一个数据源分为两部分:一个是数据源的配置,一个是数据库事务的配置,但是每个SqlSessionFactory实例只可以选择一种环境,如在开发环境、测试环境、生产环境等所用的配置可能不同,如果想要连接两个数据库,则需要创建两个SqlSessionFactory实例
在构建sqlSessionFactory的时候可以指定选择创建哪个环境,如果不传入environment,则会使用默认的环境
1 | SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment); |
1 | <!-- 环境 default表示默认使用环境 --> |
也可以实现org.apache.ibatis.datasource.DataSourceFactory接口来自定义数据源实现,然后进行配置<dataSource type="全类名">
也可以使用Java来编码实现
1 | DataSource dataSource = new PooledDataSourceFactory().getDataSource(); |
自定义数据源
实现org.apache.ibatis.datasource.DataSourceFactory接口
配置 databaseIdProvider数据库厂商标识
mybatis可以根据不同的数据库厂商执行不同的语句,基于映射语句中的databaseId属性。mybatis会加载带有匹配当前数据库databaseId属性个所有不带databaseId属性的语句。如果同时找到带有databaseId的不带databaseId的相同语句,后者会被舍弃
1 | <!-- 数据库厂商标识 |
在mapper.xml中可以使用databaseId配置不同数据库的sql语句
1 | <!-- 查询数据的方法 --> |
可以实现org.apache.ibatis.mapping.DatabaseIdProvider接口自定义DatabaseIdProvider
配置mappers映射器
将写好的sql映射文件(mapper.xml)注册到全局配置文件中
1 | <!-- mapper配置 --> |
也可以使用java来实现
1 | Configuration configuration = new Configuration(); |