Mybatis-XML配置文件的详细属性及配置

最新推荐文章于 2024-04-12 02:46:43 发布

一眉程序猿

最新推荐文章于 2024-04-12 02:46:43 发布

阅读量2.3k

点赞数 2

分类专栏：框架 Mybatis 文章标签： mybatis

本文链接：https://blog.csdn.net/weixin_45935633/article/details/104698631

版权

框架同时被 2 个专栏收录

22 篇文章 0 订阅

订阅专栏

Mybatis

11 篇文章 0 订阅

订阅专栏

Mybatis-XML配置文件

我们在使用Mybatis框架的时候，一开始就需要先把它的配置文件写好，虽然它的名字可以为任意值，但是官方建议我们使用mybatis-config.xml命名，关于该配置文件中的配置，有如下标签：

属性（properties）
设置（settings）
类型别名（typeAliases）
类型处理器（typeHandlers）
对象工厂（objectFactory）
插件（plugins）
环境配置（environments）
数据库厂商识别（databaseIdProvider）
映射器（mappers）

以上都是Mybatis配置文件中的相关配置标签，我们在Mybatis的配置文件中使用它们也不能乱用，特别是顺序，我们要按照以上顺序在配置文件中定义自己需要的配置，一般智能IDE都会有提示，使用记事本手撕代码的读者可要多多注意，虽然看起来较为复杂，但是我们实际使用的也不多，下面展示博主认为常用的一些：

属性（properties）

这个标签主要用于从外部引入某些属性的值，我们以前使用原生JDBC的代码连接数据库通常都是将数据库的连接信息用一个properties文件将其存储，让程序来读取配置文件，从而获得其中对应的属性值，这里的properties也可以理解为这个作用。

db.properties：

mysql.driver=com.mysql.jdbc.Driver
mysql.url=jdbc:mysql://localhost:3306/mybatis?useSSl=true&useUnicode=true&characterEncoding=UTF-8
mysql.username=root
mysql.password=123456

在Mybatis的配置文件中引入上面这个db。properties配置文件中的值。

<!--  properties标签用于指定我们需要从外部加载配置文件  -->
<!--  resource：指定我们加载properties文件的类路径（常用）  -->
<!--  url：指定我们加载properties文件的完全限定路径  -->
<!--  resource和url我们选择一个使用即可  -->
<properties resource="db.properties">
    <!--  这里面的子标签表示可以在引入外部配置文件的基础上再添加属性  -->        
    <!--  name:属性名  -->        
    <!--  value：属性值  -->        
    <property name="mysql.username" value="Ara_Hu"/>
</properties>

引入的目的就是为了得到其中的值，我们引入的是关于数据库连接的一些参数，那么在Mybatis的配置文件中想要得到其中的值，采用${属性名}获取，举例如下：

<dataSource type="POOLED">
    <property name="driver" value="${mysql.driver}"/>
    <property name="url" value="${mysql.url}"/>
    <property name="username" value="${mysql.username}"/>
    <property name="password" value="${mysql.password}"/>
</dataSource>

这里值得注意的地方就是我们在外部配置文件db.properties和properties的标签中都设置了一个同名的属性mysql.username，但是其中的值不一致，Mybatis将会按照下面的顺序来加载：

在properties元素内指定的属性会首先被读取。
然后根据properties元素中的resource属性读取类路径下属性文件或者根据url属性指定的路径读取属性文件，这个动作会覆盖已经读取的同名属性。
最后去读作为方法参数传递的属性，这个动作会覆盖已经读取的同名属性。

由此看来，通过方法参数传递的属性具有最高的优先级，其次是resource/url属性中指定的配置文件，最低的优先级是properties属性中指定的属性。

设置（settings）

该标签是用于设置Mybatis运行时的行为。

<!--  用于设置Mybatis运行时的行为  -->
<settings>
    <!--  用于具体设置某种行为  -->
    <!--  name:行为名称  -->
    <!--  value:行为值  -->
    <setting name="" value=""/>
</settings>

它的行为值包含如下：

