5.MyBatis 全局配置文件详解（sqlMapConfig.xml）

1.1     Mybatis的全局配置文件

SqlMapConfig.xml是mybatis的全局配置文件。它的名称可以是任意命名的。

1.1.1 配置内容

SqlMapConfig.xml的配置内容和顺序如下（顺序不能乱）：

Properties（属性）

Settings（全局参数设置）

typeAliases（类型别名）

typeHandlers（类型处理器）

objectFactory（对象工厂）

plugins（插件）

environments（环境信息集合）

         environment（单个环境信息）

                   transactionManager（事物）

                   dataSource（数据源）

mappers（映射器）

 

1.1.2 内容详解

1.1.2.1  Properties

SqlMapConfig.xml文件中可以引用java属性文件中的配置信息

 

Java配置信息如下：

 

db.driver=com.mysql.jdbc.Driver

db.url=jdbc:mysql://localhost:3306/mybatis?useUnicode=true&characterEncoding=utf8

db.username=root

db.password=root

 

SqlMapConfig.xml使用properties标签后，如下所示：

<!-- 通过properties标签，读取java配置文件的内容 -->

<properties resource="db.properties"/>

 

<!-- 配置mybatis的环境信息 -->

<environments default="development">

    <environment id="development">

       <!-- 配置JDBC事务控制，由mybatis进行管理 -->

       <transactionManager type="JDBC"></transactionManager>

       <!-- 配置数据源，采用dbcp连接池 -->

       <dataSource type="POOLED">

           <property name="driver"value="${db.driver}"/>

           <property name="url"value="${db.url}"/>

           <property name="username"value="${db.username}"/>

           <property name="password"value="${db.password}"/>

       </dataSource>

    </environment>

</environments>

   

 

使用${}，可以引用已经加载的java配置文件中的信息

 

注意：mybatis将按照下面的顺序加载属性：

• Properties标签体内定义的属性首先被读取

• Properties引用的属性会被读取，如果发现上面已经有同名的属性了，那后面会覆盖前面的值

• parameterType接收的值会最后被读取，如果发现上面已经有同名的属性了，那后面会覆盖前面的值

 

所以说，mybatis读取属性的顺序由高到低分别是：parameterType接收的属性值、properties引用的属性、properties标签内定义的属性。

settings设置

 

    这是MyBatis 修改操作运行过程细节的重要的步骤。下方这个表格描述了这些设置项、含义和默认值。

 

 

设置项	描述	允许值	默认值
cacheEnabled	对在此配置文件下的所有cache  进行全局性开/关设置。	true | false	true
lazyLoadingEnabled	全局性设置懒加载。如果设为‘false’，则所有相关联的都会被初始化加载。	true | false	true
aggressiveLazyLoading	当设置为‘true’的时候，懒加载的对象可能被任何懒属性全部加载。否则，每个属性都按需加载。	true | false	true
multipleResultSetsEnabled	允许和不允许单条语句返回多个数据集（取决于驱动需求）	true | false	true
useColumnLabel	使用列标签代替列名称。不同的驱动器有不同的作法。参考一下驱动器文档，或者用这两个不同的选项进行测试一下。	true | false	true
useGeneratedKeys	允许JDBC 生成主键。需要驱动器支持。如果设为了true，这个设置将强制使用被生成的主键，有一些驱动器不兼容不过仍然可以执行。	true | false	false
autoMappingBehavior	指定MyBatis 是否并且如何来自动映射数据表字段与对象的属性。PARTIAL将只自动映射简单的，没有嵌套的结果。FULL 将自动映射所有复杂的结果。	NONE, PARTIAL, FULL	PARTIAL
defaultExecutorType	配置和设定执行器，SIMPLE  执行器执行其它语句。REUSE  执行器可能重复使用prepared  statements 语句，BATCH执行器可以重复执行语句和批量更新。	SIMPLE REUSE BATCH	SIMPLE
defaultStatementTimeout	设置一个时限，以决定让驱动器等待数据库回应的多长时间为超时	正整数	Not Set (null)

 

 

例如：

 

 

    Xml代码  

1.     <settings>  

2.         <setting name="cacheEnabled" value="true" />  

3.         <setting name="lazyLoadingEnabled" value="true" />  

