MyBatis主配置文件（转载）

原文地址：http://limingnihao.iteye.com/blog/1060764

其中高亮字体是我的理解。

 

在定义sqlSessionFactory时需要指定MyBatis主配置文件：

   

Xml代码  

1. <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">  
2.     <property name="configLocation" value="classpath:mybatis-config.xml" />  
3.     <property name="dataSource" ref="dataSource" />  
4. </bean>  

   

 configLocation：mybatis-config.xml这个配置其实是可以没有的，如果不配置，那么一切都可以使用默认设置。包括mappers。因为sqlSessionFactory可以配置一个"mapperLocations"属性，用来定义去哪里找mapper的xml配置。

   

MyBatis配置文件中大标签configuration下子标签包括：

configuration

|--- properties

|--- settings

|--- typeAliases

|--- typeHandlers

|--- objectFactory

|--- plugins

|--- environments

|--- |--- environment

|--- |--- |--- transactionManager

|--- |--- |__ dataSource

|__ mappers

   

   

   

4.1 properties属性

   

   

    properties和java的.properties的配置文件有关。配置properties的resource指定.properties的路径，然后再在properties标签下配置property的name和value，则可以替换.properties文件中相应属性值。

   

   

   

Xml代码  

1.     <!-- 属性替换 -->  
2. <properties resource="mysql.properties">  
3.     <property name="jdbc.driverClassName" value="com.mysql.jdbc.Driver"/>  
4.     <property name="jdbc.url" value="jdbc:mysql://localhost:3306/student_manager"/>  
5.     <property name="username" value="root"/>  
6.     <property name="password" value="limingnihao"/>  
7. </properties>  

   

 properties可以用来配置数据源的，因为在environments 中是可以配置dataSource和transactionManager的，但是数据源一般都是在sqlSessionFactory中通过dataSource属性指定的一个bean，这两个地方都可以配置datasource，我猜想是，如果使用了spring来管理，可是使用spring来管理dataSource和transaction，所以可以不配置mybatis-config.xml中的environments。但是如果是采用的非spring，那么就可以在mybatis-config.xml中配置数据源和事务机制了（其实非spring也可以通过java代码自己set，只不过非spring一般不会这么做吧）。

 

4.2 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>  

   

   

   

4.3 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

   

 别名可以用在mapper xml的parameterType和resultType中。

   

4.4 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直到语句被执行都不知道数据类型的这个现实导致的。

   

 其中：

ObjectTypeHandler

Any

其他或未指定类型

是所有未配置的对象的转换逻辑，如一个Person对象，就要走ObjectTypeHandler。它的处理应该是根据Person的各个属性的get set方法，然后去转换select结果集为一个对象（作为resultType），或者将这个对象的属性去处理sql的参数（作为parameterType）。

   

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>  

   

   

   

   

4.5 ObjectFactory对象工厂

   

   

每次MyBatis 为结果对象创建一个新实例，都会用到ObjectFactory。默认的ObjectFactory 与使用目标类的构造函数创建一个实例毫无区别，如果有已经映射的参数，那也可能使用带参数的构造函数。

如果你重写ObjectFactory 的默认操作，你可以通过继承org.apache.ibatis.reflection.factory.DefaultObjectFactory创建一下你自己的。

ObjectFactory接口很简单。它包含两个创建用的方法，一个是处理默认构造方法的，另外一个是处理带参数构造方法的。最终，setProperties方法可以被用来配置ObjectFactory。在初始化你的ObjectFactory实例后，objectFactory元素体中定义的属性会被传递给setProperties方法。

   

   

   

   

Java代码  

1. public class LimingObjectFactory extends DefaultObjectFactory {  
2.     
3.     private static final long serialVersionUID = -399284318168302833L;  
4.     
5.     @Override  
6.     public Object create(Class type) {  
7.         return super.create(type);  
8.     }  
9.     
10.     @Override  
11.     public Object create(Class type, List<Class> constructorArgTypes, List<Object> constructorArgs) {  
12.         System.out.println("create - type: " + type.toString());  
13.         return super.create(type, constructorArgTypes, constructorArgs);  
14.     }  
15.     
16.     @Override  
17.     public void setProperties(Properties properties) {  
18.         System.out.println("setProperties - properties: " + properties.toString() + ", someProperty: " + properties.getProperty("someProperty"));  
19.         super.setProperties(properties);  
20.     }  
21.     
22. }  

   

   

   

配置文件中添加objectFactory标签

   

   

Xml代码  

1. <objectFactory type="liming.student.manager.configuration.LimingObjectFactory">  
2.     <property name="someProperty" value="100"/>  
3. </objectFactory>  

   

   

   

4.6 plugins插件

   

   

MyBatis允许你在某一点拦截已映射语句执行的调用。默认情况下，MyBatis允许使用插件来拦截方法调用：

   

• Executor(update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
• ParameterHandler(getParameterObject, setParameters)
• ResultSetHandler(handleResultSets, handleOutputParameters)
• StatementHandler(prepare, parameterize, batch, update, query)

   

这些类中方法的详情可以通过查看每个方法的签名来发现，而且它们的源代码在MyBatis的发行包中有。你应该理解你覆盖方法的行为，假设你所做的要比监视调用要多。如果你尝试修改或覆盖一个给定的方法，你可能会打破MyBatis的核心。这是低层次的类和方法，要谨慎使用插件。

使用插件是它们提供的非常简单的力量。简单实现拦截器接口，要确定你想拦截的指定签名。

   

   

   

4.7 environments环境

MyBatis 可以配置多个环境。这可以帮助你SQL 映射对应多种数据库等。

   

   

   

4.8 mappers映射器

这里是告诉MyBatis 去哪寻找映射SQL 的语句。可以使用类路径中的资源引用，或者使用字符，输入确切的URL 引用。

例如：

   

   

Xml代码  

1. <mappers>  
2.     <mapper resource="com/manager/data/maps/UserMapper.xml" />  
3.     <mapper resource="com/manager/data/maps/StudentMapper.xml" />  
4.     <mapper resource="com/manager/data/maps/ClassMapper.xml" />  
5. </mappers>  

这个可以不再这里一个一个的配置，因为sqlSessionFactory可以配置一个"mapperLocations"属性，用来定义去哪里找mapper的xml配置。