name	value	默认	描述
cacheEnabled	true、false	true	全局的开启或关闭配置文件中的所有映射器已经配置的任何缓存
lazyLoadingEnabled	true、false	false	延迟加载的全局开关，开启时，所有的关联对象都会延迟加载。特定关联关系中可通过设置fetchType来覆盖该设置
aggressiveLazyLoading	true、false	false	当开启时，任何方法的调用都会加载该对象的所有属性。否则，每个属性会按需加载
multipleResultSetsEnabled	true、false	true	是否允许单一语句返回多结果集（需要驱动支持）
useColumnLabel	true、false	true	使用列标签代替列名。不同的驱动在这方面会有不同的表现，具体可参考相关驱动文档或通过测试这两种不同的模式来观察所用驱动的结果
useGeneratedKeys	true、false	false	允许 JDBC 支持自动生成主键，需要驱动支持。如果设置为 true 则这个设置强制使用自动生成主键，尽管一些驱动不能支持但仍可正常工作
autoMappingBehavior	NONE, PARTIAL, FULL	PARTIAL	指定 MyBatis 应如何自动映射列到字段或属性。 NONE 表示取消自动映射；PARTIAL 只会自动映射没有定义嵌套结果集映射的结果集。 FULL 会自动映射任意复杂的结果集（无论是否嵌套）
autoMappingUnknownColumnBehavior	NONE, WARNING, FAILING	NONE	指定发现自动映射目标未知列（或者未知属性类型）的行为。NONE: 不做任何反应，WARNING: 输出提醒日志 ('org.apache.ibatis.session.AutoMappingUnknownColumnBehavior’的日志等级必须设置为 WARN)，FAILING: 映射失败 (抛出 SqlSessionException)
defaultExecutorType	SIMPLE，REUSE，BATCH	SIMPLE	配置默认的执行器。SIMPLE 就是普通的执行器；REUSE 执行器会重用预处理语句（prepared statements）； BATCH 执行器将重用语句并执行批量更新
defaultStatementTimeout	任意正整数	null	设置超时时间，它决定驱动等待数据库响应的秒数
defaultFetchSize	任意正整数	null	为驱动的结果集获取数量（fetchSize）设置一个提示值。此参数只可以在查询设置中被覆盖
safeRowBoundsEnabled	true，false	false	允许在嵌套语句中使用分页（RowBounds）。如果允许使用则设置为 false
safeResultHandlerEnabled	true，false	true	允许在嵌套语句中使用分页（ResultHandler）。如果允许使用则设置为 false
mapUnderscoreToCamelCase	true，false	false	是否开启自动驼峰命名规则（camel case）映射（从经典数据库列名 A_COLUMN 到经典 Java 属性名 aColumn 的类似映射）
localCacheScope	SESSION，STATEMENT	SESSION	MyBatis 利用本地缓存机制（Local Cache）防止循环引用（circular references）和加速重复嵌套查询。默认值为 SESSION，这种情况下会缓存一个会话中执行的所有查询。若设置值为 STATEMENT，本地会话仅用在语句执行上，对相同 SqlSession 的不同调用将不会共享数据
jdbcTypeForNull	JdbcType 常量，常用值：NULL, VARCHAR 或 OTHER	OTHER	当没有为参数提供特定的 JDBC 类型时，为空值指定 JDBC 类型。某些驱动需要指定列的 JDBC 类型，多数情况直接用一般类型即可，比如 NULL、VARCHAR 或 OTHER
lazyLoadTriggerMethods	用逗号分隔的方法列表	equals,clone,hashCode,toString	指定哪个对象的方法触发一次延迟加载
defaultScriptingLanguage	一个类型别名或完全限定类名	org.apache.ibatis.scripting.xmltags.XMLLanguageDriver	指定动态 SQL 生成的默认语言
defaultEnumTypeHandler	一个类型别名或完全限定类名	org.apache.ibatis.type.EnumTypeHandler	指定 Enum 使用的默认 TypeHandler
callSettersOnNulls	true、false	false	指定当结果集中值为 null 的时候是否调用映射对象的 setter（map 对象时为 put）方法，这在依赖于 Map.keySet() 或 null 值初始化的时候比较有用。注意基本类型（int、boolean 等）是不能设置成 null 的
returnInstanceForEmptyRow	true，false	false	当返回行的所有列都是空时，MyBatis默认返回 null。当开启这个设置时，MyBatis会返回一个空实例。请注意，它也适用于嵌套的结果集（如集合或关联）
logPrefix	任何字符串	未设置	指定 MyBatis 增加到日志名称的前缀
logImpl	SLF4J，LOG4J，LOG4J2，JDK_LOGGING，COMMONS_LOGGING，STDOUT_LOGGING，NO_LOGGING	未设置	指定 MyBatis 所用日志的具体实现，未指定时将自动查找
proxyFactory	CGLIB，JAVASSIST	JAVASSIST	指定 Mybatis 创建具有延迟加载能力的对象所用到的代理工具
vfsImpl	自定义 VFS 的实现的类全限定名，以逗号分隔	未设置	指定 VFS 的实现
useActualParamName	true，false	true	允许使用方法签名中的名称作为语句参数名称。为了使用该特性，你的项目必须采用 Java 8 编译，并且加上 -parameters 选项
configurationFactory	类型别名或者全类名	未设置	指定一个提供 Configuration 实例的类。这个被返回的 Configuration 实例用来加载被反序列化对象的延迟加载属性值。这个类必须包含一个签名为static Configuration getConfiguration() 的方法

这个看起来确实很多，但是我们后续会慢慢涉及到其中的一些。

类型别名（typeAliases）

typeAliases标签就是为Java类型设置一个短名字，它只和XML配置相关，它的出现就是为了减少类的完全限定名的冗余。

比如我们之前每次在持久层接口对应的xml文件中的参数值或者返回值类型，如果为自定义的JavaBean，我们都需要加上全限定类名：

<select id="getUserList" resultType="com.ara.pojo.User">
    select * from user;
</select>

<insert id="addUser" parameterType="com.ara.pojo.User">
    insert into user (name, password) values (#{name},#{password});
</insert>

...

我们每次写resultType或者parameterType都会写这么长一串，感觉十分的庞大冗余，而且意义也不大，所以Mybatis提供了typeAliases标签，让我们为其取别名。

<!--  起别名使用的标签，减少参数类型和结果集类型的冗余  -->
<typeAliases>
    <!--  来设置具体的类型及其别名  -->
    <!--  type:需要设置的全限定类名  -->
    <!--  alias:分配的别名  -->
    <typeAlias type="com.ara.pojo.User" alias="User" />

    <!--  直接指定一个包  -->
    <!--  name:指定的包名，Mybatis会在该包下搜索需要的JavaBean  -->
    <package name="com.ara.pojo" />
</typeAliases>

通过直接指定包名起别名的方式，没有在该包下JavaBean的类上指定@Alias("别名")的时候，会默认使用JavaBean的首字母小写的非限定类名来作为它的别名，当然我们也可以直接在类上加注解来指定：

@Alias("user")
public class User {
    ...
}

如下为Java中的一些类型别名，它们都是不区分大小写的，注意对基本类型名称重复采取的特殊命名风格。

别名	映射的Java类型
_byte	byte
_long	long
_short	short
_int，_integer	int
_double	double
_float	float
_boolean	boolean
string	String
byte	Byte
long	Long
short	Short
int，integer	Integer
double	Double
float	Float
boolean	Boolean
date	Date
decimal，bigdecimal	BigDecimal
object	Object
map	Map
hashmap	HashMap
list	List
arraylist	ArrayList
collection	Collection
iterator	Iterator

环境配置（environments）

Mybatis可以配置多套数据库的使用环境，这种机制十分有助于将SQL映射应用于多种数据库之中。

虽然可以配置多个数据环境，但是每个SqlSessionFactory实例只能选择一种数据库环境。所以我们的项目中存在几个数据库，就需要几个SqlSessionFactory实例对象。

可以通过下面的方法在创建SqlSessionFactory实例对象的时候指定数据环境。

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

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

当我们没有配置数据指定环境的时候，会默认加载Mybatis配置文件中指定的默认数据源。

<!--  设置数据源环境  -->
<!--  default:指定默认的数据源id  -->
<environments default="mysql">
    <!--  设置一个数据源  -->
    <!--  id:为该数据源指定唯一标识Id  -->
    <environment id="mysql">
        <!--  配置事务管理  -->
        <!--  type:声明事务管理类型，其值有JDBC和MANAGED两种，一般常使用JDBC  -->
            <!--  JDBC:这个配置就是直接使用了JDBC的提交和回滚设置，它依赖于从数据源得到的连接来管理事务作用域  -->
            <!--  MANAGED:这个配置几乎没做什么。它从来不提交或回滚一个连接，而是让容器来管理事务的整个生命周期。默认情况下它会关闭连接，然而一些容器并不希望这样，因此需要将closeConnection属性设置为false来阻止它默认的关闭行为  -->
        <transactionManager type="JDBC"/>
        <!--  配置数据源  -->
        <!--  type:配置数据源的类型，其值有UNPOOLED POOLED和JNDI  -->
            <!--  UNPOOLED:表示不使用数据库连接池，每次执行SQL时打开连接，执行完毕之后关闭连接  -->
            <!--  POOLED:表示使用数据库连接池，将连接对象放入连接池，使用时取出，用完后放回，大大提高了SQL的执行效率  -->
            <!--  JNDI:这个数据源的实现是为了能在如 EJB 或应用服务器这类容器中使用，容器可以集中或在外部配置数据源，然后放置一个JNDI上下文的引用  -->
        <dataSource type="POOLED">
            <!--  为该数据源设置参数  -->
                <!--  name:设置的属性名  -->
                <!--  value:对应的属性值  -->
            <property name="" value=""/>           
        </dataSource>
    </environment>
</environments>

对于不同的数据源，设置的参数也有所差异：

UNPOOLED：存在如下属性
- driver：这是 JDBC 驱动的 Java 类的完全限定名
- url：这是数据库的JDBC URL地址
- username：登录数据库的用户名
- password：登录数据库的密码
- defaultTransactionIsolationLevel：默认的连接事务隔离级别
- defaultNetworkTimeout：默认网络超时时间，毫秒值
POOLED：在上面UNPOOLED的属性基础上还存在以下属性：
- poolMaximumActiveConnections：在任意时间可以存在的活动（也就是正在使用）连接数量，默认值：10
- poolMaximumIdleConnections：任意时间可能存在的空闲连接数
- poolMaximumCheckoutTime：在被强制返回之前，池中连接被检出（checked out）时间，默认值：20000 毫秒（即 20 秒）
- poolTimeToWait：这是一个底层设置，如果获取连接花费了相当长的时间，连接池会打印状态日志并重新尝试获取一个连接（避免在误配置的情况下一直安静的失败），默认值：20000 毫秒（即 20 秒）
- poolMaximumLocalBadConnectionTolerance：这是一个关于坏连接容忍度的底层设置，作用于每一个尝试从缓存池获取连接的线程。如果这个线程获取到的是一个坏的连接，那么这个数据源允许这个线程尝试重新获取一个新的连接，但是这个重新尝试的次数不应该超过 poolMaximumIdleConnections 与 poolMaximumLocalBadConnectionTolerance 之和。默认值：3 （新增于 3.4.5）
- poolPingQuery：发送到数据库的侦测查询，用来检验连接是否正常工作并准备接受请求。默认是“NO PING QUERY SET”，这会导致多数数据库驱动失败时带有一个恰当的错误消息
- poolPingEnabled：是否启用侦测查询。若开启，需要设置 poolPingQuery 属性为一个可执行的 SQL 语句（最好是一个速度非常快的 SQL 语句），默认值：false
- poolPingConnectionsNotUsedFor：配置 poolPingQuery 的频率。可以被设置为和数据库连接超时时间一样，来避免不必要的侦测，默认值：0（即所有连接每一时刻都被侦测 — 当然仅当 poolPingEnabled 为 true 时适用）
JNDI：这种数据源配置只需要两个属性
- initial_context：这个属性用来在 InitialContext 中寻找上下文（即，initialContext.lookup(initial_context)）。这是个可选属性，如果忽略，那么将会直接从 InitialContext 中寻找 data_source 属性
- data_source：这是引用数据源实例位置的上下文的路径

常用的几乎就是POOLED了。

映射器（mappers）

mappers标签就是用于映射我们定义的Mapper.xml文件了，就是告诉Mybatis需要到哪里找我们编写的Mapper.xml文件。
我们可以使用如下方式：

<!--  告诉Mybatis我们定义的Mapper.xml文件在哪里  -->
<mappers>
    <!--  指定资源  -->
    <!--  resource:使用相对于类路径的资源引用  -->
    <!--  url:使用完全限定资源定位符（不建议使用）  -->
    <!--  class:使用映射器接口实现类的完全限定类名  -->
    <mapper resource="com/ara/dao/UserMapper.xml" />

    <!--  指定扫描的包，将指定包中的映射器接口实现全部注册为映射器  -->
    <!--  name:指定的包名  -->
    <package name="com.ara.xxx"/>
</mappers>

当然，实际开发中还是要看业务需要，来选择合适的配置。

一眉程序猿

关注

2
点赞
踩
5

收藏

觉得还不错? 一键收藏
0
评论
Mybatis-XML配置文件的详细属性及配置

Mybatis-XML配置文件我们在使用Mybatis框架的时候，一开始就需要先把它的配置文件写好，虽然它的名字可以为任意值，但是官方建议我们使用mybatis-config.xml命名，关于该配置文件中的配置，有如下九个：属性（properties）设置（settings）类型别名（typeAliases）类型处理器（typeHandlers）对象工厂（objectFactory）...
复制链接

扫一扫