MyBatis配置详解

在Eclipse中，将鼠标放在根节点上后，可以看到配置文件中的主要配置项，如下图所示：

这些项分别是：properties、settings、typeAliases、typeHandlers、plugins、environments、mappers。

注意：这些配置项必须按照先后顺序进行配置。

一、配置项介绍

properties：用于配置属性信息。

settings：用于配置MyBatis的运行时方式。

typeAliases：配置类型别名，可以在xml中用别名取代全限定名。

typeHandlers：配置类型处理器。

plugins：配置拦截器，用于拦截sql语句的执行。

environments：配置数据源信息、连接池、事务属性等。

mappers：配置SQL映射文件。

二、配置项详解

（1）properties

配置properties采用键值对的格式进行配置。
文件内配置properties

<property name="name1" value="value1"/>
<property name="name2" value="value2"/>
<property name="name3" value="value3"/>
    ......
<property name="nameN" value="valueN"/>

文件外配置properties
<properties resource="config.properties" />

config.properties”中的内容如下所示：

name1:value1 
name2:value2 
name3:value2 
...... 
nameN:valueN

（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)

<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="enhancementEnabled" value="false" />  
    <setting name="defaultExecutorType" value="SIMPLE" />  
</settings>

（3）typeAliases

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

<typeAliases>  
    <typeAlias alias="UserEntity" type="com.manager.data.model.UserEntity" />  
    <typeAlias alias="StudentEntity" type="com.manager.data.model.StudentEntity" />  
    <typeAlias alias="ClassEntity" type="com.manager.data.model.ClassEntity" />  
</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

（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-任何兼容的字符串类型，作为代码存储（而不是索引）。
EnumOrdinalTypeHandler	Enumeration类型	任何兼容的 NUMERIC 或 DOUBLE 类型，存储枚举的索引（而不是名称）。

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

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

public class LimingStringTypeHandler implements TypeHandler {  

    @Override  
    public void setParameter(PreparedStatement ps, int i, Object parameter, JdbcType jdbcType) throws SQLException {  
        System.out.println("setParameter - parameter: " + ((String) parameter) + ", jdbcType: " + jdbcType.TYPE_CODE);  
        ps.setString(i, ((String) parameter));  
    }  

    @Override  
    public Object getResult(ResultSet rs, String columnName) throws SQLException {  
        System.out.println("getResult - columnName: " + columnName);  
        return rs.getString(columnName);  
    }  

    @Override  
    public Object getResult(CallableStatement cs, int columnIndex) throws SQLException {  
        System.out.println("getResult - columnIndex: " + columnIndex);  
        return cs.getString(columnIndex);  
    }  
}  

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

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

（5） ObjectFactory对象工厂

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

如果你重写ObjectFactory 的默认操作，你可以通过继承org.apache.ibatis.reflection.factory.DefaultObjectFactory创建一下你自己的。
ObjectFactory接口很简单。它包含两个创建用的方法，一个是处理默认构造方法的，另外一个是处理带参数构造方法的。最终，setProperties方法可以被用来配置ObjectFactory。在初始化你的ObjectFactory实例后，objectFactory元素体中定义的属性会被传递给setProperties方法。

public class LimingObjectFactory extends DefaultObjectFactory {  

    private static final long serialVersionUID = -399284318168302833L;  

    @Override  
    public Object create(Class type) {  
        return super.create(type);  
    }  

    @Override  
    public Object create(Class type, List<Class> constructorArgTypes, List<Object> constructorArgs) {  
        System.out.println("create - type: " + type.toString());  
        return super.create(type, constructorArgTypes, constructorArgs);  
    }  

    @Override  
    public void setProperties(Properties properties) {  
        System.out.println("setProperties - properties: " + properties.toString() + ", someProperty: " + properties.getProperty("someProperty"));  
        super.setProperties(properties);  
    }  

}  

配置文件中添加objectFactory标签

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

（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的核心。这是低层次的类和方法，要谨慎使用插件。

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

（7）environments

MyBatis 可以配置成适应多种环境，这种机制有助于将 SQL 映射应用于多种数据库之中， 现实情况下有多种理由需要这么做。例如，开发、测试和生产环境需要有不同的配置；或者共享相同 Schema 的多个生产数据库， 想使用相同的 SQL 映射。许多类似的用例。

不过要记住：尽管可以配置多个环境，每个 SqlSessionFactory 实例只能选择其一。

所以，如果你想连接两个数据库，就需要创建两个 SqlSessionFactory 实例，每个数据库对应一个。而如果是三个数据库，就需要三个实例，依此类推，记起来很简单：

• 每个数据库对应一个 SqlSessionFactory 实例

为了指定创建哪种环境，只要将它作为可选的参数传递给 SqlSessionFactoryBuilder 即可。可以接受环境配置的两个方法签名是：

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

如果忽略了环境参数，那么默认环境将会被加载，如下所示：

SqlSessionFactory factory = sqlSessionFactoryBuilder.build(reader);
SqlSessionFactory factory = sqlSessionFactoryBuilder.build(reader,properties);

环境元素定义了如何配置环境。

<environments default="development">
  <environment id="development">
    <transactionManager type="JDBC">
      <property name="..." value="..."/>
    </transactionManager>
    <dataSource type="POOLED">
      <property name="driver" value="${driver}"/>
      <property name="url" value="${url}"/>
      <property name="username" value="${username}"/>
      <property name="password" value="${password}"/>
    </dataSource>
  </environment>
</environments>

注意这里的关键点:

• 默认的环境 ID（比如:default=”development”）。
• 每个 environment 元素定义的环境 ID（比如:id=”development”）。
• 事务管理器的配置（比如:type=”JDBC”）。
• 数据源的配置（比如:type=”POOLED”）。

默认的环境和环境 ID 是一目了然的。随你怎么命名，只要保证默认环境要匹配其中一个环境ID。

事务管理器（transactionManager）

在 MyBatis 中有两种类型的事务管理器（也就是 type=”[JDBC|MANAGED]”）：

• JDBC – 这个配置就是直接使用了 JDBC 的提交和回滚设置，它依赖于从数据源得到的连接来管理事务范围。
• MANAGED – 这个配置几乎没做什么。它从来不提交或回滚一个连接，而是让容器来管理事务的整个生命周期（比如 JEE
  应用服务器的上下文）。 默认情况下它会关闭连接，然而一些容器并不希望这样，因此需要将 closeConnection 属性设置为
  false 来阻止它默认的关闭行为。例如:

<transactionManager type="MANAGED">
  <property name="closeConnection" value="false"/>
</transactionManager>

NOTE：如果你正在使用 Spring + MyBatis，则没有必要配置事务管理器， 因为 Spring 模块会使用自带的管理器来覆盖前面的配置。

数据源（dataSource）

dataSource 元素使用标准的 JDBC 数据源接口来配置 JDBC 连接对象的资源。

• 许多 MyBatis 的应用程序将会按示例中的例子来配置数据源。然而它并不是必须的。要知道为了方便使用延迟加载，数据源才是必须的。

有三种内建的数据源类型（也就是 type=”[UNPOOLED|POOLED|JNDI]”）：

UNPOOLED– 这个数据源的实现只是每次被请求时打开和关闭连接。虽然一点慢，它对在及时可用连接方面没有性能要求的简单应用程序是一个很好的选择。 不同的数据库在这方面表现也是不一样的，所以对某些数据库来说使用连接池并不重要，这个配置也是理想的。UNPOOLED 类型的数据源仅仅需要配置以下 5 种属性：

• driver – 这是 JDBC 驱动的 Java 类的完全限定名（并不是JDBC驱动中可能包含的数据源类）。
• url – 这是数据库的 JDBC URL 地址。
• username – 登录数据库的用户名。
• password – 登录数据库的密码。
• defaultTransactionIsolationLevel – 默认的连接事务隔离级别。

作为可选项，你也可以传递属性给数据库驱动。要这样做，属性的前缀为“driver.”，例如：

• driver.encoding=UTF8

这将通过DriverManager.getConnection(url,driverProperties)方法传递值为 UTF8 的 encoding 属性给数据库驱动。

POOLED– 这种数据源的实现利用“池”的概念将 JDBC 连接对象组织起来，避免了创建新的连接实例时所必需的初始化和认证时间。 这是一种使得并发 Web 应用快速响应请求的流行处理方式。

除了上述提到 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 中查找。

和其他数据源配置类似，可以通过添加前缀“env.”直接把属性传递给初始上下文。比如：

• env.encoding=UTF8

这就会在初始上下文（InitialContext）实例化时往它的构造方法传递值为 UTF8 的 encoding 属性。

（8）mappers

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

<mappers>  
    <mapper resource="com.manager.data.maps.UserMapper.xml" />  
    <mapper resource="com.manager.data.maps.StudentMapper.xml" />  
    <mapper resource="com.manager.data.maps.ClassMapper.xml" />  
</mappers>  

<!-- Register all interfaces in a package as mappers -->
<mappers>
  <package name="com.manager.data.maps"/>
</mappers>

---

下面是mybatis的配置文件：

<?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> 
    <!-- 加载属性文件 -->
    <properties resource="config/db.properties">
        <!--properties中还可以配置一些属性名和属性值  -->
        <!-- <property name="jdbc.driver" value=""/> -->
    </properties>
    <!-- 全局配置参数，需要时再设置，缓存等 -->
    <!-- <settings>
    </settings> -->

    <typeAliases>
        <!-- 针对单个别名定义  type：类型的路径   alias：别名 -->
        <!-- <typeAlias type="com.neuedu.pojo.User" alias="user"/> -->
        <!-- 批量别名定义 
        指定包名，mybatis自动扫描包中的po类，自动定义别名，别名就是类名（首字母大写或小写都可以）
        -->
        <package name="com.bear.pojo"/>
    </typeAliases>
    <!-- 和spring整合后 environments配置将废除-->
    <environments default="development"> 
        <environment id="development"> 
            <transactionManager type="JDBC"/> 
            <dataSource type="POOLED"> 
                <property name="driver" value="${jdbc.driver}"/> 
                <property name="url" value="${jdbc.url}"/> 
                <property name="username" value="${jdbc.username}"/> 
                <property name="password" value="${jdbc.password}"/> 
            </dataSource> 
        </environment> 
    </environments> 
    <mappers>
        <!--通过mapper接口加载单个 映射文件前提是：使用的是mapper代理方法-->
        <mapper class="com.bear.mapper.EmpMapper"/>

        <!--批量加载mapper,指定mapper接口的包名，mybatis自动扫描包下边所有mapper接口进行加载,
            前提是：使用的是mapper代理方法-->
        <!-- <package name="com.neuedu.mapper"/> -->
    </mappers> 
</configuration>  

转载：http://www.mybatis.org/mybatis-3/zh/configuration.html#properties
http://limingnihao.iteye.com/blog/1060764
http://my.oschina.net/wlb/blog/287777