MyBatis配置文件

Posted 2020-10-14 博了个客。

文档顶层结构：

configuration 配置

          properties 属性

          settings 设置

          typeAliases 类型命名

          typeHandlers 类型处理器

          objectFactory 对象工厂

          plugins 插件

          environments 环境

                 environment 环境变量

                        transactionManager 事务管理器

                         dataSource 数据源

          databaseIdProvider 数据库厂商标识

          transactionManager 事务管理器

          mappers 映射器

注意：这些元素在mybatis的xml配置文件中，顺序是不可以颠倒的，否则无法构建SqlSessionFactoryBuilder实例，

也就无法构建SqlSessionFactory工厂实例，更无法构建SqlSession操作数据库命令SQL对象实例。

 

回顾一下mybatis的步骤：

1）核心配置文件配置

2）pojo模型创建

3）映射文件配置

4）获取SqlSessionFactory

5）获取SqlSession

6）CRUD操作

7）事务操作

8）关闭SqlSession

 

mybatis的基本操作在这里：

 mybatis初体验（一）

 

这篇文章总结一下核心配置文件mybatis-config.xml的配置方法。

初体验中的mybatis-config.xml的配置：

<?xml version="1.0" encoding="UTF-8" ?>  
<!DOCTYPE configuration  
  PUBLIC "-//mybatis.org//DTD Config 3.0//EN"  
  "http://mybatis.org/dtd/mybatis-3-config.dtd">  
<configuration>  
    <!-- 对事务的管理和连接池的配置 -->  
    <environments default="development">  
        <environment id="development">  
            <transactionManager type="JDBC" />  
            <dataSource type="POOLED">  
                <property name="driver" value="oracle.jdbc.driver.OracleDriver" />  
                <property name="url" value="jdbc:oracle:thin:@localhost:1521:orcl" />  
                <property name="username" value="ibatis" />  
                <property name="password" value="ibatis" />  
            </dataSource>  
        </environment>  
    </environments>  
      
    <!-- mapping 文件路径配置 -->  
    <mappers>  
        <mapper resource="com/yu/res/UserMapper.xml" />  
    </mappers>  
</configuration>

Properties

由上面的配置可以看出，我们的数据库信息是直接写到了配置里

而一般情况下，对于这种配置信息，一般我们都会把它放到properties资源文件中。

1.创建一个资源文件jdbc.properties：

jdbc.driverClassName=oracle.jdbc.driver.OracleDriver
jdbc.url=jdbc:oracle:thin:@localhost:1521:orcl
jdbc.username=mybatis  
jdbc.password=mybatis

2.mybatis-config.xml中引入

<properties resource="jdbc.properties" />

当然也可以在<properties/>标签中定义属性：

<properties resource="jdbc.properties">
	<property name="jdbc.driverClassName" value="oracle.jdbc.driver.OracleDriver"/>
</properties>

3.使用properties文件里的属性

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

 

说下这些配置的加载顺序：

.在 properties 元素体内指定的属性首先被读取。
.从类路径下资源或 properties 元素的 url 属性中加载的属性第二被读取,它会 覆盖已经存在的完全一样的属性。
.作为方法参数传递的属性最后被读取, 它也会覆盖任一已经存在的完全一样的 属性,这些属性可能是从 properties 元素体内和资源/url 属性中加载的。

引用自：http://mybatis.github.io/mybatis-3/zh/configuration.html

 

所以，属性的优先级为：方法直接传递参数 > 通过resource、url引用的资源 > properties元素体内定义

 

Settings

setting设置，关系到mybatis的主要设置，关系到mybatis运行时的行为方式。

配置方式：

<settings>  
        <setting name="cacheEnabled" value="true" />  
        <setting name="lazyLoadingEnabled" value="true" />  
        <setting name="multipleResultSetsEnabled" value="true" />  
        <setting name="useColumnLabel" value="true" />  
        <setting name="useGeneratedKeys" value="false" />  
        <setting name="autoMappingBehavior" value="PARTIAL" />  
        <setting name="defaultExecutorType" value="SIMPLE" />  
        <setting name="defaultStatementTimeout" value="25" />  
        <setting name="safeRowBoundsEnabled" value="false" />  
        <setting name="mapUnderscoreToCamelCase" value="false" />  
        <setting name="localCacheScope" value="SESSION" />  
        <setting name="jdbcTypeForNull" value="OTHER" />  
        <setting name="lazyLoadTriggerMethods" value="equals,clone,hashCode,toString" />  
    </settings>

 