4.         <setting name="multipleResultSetsEnabled" value="true" />  

5.         <setting name="useColumnLabel" value="true" />  

6.         <setting name="useGeneratedKeys" value="false" />  

7.         <setting name="enhancementEnabled" value="false" />  

8.         <setting name="defaultExecutorType" value="SIMPLE" />  

9.     </settings>  

typeAliases类型别名

 

 

类型别名是Java 类型的简称。

它仅仅只是关联到XML 配置，简写冗长的JAVA 类名。例如：

 

 

 

Xml代码  

1.     <typeAliases>  

2.         <typeAlias alias="UserEntity" type="com.manager.data.model.UserEntity" />  

3.         <typeAlias alias="StudentEntity" type="com.manager.data.model.StudentEntity" />  

4.         <typeAlias alias="ClassEntity" type="com.manager.data.model.ClassEntity" />  

5.     </typeAliases>  

 

 

 

    使用这个配置，“StudentEntity”就能在任何地方代替“com.manager.data.model.StudentEntity”被使用。

 

    对于普通的Java类型，有许多内建的类型别名。它们都是大小写不敏感的，由于重载的名字，要注意原生类型的特殊处理。

 

 

 

别名	映射的类型
_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类型句柄

 

 

无论是MyBatis在预处理语句中设置一个参数，还是从结果集中取出一个值时，类型处理器被用来将获取的值以合适的方式转换成Java类型。下面这个表格描述了默认的类型处理器。

 

 

 

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

 

 

 

你可以重写类型处理器或创建你自己的类型处理器来处理不支持的或非标准的类型。要这样做的话，简单实现TypeHandler接口（org.mybatis.type），然后映射新的类型处理器类到Java类型，还有可选的一个JDBC类型。然后再typeHandlers中添加这个类型处理器。

新定义的类型处理器将会覆盖已经存在的处理Java的String类型属性和VARCHAR参数及结果的类型处理器。要注意MyBatis不会审视数据库元信息来决定使用哪种类型，所以你必须在参数和结果映射中指定那是VARCHAR类型的字段，来绑定到正确的类型处理器上。这是因为MyBatis直到语句被执行都不知道数据类型的这个现实导致的。

 

 

 

Java代码  

1. public class LimingStringTypeHandler implements TypeHandler {  

2.   

3.     @Override  

4.     public void setParameter(PreparedStatement ps, int i, Object parameter, JdbcType jdbcType) throws SQLException {  

5.         System.out.println("setParameter - parameter: " + ((String) parameter) + ", jdbcType: " + jdbcType.TYPE_CODE);  

6.         ps.setString(i, ((String) parameter));  

7.     }  

8.   

9.     @Override  

10.     public Object getResult(ResultSet rs, String columnName) throws SQLException {  

11.         System.out.println("getResult - columnName: " + columnName);  

12.         return rs.getString(columnName);  

13.     }  

14.   

15.     @Override  

16.     public Object getResult(CallableStatement cs, int columnIndex) throws SQLException {  

17.         System.out.println("getResult - columnIndex: " + columnIndex);  

18.         return cs.getString(columnIndex);  

19.     }  

20. }  

 

 

 

在配置文件的typeHandlers中添加typeHandler标签。

 

 

Xml代码  

1. <typeHandlers>  

2.     <typeHandler javaType="String" jdbcType="VARCHAR" handler="liming.student.manager.type.LimingStringTypeHandler"/>  

3. </typeHandlers> 

 mappers

映射器的配置有四种方式

1      <mapper resource=’’/>

使用相对于类路径的资源

如：<mapper resource="sqlmap/User.xml" />

 

2      <mapper url=’’/>

使用完全限定路径

如：<mapperurl="file:///D:\workspace_spingmvc\mybatis_01\config\sqlmap\User.xml"/>

3      <mapper class=’’/>

使用mapper接口的全限定名

如：<mapperclass="cn.itcast.mybatis.mapper.UserMapper"/>

 

注意：此种方法要求mapper接口和mapper映射文件要名称相同，且放到同一个目录下；

4      <package name=’’/>（推荐）

注册指定包下的所有映射文件

如：<package name="cn.itcast.mybatis.mapper"/>

注意：此种方法要求mapper接口和mapper映射文件要名称相同，且放到同一个目录下；