您当前的位置:首页 > 电脑百科 > 程序开发 > 框架

最全面 MyBatis 框架核心配置文件使用总结,值得收藏!

时间:2022-11-24 09:33:50  来源:CSDN  作者:双子孤狼

前言

今天本篇主要介绍一下MyBatis的全局配置文件的使用。

configuration

mybatis-config.xml文件的头部格式我们就不说了,直接从属性开始介绍,configuration为最顶层节点,其余所有的属性都必须嵌套在configuration内,MyBatis配置文件的顶层节点如下:

 

"">
"">

可以看到configuration内的全部顶层节点只有9个,下面我们就一个个来分析一下。面试宝典:https://www.yoodb.com

properties

下面是一个相对完整的属性配置


"xxx/xxx.properties">
"jdbc.driver" value="db.properties"/>

 

"http://xxxx">
"jdbc.driver" value="db.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标签配置的。下面是一个完整的属性配置示例:


"cacheEnabled" value="false"/>
"lazyLoadingEnabled" value="false"/>
"aggressiveLazyLoading" value="false"/>
"multipleResultSetsEnabled" value="false"/>
"useColumnLabel" value="false"/>
"useGeneratedKeys" value="false"/>
"autoMAppingBehavior" value="NONE"/>
"defaultExecutorType" value="SIMPLE"/>
"defaultStatementTimeout" value="100"/>
"safeRowBoundsEnabled" value="false"/>
"mapUnderscoreToCamelCase" value="false"/>
"localCacheScope" value="SESSION"/>
"jdbcTypeForNull" value="VARCHAR"/>
"lazyLoadTriggerMethods" value="equals"/>
"defaultScriptingLanguage" value="org.Apache.ibatis.scripting.xmltags.XMLDynamicLanguageDriver"/>
"callSettersOnNulls" value="false"/>
"logPrefix" value="LONELY_WOLF_"/>
"logImpl" value="SLF4J"/>
"proxyFactory" value="JAVASSIST"/>

 

所有的可设置值列举如下(这些属性有个映像就可以了,不需要去记,常用的多用几次自然就记住了,不常用的需要的时候再查一下资料就可以了,所以建议大家可以收藏之后方便查询):

typeAliases

类型别名是为 Java 类型设置一个短的名字。它只和 XML 配置有关,存在的意义仅在于用来减少类完全限定名的冗余。

直接指定类名

例如:

alias="UserMapper" type="com.lonelyWolf.mybatis.mapper.UserMapper"/>

这样配置的话在MyBatis的xml文件中可以直接使用UserMapper代替其类的全限定名。

只指定包名

也可以指定一个包名,MyBatis会在包名下面搜索需要的 Java Bean,比如:

"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 类型。配置方式如下:

 

"xxx.xxx.xxx">

"xxx.xxx"/>

MyBatis默认提供的Java Bean和数据库字段类型映射关系如下:

自定义typeHandlers

上面是MyBatis提供的默认映射类型,可以处理大部分需求,如果我们需要有不同的需求,则可以自己定义类型,具体如何定义,在后面的文章会单独分析,在这里不展开,感兴趣的可以关注我,留意后续文章。

objectFactory

MyBatis 每次创建结果对象的新实例时,它都会使用一个对象工厂(ObjectFactory)实例来完成。默认的对象工厂需要做的仅仅是实例化目标类,要么通过默认构造方法,要么在参数映射存在的时候通过参数构造方法来实例化。如果想覆盖对象工厂的默认行为,则 可以通过创建自己的对象工厂来实现

plugins

MyBatis 允许你在已映射语句执行过程中的某一点进行拦截调用。这里我们不详细讨论,后期会有单独文章介绍MyBatis插件

environments

MyBatis 可以配置成适应多种环境,这种机制有助于将 SQL 映射应用于多种数据库之中,例如:开发、测试和生产环境需要有不同的配置;或者共享相同 Schema 的多个生产数据库, 想使用相同的 SQL 映射。许多类似的用例。注意:尽管可以配置多个环境,每个SqlSessionFactory实例只能选择其一。所以,如果想连接两个数据库,就需要创建两个SqlSessionFactory实例,每个数据库对应一个。配置示例如下:

"development">
"development">
type="JDBC">
"..." value="..."/>

 

type="POOLED">
"driver" value="${driver}"/>
"url" value="${url}"/>
"username" value="${username}"/>
"password" value="${password}"/>

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接口。然后采用如下配置:

type="自定义数据源全限定类名">
databaseIdProvider

