最全 MyBatis 核心配置文件总结,速度收藏了~
前言
今天这咱主要介绍一下 MyBatis 的全局配置文件的使用。
configuration
mybatis-config.xml文件的头部格式我们就不说了,直接从属性开始介绍,configuration为最顶层节点,其余所有的属性都必须嵌套在configuration内,MyBatis配置文件的顶层节点如下:
<properties></properties><!-- 属性 -->
<settings></settings> <!-- 设置-->
<typeAliases></typeAliases><!-- 配置别名 -->
<typeHandlers></typeHandlers><!-- 类型处理器 -->
<objectFactory></objectFactory><!-- 对象工厂 -->
<plugins></plugins><!-- 插件 -->
<environments default=""><!-- 环境配置--><environment id=""><!-- 环境变量 --><transactionManager></transactionManager><!-- 事务管理器 --><dataSource></dataSource><!-- 数据源 --></environment>
</environments>
<databaseIdProvider></databaseIdProvider><!-- 数据库厂商标识 -->
<mappers></mappers><!-- 映射器 -->
可以看到configuration内的全部顶层节点只有9个,下面我们就一个个来分析一下
properties
下面是一个相对完整的属性配置:
<!-- 配置resource-->
<properties resource="xxx/xxx.properties"><!-- 属性 --><property name="jdbc.driver" value="db.properties"/>
</properties>
<!-- 配置url-->
<properties url="http://xxxx"><!-- 属性 --><property name="jdbc.driver" value="db.properties"/>
</properties>
上面我特意分开写,就是怕引起大家的误解,因为resource和url只允许存在一个,不能同时配置两个属性,可以看到源码中的解析过程:同时配置了resource和url会抛出异常。
配置了properties属性之后,在xml其他配置文件中可以直接通过${xxx}来读取。
properties配置有三种方式,resource或者url指定,直接配置在子节点properties中,另一种就是上一篇提到的,直接代码中去其他地方读取properties文件,然后传入build方法。
那么这三种方式既然都能配置,假如属性配置重复了,优先级是怎么样的呢?
properties优先级
properties配置的属性如果重复,优先级如下:
1、第一优先:在代码中直接通过properties传入build方法。
2、第二优先:通过resource或者url读取到的properties文件中属性。
3、第三优先:直接在properties内的子标签property内定义的属性。
在实际开发中,建议是只使用一种,使用多种方式混合的话会给后期维护造成困难,而且不同类型的配置属性混合时可读性也不好。
settings
settings是MyBatis中最复杂,也是最重要的内容之一。当然这里说的复杂并不是说配置方式复杂,而是settings能配置的东西非常多,一些很核心的功能都是通过settings标签配置的。
下面是一个完整的属性配置示例:
<settings><!-- 设置--><setting name="cacheEnabled" value="false"/><setting name="lazyLoadingEnabled" value="false"/><setting name="aggressiveLazyLoading" value="false"/><setting name="multipleResultSetsEnabled" value="false"/><setting name="useColumnLabel" value="false"/><setting name="useGeneratedKeys" value="false"/><setting name="autoMappingBehavior" value="NONE"/><setting name="defaultExecutorType" value="SIMPLE"/><setting name="defaultStatementTimeout" value="100"/><setting name="safeRowBoundsEnabled" value="false"/><setting name="mapUnderscoreToCamelCase" value="false"/><setting name="localCacheScope" value="SESSION"/><setting name="jdbcTypeForNull" value="VARCHAR"/><setting name="lazyLoadTriggerMethods" value="equals"/><setting name="defaultScriptingLanguage" value="org.apache.ibatis.scripting.xmltags.XMLDynamicLanguageDriver"/><setting name="callSettersOnNulls" value="false"/><setting name="logPrefix" value="LONELY_WOLF_"/><setting name="logImpl" value="SLF4J"/><setting name="proxyFactory" value="JAVASSIST"/>
</settings>
所有的可设置值列举如下(这些属性有个映像就可以了,不需要去记,常用的多用几次自然就记住了,不常用的需要的时候再查一下资料就可以了,所以建议大家可以收藏之后方便查询):
typeAliases
类型别名是为 Java 类型设置一个短的名字。它只和 XML 配置有关,存在的意义仅在于用来减少类完全限定名的冗余。
直接指定类名
例如:
<typeAlias alias="UserMapper" type="com.lonelyWolf.mybatis.mapper.UserMapper"/>
这样配置的话在MyBatis的xml文件中可以直接使用UserMapper代替其类的全限定名。
只指定包名
也可以指定一个包名,MyBatis会在包名下面搜索需要的 Java Bean,比如:
<package name="com.lonelyWolf.mybatis.mapper"/>
这么配置的话每一个在指定包名中的Java类,如果没有使用注解指定名称,则会默认使用Bean的首字母小写的非限定类名来作为它的别名,如果有注解,则优先使用注解指定的别名。如:
@Alias("lonely_wolf")
public class LonelyWolf{
}
这里因为注解指定了别名,所以会以注解为准,如果没有注解,则默认使用lonelyWolf作为别名。
系统默认提供的别名
实际开发中,有很多返回类型是数据基本类型或者String,Map,List等非常常见的类型,这些类型MyBatis已经为我们提供好了别名,我们就不需要另外再定义了。以下就时MyBatis中默认提供的别名:PS:这些别名的字母都是不区分大小写的,因为MyBatis在注册别名的时候会全部转为小写字母存储。
typeHandlers
typeHandlers主要是用来实现Java对象和数据库字段类型额转换关系。无论是 MyBatis 在预处理语句(PreparedStatement)中设置一个参数时,还是从结果集中取出一个值时, 都会用类型处理器将获取的值以合适的方式转换成 Java 类型。配置方式如下:
<typeHandlers><!-- 自定义typeHandlers全限定类名 --><typeHandler handler="xxx.xxx.xxx"></typeHandler><!-- 获取指定包名下的typeHandlers --><package name="xxx.xxx"/>
</typeHandlers>
MyBatis默认提供的Java Bean和数据库字段类型映射关系如下:
自定义typeHandlers
上面是MyBatis提供的默认映射类型,可以处理大部分需求,如果我们需要有不同的需求,则可以自己定义类型,具体如何定义,在后面的文章会单独分析,在这里不展开,感兴趣的可以关注Java技术栈,留意后续文章。关注公众号互联网架构师获取更多 Mybatis 教程。
objectFactory
MyBatis 每次创建结果对象的新实例时,它都会使用一个对象工厂(ObjectFactory)实例来完成。
默认的对象工厂需要做的仅仅是实例化目标类,要么通过默认构造方法,要么在参数映射存在的时候通过参数构造方法来实例化。如果想覆盖对象工厂的默认行为,则 可以通过创建自己的对象工厂来实现
plugins
MyBatis 允许你在已映射语句执行过程中的某一点进行拦截调用。这里我们不详细讨论,后期会有单独文章介绍MyBatis插件。
environments
MyBatis 可以配置成适应多种环境,这种机制有助于将 SQL 映射应用于多种数据库之中,例如:开发、测试和生产环境需要有不同的配置;或者共享相同 Schema 的多个生产数据库, 想使用相同的 SQL 映射。
许多类似的用例。注意:尽管可以配置多个环境,每个SqlSessionFactory实例只能选择其一。所以,如果想连接两个数据库,就需要创建两个SqlSessionFactory实例,每个数据库对应一个。
配置示例如下:
<environments default="development"><environment id="development"><transactionManager type="JDBC"><property name="..." value="..."/></transactionManager><dataSource type="POOLED"><property name="driver" value="${driver}"/><property name="url" value="${url}"/><property name="username" value="${username}"/><property name="password" value="${password}"/></dataSource></environment>
</environments>
environment配置关键点:
默认的环境 ID(比如:default=”development”)
每个 environment 元素定义的环境 ID(比如:id=”development”)。
事务管理器的配置(比如:type=”JDBC”)。
数据源的配置(比如:type=”POOLED”)。
事务管理器
在 MyBatis 中有两种类型的事务管理器(也就是 type=”JDBC"或者"MANAGED”):
JDBC:这个配置就是直接使用了 JDBC 的提交和回滚设置,它依赖于从数据源得到的连接来管理事务范围。
MANAGED:这个配置几乎没做什么。它从来不提交或回滚一个连接,而是让容器来管理事务的整个生命周期(比如J2EE应用容器上下文)。默认情况下它会关闭连接,然而一些容器并不希望这样,因此需要将 closeConnection 属性设置为 false 来阻止它默认的关闭行为。如:注意:如果单独使用MyBatis而没有集成能管理事务的容器,那么配置成MANAGED就会等同于没有事务,所以一般单独使用MyBatis时,应配置为JDBC。
数据源
dataSource元素使用标准的 JDBC 数据源接口来配置JDBC连接对象的资源。有三种内建的数据源类型(也就是 type=”[UNPOOLED|POOLED|JNDI]”)。
UNPOOLED
非连接池数据源。UNPOOLED 类型的数据源仅仅需要配置以下 5 种属性:
driver – 这是 JDBC 驱动的 Java 类的完全限定名(并不是JDBC驱动中可能包含的数据源类)
url – 这是数据库的 JDBC URL 地址
username – 登录数据库的用户名
password – 登录数据库的密码
defaultTransactionIsolationLevel – 默认的连接事务隔离级别
POOLED
连接池数据源。除了上述提到UNPOOLED下的属性外,会有更多属性用来配置 POOLED 的数据源:
poolMaximumActiveConnections – 在任意时间可以存在的活动(也就是正在使用)连接数量,默认值:10
poolMaximumIdleConnections – 任意时间可能存在的空闲连接数
poolMaximumCheckoutTime – 在被强制返回之前,池中连接被检出(checked out)时间,默认值:20000 毫秒(即 20 秒)
poolTimeToWait – 这是一个底层设置,如果获取连接花费的相当长的时间,它会给连接池打印状态日志并重新尝试获取一个连接(避免在误配置的情况下一直安静的失败),默认值:20000 毫秒(即 20 秒)
poolPingQuery – 发送到数据库的侦测查询,用来检验连接是否处在正常工作秩序中并准备接受请求。默认是“NO PING QUERY SET”,这会导致多数数据库驱动失败时带有一个恰当的错误消息。
poolPingEnabled – 是否启用侦测查询。若开启,也必须使用一个可执行的 SQL 语句设置 poolPingQuery 属性(最好是一个非常快的 SQL),默认值:false
poolPingConnectionsNotUsedFor – 配置 poolPingQuery 的使用频度。这可以被设置成匹配具体的数据库连接超时时间,来避免不必要的侦测,默认值:0(即所有连接每一时刻都被侦测 — 当然仅当 poolPingEnabled 为 true 时适用)
JNDI
这个数据源的实现是为了能在如 EJB 或应用服务器这类容器中使用,容器可以集中或在外部配置数据源,然后放置一个 JNDI 上下文的引用。这种数据源配置只需要两个属性:
initial_context – 这个属性用来在 InitialContext 中寻找上下文(即,initialContext.lookup(initial_context))。这是个可选属性,如果忽略,那么 data_source 属性将会直接从 InitialContext 中寻找。
data_source – 这是引用数据源实例位置的上下文的路径。提供了 initial_context 配置时会在其返回的上下文中进行查找,没有提供时则直接在 InitialContext 中查找。
自定义数据源
有些业务场景可能需要自己自定义数据源,MyBatis也是支持的。自定义数据源必须要实现DataSourceFactory接口。然后采用如下配置:
<dataSource type="自定义数据源全限定类名"></dataSource>
databaseIdProvider
MyBatis 可以根据不同的数据库厂商执行不同的语句,这种多厂商的支持是基于映射语句中的 databaseId 属性。
MyBatis 会加载不带 databaseId 属性和带有匹配当前数据库 databaseId 属性的所有语句。如果同时找到带有databaseId 和不带 databaseId 的相 同语句,则后者会被舍弃。
为支持多厂商特性只要像下面这样在 mybatis-config.xml 文件中加入 databaseIdProvider 即可:
<databaseIdProvider type="DB_VENDOR" />
mappers
这个就是用来配置sql映射语句的xml文件了。
mappers文件共有4种配置方式:
1、直接配置xml映射文件全限定名
<mappers><mapper resource="com/lonelyWolf/mybatis/mapping/UserMapper.xml"/>
</mappers>
2、通过url配置本地或者远程映射文件路径
<mappers><mapper url="file://xxx.xxx.UserMapper.xml"></mapper>
</mappers>
3、通过配置Mapper接口的方式来配置。
<mappers><mapper class="com.lonelyWolf.mybatis.mapper.UserMapper"></mapper>
</mappers>
4、通过配置Mapper接口包名的形式来配置
<mappers><package name="com.lonelyWolf.mybatis.mapper"/>
</mappers>
注意:在使用第3和第4两种方式配置的时候,需要把xml映射文件和Mapper接口文件放在同一个目录,而且必须同名。
如果用的是maven配置的话,可能会出现以下错误:Invalid bound statement (not found),出现之后需要注意检查一下target下面的class目录内有没有xml映射文件,如果没有的话需要在pom文件中加入以下配置(因为maven默认不会加载xml文件):
<build> <resources><resource><directory>src/main/java</directory><includes><include>**/*.xml</include></includes></resource></resources>
</build>
总结
本文主要介绍了MyBatis中的核心配置文件的使用,本文其实更适合作为手册来参考,只需大致浏览,心里有个印象,需要用的时候再去查询即可。
本文链接:https://blog.csdn.net/zwx900102/article/details/108492263
关注微信公众号:互联网架构师,在后台回复:2T,可以获取我整理的教程,都是干货。
猜你喜欢
1、GitHub 标星 3.2w!史上最全技术人员面试手册!FackBoo发起和总结
2、如何才能成为优秀的架构师?
3、从零开始搭建创业公司后台技术栈
4、程序员一般可以从什么平台接私活?
5、37岁程序员被裁,120天没找到工作,无奈去小公司,结果懵了...
6、滴滴业务中台构建实践,首次曝光
7、不认命,从10年流水线工人,到谷歌上班的程序媛,一位湖南妹子的励志故事
8、15张图看懂瞎忙和高效的区别
9、2T架构师学习资料干货分享
最全 MyBatis 核心配置文件总结,速度收藏了~相关推荐
- mybatis plus 事务管理器_最全MyBatis核心配置文件总结,可以作为工具先收藏了
作者:双子孤狼 来源:blog.csdn.net/zwx900102/article/details/108492263 前言 今天这咱主要介绍一下MyBatis的全局配置文件的使用 configur ...
- 最全MyBatis核心配置文件总结,深夜思考
前言 说起Spring中循环依赖的解决办法,相信很多园友们都或多或少的知道一些,但当真的要详细说明的时候,可能又没法一下将它讲清楚.本文就试着尽自己所能,对此做出一个较详细的解读.另,需注意一点,下文 ...
- 最全MyBatis核心配置文件总结:java运行环境没有安装或配置错误
零基础如何学习Java? 首先,你要明白一点,Java入门不难! 无论你是从事哪个行业,兴趣一定是最好的老师,也是你学习的动力. 学习方式1:自学 自学模式其实我个人不建议绝大部分的人选择,因为自学是 ...
- java元婴期(23)----java进阶(mybatis(2)---mapper代理mybatis核心配置文件输入输出映射)
1.mapper代理 1.mybatis开发dao的方法----引入(为啥要使用mapper代理) 1.SqlSession使用范围 1.SqlSessionFactoryBuilder 通过SqlS ...
- MyBatis核心配置文件详解
MyBatis核心配置文件详解 1.核心配置文件中的标签必须按照固定的顺序 2.properties标签 3.settings标签 4.typeAliases标签 5.environments标签 6 ...
- 在idea中创建mybatis-config.xml模板(在idea中创建mybatis核心配置文件模板)
在idea中创建mybatis-config.xml模板(在idea中创建mybatis核心配置文件模板) 1.写配置文件 2.设置 3.查看 1.写配置文件 先创建一个mybatis-config. ...
- Mybatis核心配置文件
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE configurationPUBLIC & ...
- MyBatis核心配置文件深入
typeHandlers标签 无论是MyBatis在预处理语句中设置一个参数时,还是从结果集中取出一个值时,都会用类型处理器将获取的值以合适的方式转换成Java类型.也可以重写类型处理器或创建你自己的 ...
- Mybatis————核心配置文件标签和动态常用的SQL标签
核心配置文件: properties标签 properties标签可以通过resource属性指定外部properties文件 写一个外部文件 一个key值对应一个values值 通过resource ...
- Mybatis核心配置文件SqlMapConfig.xml
配置内容: SqlMapConfig.xml中配置的内容和顺序如下: 1.properties(属性) 2.settings(全局配置参数) 3.typeAliases(类型别名) 4.typeHan ...
最新文章
- 20181113-2 每周例行报告
- 如何进行Web服务的性能测试?
- matlab 基础知识查漏
- Linux下的格式化字符串漏洞利用姿势
- python 类-9. 类 — Python 3.9.0 文档
- windows mysql is read only_mysql中Table is read only错误解决方法(转载)
- mysql_connect和mysql_pconnect区别
- C# 使用SFTP的上传下载文件时如何使用代理
- 使用QTP录制自带Flight小实例
- 学习一下物联网协议 wifi zigbee 蓝牙等等----从wifi就开始 wifi和wifi协议 关于wifi协议本身我们需要了解那些东西?
- WinSCP(Windows与Linux文件同步工具)使用总结
- p39最大子数组问题o(lgn)
- android和iOS平台的崩溃捕获和收集
- one 主格 复数 宾格_主格和宾格的区别
- Vim 大小写切换快捷键
- 7000词汇这么背我比较可以接受,连续看20天足以
- 春江水暖鸭先知,不破楼兰誓不还
- 解决Echarts柱形图正负数在同一侧,并设置正负值不同颜色
- 东方已渐白。一枕清欢更待何人说
- java.vm.info_JNI完全指南(十)——JavaVM与JNIEnv
热门文章
- SylixOS中netdev_pbuf_alloc函数分析
- 调试工具BTrace 的使用--例子
- Curator Zookeeper分布式锁
- VMware workstaion上传虚拟机到VMware EXSI 5.5
- 11. SpringMVC拦截器(资源和权限管理)
- Oracle DML NOLOGGING
- poj Shortest Prefixes ——trie树、字典树,基础!!
- 如何在双显示器设置中将 Mac Dock 保持在一个屏幕上?
- Arnold for Cinema 4D for mac(C4D R26阿诺德渲染器)
- Translatium for Mac(多语言在线翻译工具)