配置项说明：（从 http://mybatis.github.io/mybatis-3/zh/configuration.html copy过来的 ）

设置参数	描述	有效值	默认值
cacheEnabled	这个配置使全局的映射器启用或禁用 缓存。	true | false	true
lazyLoadingEnabled	全局启用或禁用延迟加载。当禁用时, 所有关联对象都会即时加载。 This value can be superseded for an specific relation by using the fetchType attribute on it.	true | false	false
aggressiveLazyLoading	当启用时, 有延迟加载属性的对象在被 调用时将会完全加载任意属性。否则, 每种属性将会按需要加载。	true | false	true
multipleResultSetsEnabled	允许或不允许多种结果集从一个单独 的语句中返回(需要适合的驱动)	true | false	true
useColumnLabel	使用列标签代替列名。 不同的驱动在这 方便表现不同。 参考驱动文档或充分测 试两种方法来决定所使用的驱动。	true | false	true
useGeneratedKeys	允许 JDBC 支持生成的键。 需要适合的 驱动。 如果设置为 true 则这个设置强制 生成的键被使用, 尽管一些驱动拒绝兼 容但仍然有效(比如 Derby)	true | false	False
autoMappingBehavior	指定 MyBatis 如何自动映射列到字段/ 属性。PARTIAL 只会自动映射简单, 没有嵌套的结果。FULL 会自动映射任 意复杂的结果(嵌套的或其他情况) 。	NONE, PARTIAL, FULL	PARTIAL
defaultExecutorType	配置默认的执行器。SIMPLE 执行器没 有什么特别之处。REUSE 执行器重用 预处理语句。BATCH 执行器重用语句 和批量更新	SIMPLE REUSE BATCH	SIMPLE
defaultStatementTimeout	设置超时时间, 它决定驱动等待一个数 据库响应的时间。	Any positive integer	Not Set (null)
safeRowBoundsEnabled	Allows using RowBounds on nested statements.	true | false	False
mapUnderscoreToCamelCase	Enables automatic mapping from classic database column names A_COLUMN to camel case classic Java property names aColumn.	true | false	False
localCacheScope	MyBatis uses local cache to prevent circular references and speed up repeated nested queries. By default (SESSION) all queries executed during a session are cached. If localCacheScope=STATEMENT local session will be used just for statement execution, no data will be shared between two different calls to the same SqlSession.	SESSION | STATEMENT	SESSION
jdbcTypeForNull	Specifies the JDBC type for null values when no specific JDBC type was provided for the parameter. Some drivers require specifying the column JDBC type but others work with generic values like NULL, VARCHAR or OTHER.	JdbcType enumeration. Most common are: NULL, VARCHAR and OTHER	OTHER
lazyLoadTriggerMethods	Specifies which Object‘s methods trigger a lazy load	A method name list separated by commas	equals,clone,hashCode,toString
defaultScriptingLanguage	Specifies the language used by default for dynamic SQL generation.	A type alias or fully qualified class name.	org.apache.ibatis.scripting.xmltags.XMLDynamicLanguageDriver
callSettersOnNulls	当结果集中含有Null值时是否执行映射对象的setter或者Map对象的put方法。此设置对于原始类型如int,boolean等无效。	true | false	false
logPrefix	Specifies the prefix string that MyBatis will add to the logger names.	Any String	Not set
logImpl	Specifies which logging implementation MyBatis should use. If this setting is not present logging implementation will be autodiscovered.	SLF4J | LOG4J | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING	Not set
proxyFactory	Specifies the proxy tool that MyBatis will use for creating lazy loading capable objects.	CGLIB | JAVASSIST	CGLIB

 

typeAliases

 

类型别名。

给java类型取一个别名，方便在核心配置、映射配置中来使用这个java类型。

 

在 mybatis初体验（一） 中的UserMapper.xml配置中，有这样的配置信息：

<select id="findUserById" resultType="com.yu.model.User" parameterType="long">  
        select * from t_user where id = #{id}
</select>

可以看到resultType属性的值为com.yu.model.User，表示这个查询返回的类型为com.yu.model.User类型。

 

如果有很多种类型的话，每次都得把类型的全路径写上，感觉就很费事。