MyBatis 可以根据不同的数据库厂商执行不同的语句,这种多厂商的支持是基于映射语句中的 databaseId 属性。MyBatis 会加载不带 databaseId 属性和带有匹配当前数据库 databaseId 属性的所有语句。如果同时找到带有databaseId 和不带 databaseId 的相 同语句,则后者会被舍弃。为支持多厂商特性只要像下面这样在 mybatis-config.xml 文件中加入 databaseIdProvider 即可:

type="DB_VENDOR" />
mappers

这个就是用来配置sql映射语句的xml文件了。mappers文件共有4种配置方式:

1、直接配置xml映射文件全限定名


"com/lonelyWolf/mybatis/mapping/UserMapper.xml"/>

 

2、通过url配置本地或者远程映射文件路径


"file://xxx.xxx.UserMapper.xml">

 

3、通过配置Mapper接口的方式来配置。


"com.lonelyWolf.mybatis.mapper.UserMapper">

 

4、通过配置Mapper接口包名的形式来配置


"com.lonelyWolf.mybatis.mapper"/>

 

注意:在使用第3和第4两种方式配置的时候,需要把xml映射文件和Mapper接口文件放在同一个目录,而且必须同名。

如果用的是maven配置的话,可能会出现以下错误:Invalid bound statement (not found),出现之后需要注意检查一下target下面的class目录内有没有xml映射文件,如果没有的话需要在pom文件中加入以下配置(因为maven默认不会加载xml文件):

 

src/main/java

**/*.xml

总结

本文主要介绍了MyBatis中的核心配置文件的使用,本文其实更适合作为手册来参考,只需大致浏览,心里有个印象,需要用的时候再去查询即可。

 

作者:双子孤狼 blog.csdn.NET/zwx900102/article/details/108492263


Tags:MyBatis   点击:()  评论:()
声明:本站部分内容及图片来自互联网,转载是出于传递更多信息之目的,内容观点仅代表作者本人,如有任何标注错误或版权侵犯请与我们联系(Email:2595517585@qq.com),我们将及时更正、删除,谢谢。
▌相关推荐
前言今天本篇主要介绍一下MyBatis的全局配置文件的使用。configurationmybatis-config.xml文件的头部格式我们就不说了,直接从属性开始介绍,configuration为最顶层节点,其余所...【详细内容】
2022-11-24  Tags: MyBatis  点击:(0)  评论:(0)  加入收藏
最近研究了一下Mybatis,给大家磕叨磕叨,MyBatis框架的核心功能其实不难,无非就是动态代理和jdbc的操作,难的是写出来可扩展,高内聚,低耦合的规范的代码。本文完成的Mybatis功能比...【详细内容】
2022-11-19  Tags: MyBatis  点击:(0)  评论:(0)  加入收藏
收获当遇到项目启动失败,却没有错误日志打印出来的时候,试试在run方法上加个try-catch,即可捕获到异常Mybatis的别名扫描路径不要指定的太宽泛,有可能会出现Bean名冲突,导致初始...【详细内容】
2022-10-30  Tags: MyBatis  点击:(20)  评论:(0)  加入收藏
操作步骤如下所示:Preferences -> Editor -> File and Code Templates,点击+加号按钮,创建一个新的模板文件,如图所示: 其中,需要输入模板文件的名称,以及后缀名为xml。 模板文件...【详细内容】
2022-10-05  Tags: MyBatis  点击:(50)  评论:(0)  加入收藏
作为CRUD程序员,大部分Java开发者应该都在用Mybatis Plus来操作数据库。但是BaseMapper默认仅提供了int insert(T entity)这个单条插入的方法。那么我们想批量插入数据该怎么...【详细内容】
2022-09-26  Tags: MyBatis  点击:(139)  评论:(0)  加入收藏
批量插入功能是我们日常工作中比较常见的业务功能之一,今天咱们来一个 MyBatis 批量插入的汇总篇,同时对 3 种实现方法做一个性能测试,以及相应的原理分析。先来简单说一下 3...【详细内容】
2022-09-02  Tags: MyBatis  点击:(68)  评论:(0)  加入收藏
1. If 语句需求:根据作者名字和博客名字来查询博客!如果作者名字为空,那么只根据博客名字查询,反之,则根据作者名字来查询<!--需求1:根据作者名字和博客名字来查询博客!如果作者名...【详细内容】
2022-06-30  Tags: MyBatis  点击:(85)  评论:(0)  加入收藏
在进行持久层数据维护(新增或修改)的时候,我们通常需要记录一些非业务字段,比如:create_time、update_time、update_by、create_by等用来维护数据记录的创建时间、修改时间、修改...【详细内容】
2022-06-20  Tags: MyBatis  点击:(94)  评论:(0)  加入收藏
Mybatis 是 Java 中一个非常好用的数据库框架,这儿记录一下在使用过程中遇到的坑。官方中文文档地址:http://www.mybatis.org/mybatis-3/zh/getting-started.html1、在Mybatis...【详细内容】
2022-06-20  Tags: MyBatis  点击:(105)  评论:(0)  加入收藏
踩坑记:在传递List<Integer> typeIds作为参数时,MyBatis foreach不能获取到参数,使用Integer[] typeIds就可以了。主要代码:1、接口<!-- 获取站点列表 -->List<Station> getList...【详细内容】
2022-02-23  Tags: MyBatis  点击:(247)  评论:(0)  加入收藏
▌简易百科推荐
前言今天本篇主要介绍一下MyBatis的全局配置文件的使用。configurationmybatis-config.xml文件的头部格式我们就不说了,直接从属性开始介绍,configuration为最顶层节点,其余所...【详细内容】
2022-11-24  双子孤狼  CSDN  Tags:MyBatis   点击:(0)  评论:(0)  加入收藏
最近我在做一个新项目,由于我们项目组一直使用的是 MongoDB 数据库,所以新项目我就打算上 Spring Data MongoDB 尝试一下,虽然我早就用过了 Spring Data JPA,对 Spring Data 的...【详细内容】
2022-11-22  和耳朵  掘金  Tags:Spring   点击:(2)  评论:(0)  加入收藏
2021 年 9 月 8 日,字节跳动宣布正式开源 CloudWeGo。CloudWeGo 是一套字节跳动内部微服务中间件集合,具备高性能、强扩展性和稳定性的特点,专注于解决微服务通信与治理的难题,...【详细内容】
2022-11-19  字节跳动技术团队  今日头条  Tags:框架   点击:(8)  评论:(0)  加入收藏
最近研究了一下Mybatis,给大家磕叨磕叨,MyBatis框架的核心功能其实不难,无非就是动态代理和jdbc的操作,难的是写出来可扩展,高内聚,低耦合的规范的代码。本文完成的Mybatis功能比...【详细内容】
2022-11-19  Java精选   网易号  Tags:Mybatis   点击:(0)  评论:(0)  加入收藏
讨论主题主要想搞清楚几个问题 mybatis plus是依赖了mybatis,他们之间的关系是什么? mybatis plus中“字段自动填充功能”实现源码,包括id自动生成的原理。 mybatis plus 基本...【详细内容】
2022-11-18  奋斗的架构师  今日头条  Tags:   点击:(19)  评论:(0)  加入收藏
缘由什么是 KMS ?要了解 KMS,首先要了解 DRM。DRM 是 Direct Rendering Manager 的缩写,最初只是用来支持 GPU 的,最初它负责: Initialize GPU card, load its firmware, etc. ...【详细内容】
2022-11-18  老吴嵌入式   今日头条  Tags:Display框架   点击:(13)  评论:(0)  加入收藏
前言准确点说,这不是《从零打造项目》系列的第一篇文章,模版代码生成的那个项目讲解算是第一篇,当时就打算做一套项目脚手架,为后续进行项目练习做准备。因时间及个人经验问题...【详细内容】
2022-11-18  Java热点  今日头条  Tags:SpringBoot   点击:(11)  评论:(0)  加入收藏
作者 | 褚杏娟近日,GitHub 前 CTO Jason Warner 在推特上表示,“我确信过去十年中,最大的架构错误之一就是全面使用微服务。”从单体应用到微服务的规划顺序,Warner 的建议是:单...【详细内容】
2022-11-18  InfoQ  今日头条  Tags:GitHub   点击:(17)  评论:(0)  加入收藏
一、Scrapy框架简介Scrapy是:由Python语言开发的一个快速、高层次的屏幕抓取和web抓取框架,用于抓取web站点并从页面中提取结构化的数据,只需要实现少量的代码,就能够快速的抓...【详细内容】
2022-11-16  运维笔记ywbj  今日头条  Tags:Scrapy   点击:(16)  评论:(0)  加入收藏
1. 介绍在我们日常的Java开发中,免不了和其他系统的业务交互,或者微服务之间的接口调用如果我们想保证数据传输的安全,对接口出参加密,入参解密。但是不想写重复代码,我们可以提...【详细内容】
2022-11-16  Java架构学习指南  今日头条  Tags:SpringBoot   点击:(0)  评论:(0)  加入收藏
站内最新
站内热门
站内头条