所以就可以用mybatis提供的typeAliases来进行别名配置。

 

在核心配置文件中加上配置：

<typeAliases>  
      <typeAlias type="com.yu.model.User" alias="User" />
      <typeAlias type="com.yu.model.Org" alias="Org"/>
</typeAliases>

 

然后修改UserMapper.xml的配置：

<select id="findUserById" resultType="User" parameterType="long">  
        select * from t_user where id = #{id}
</select>

 

这样就简便多了。

 

当然，这是对于我们自定义的类型，或者其他类型，用这种设置别名的方式。

其实mybatis给我们提供了很多内建的类型别名，使我们不用在typeAliases中指定，就可以直接使用，下面是mybatis中内建的别名：

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

 

typeHandlers

 

类型处理器。

用途：

1）获取数据库的值，以合适的方式转变为对应的java类型

2）将java类型，以合适的方式转化为数据库的保存类型

 

mybatis中默认的类型处理器：

类型处理器	Java 类型	JDBC 类型
BooleanTypeHandler	java.lang.Boolean, boolean	任何兼容的布尔值
ByteTypeHandler	java.lang.Byte, byte	任何兼容的数字或字节类型
ShortTypeHandler	java.lang.Short, short	任何兼容的数字或短整型
IntegerTypeHandler	java.lang.Integer, int	任何兼容的数字和整型
LongTypeHandler	java.lang.Long, long	任何兼容的数字或长整型
FloatTypeHandler	java.lang.Float, float	任何兼容的数字或单精度浮点型
DoubleTypeHandler	java.lang.Double, double	任何兼容的数字或双精度浮点型
BigDecimalTypeHandler	java.math.BigDecimal	任何兼容的数字或十进制小数类型
StringTypeHandler	java.lang.String	CHAR 和 VARCHAR 类型
ClobTypeHandler	java.lang.String	CLOB 和 LONGVARCHAR 类型
NStringTypeHandler	java.lang.String	NVARCHAR 和 NCHAR 类型
NClobTypeHandler	java.lang.String	NCLOB 类型
ByteArrayTypeHandler	byte[]	任何兼容的字节流类型
BlobTypeHandler	byte[]	BLOB 和 LONGVARBINARY 类型
DateTypeHandler	java.util.Date	TIMESTAMP 类型
DateOnlyTypeHandler	java.util.Date	DATE 类型
TimeOnlyTypeHandler	java.util.Date	TIME 类型
SqlTimestampTypeHandler	java.sql.Timestamp	TIMESTAMP 类型
SqlDateTypeHandler	java.sql.Date	DATE 类型
SqlTimeTypeHandler	java.sql.Time	TIME 类型
ObjectTypeHandler	Any	其他或未指定类型
EnumTypeHandler	Enumeration Type	VARCHAR-任何兼容的字符串类型, 作为代码存储(而不是索引)
EnumOrdinalTypeHandler	Enumeration Type	Any compatible NUMERIC or DOUBLE, as the position is stored (not the code itself).

 

当然也可以自定义类型处理器，

比如有一个字段的值是一个逗号隔开的字符串，如果希望查询结果映射到java类型时是一个数组，而保存到数据库时又会是以逗号隔开的字符串。

这种情况需要自定义类型处理器来处理。

 

关于自定义类型处理器，会单独做一个总结。

 

mappers

 

在 mybatis初体验（一） 中的UserMapper.xml配置中，有这样的配置信息：

 <!-- mapping 文件路径配置 -->  
 <mappers>  
     <mapper resource="com/yu/res/UserMapper.xml" />  
 </mappers>

 

用于引用定义好的映射定义，告诉mybatis去哪里找我们的sql定义配置。有以下几种用法：

 

直接引用xml文件

<mappers>  
     <mapper resource="com/yu/res/UserMapper.xml" />  
</mappers>

 

通过绝对路径引用，注意在绝对路径前加上：“file:///”

<mappers>  
     <mapper url="file:///D:/workspace/mywork/MyBatis/src/com/yu/res/UserMapper.xml"/> 
</mappers>

 

引用mapper接口对象的方式：

<mappers>  
     <mapper resource="com.yu.mapper.UserMapper" />  
</mappers>

 

引用mapper接口包的方式：

<mappers>  
     <package name="com.yu.mapper"/>
</mappers>