三、Mybatis3的XML配置文件介绍

mybatis-config.xml文档的层级结构如下:

一、properties

这些是外部化的,可替代的属性,这些属性也可以配置在典型的 Java属性配置文件中,或者通过 properties元素的子元素来传递。例如:

我们有一个config.properties属性文件：

driver=org.postgresql.Driverurl = jdbc:postgresql://127.0.0.1:5432/test#username = postgres#password = postgres

这里我们假设只配置driver和url,username和password我们在mybatis-config.xml文件中用properties配置，如下：

<!-- properties可以先关联config.properties属性文件，然后可以添加属性，也可以直接设置属性 --><properties resource="config.properties"><property name="username" value="postgres" /><property name="password" value="postgres" /></properties><environments default="development"><!-- environment 元素体中包含对事 务管理和连接池的环境配置 --><environment id="development"><transactionManager type="JDBC" /><dataSource  type="POOLED"><!-- driver和url是从 config.properties属性文件中读取的--><property name="driver" value="${driver}" /><property name="url" value="${url}" /><!-- username和password是从上面设置的属性获取的--><property name="username" value="${username}" /><property name="password" value="${password}" /></dataSource></environment></environments>

属性也可以被传递到SqlSessionBuilder.build()方法中。例如:

SqlSessionFactory factory = sqlSessionFactoryBuilder.build(reader, props);// ... or ...SqlSessionFactory factory = sqlSessionFactoryBuilder.build(reader, environment, props);

如果在这些地方,属性多于一个的话,MyBatis按照如下的顺序加载它们:

·        在properties元素体内指定的属性首先被读取。

·        从类路径下资源或properties元素的 url属性中加载的属性第二被读取,它会覆盖已经存在的完全一样的属性。

·        作为方法参数传递的属性最后被读取,它也会覆盖任一已经存在的完全一样的属性,这些属性可能是从 properties元素体内和资源/url属性中加载的。

因此,最高优先级的属性是那些作为方法参数的,然后是资源/url属性,最后是 properties元素中指定的属性。

比如如上的例子中，在config.properties文件中和mybatis-config.xml文件中同事配置了username和password属性，config.properties中的会覆盖mybatis-config.xml中的。

二、settings

这些是极其重要的调整,它们会修改 MyBatis在运行时的行为方式。下面这个表格描述了设置信息,它们的含义和默认值。

设置参数描述有效值默认值cacheEnabled这个配置使全局的映射器启用或禁用 缓存。true | falsetruelazyLoadingEnabled全局启用或禁用延迟加载。当禁用时, 所有关联对象都会即时加载。true | falsetrueaggressiveLazyLoading当启用时, 有延迟加载属性的对象在被 调用时将会完全加载任意属性。否则, 每种属性将会按需要加载。true | falsetruemultipleResultSetsEnabled允许或不允许多种结果集从一个单独 的语句中返回(需要适合的驱动)true | falsetrueuseColumnLabel使用列标签代替列名。 不同的驱动在这 方便表现不同。 参考驱动文档或充分测 试两种方法来决定所使用的驱动。true | falsetrueuseGeneratedKeys允许 JDBC 支持生成的键。 需要适合的 驱动。 如果设置为 true 则这个设置强制 生成的键被使用, 尽管一些驱动拒绝兼 容但仍然有效(比如 Derby)true | falseFalseautoMappingBehavior指定 MyBatis 如何自动映射列到字段/ 属性。PARTIAL 只会自动映射简单, 没有嵌套的结果。FULL 会自动映射任 意复杂的结果(嵌套的或其他情况) 。NONE, PARTIAL, FULLPARTIALdefaultExecutorType配置默认的执行器。SIMPLE 执行器没 有什么特别之处。REUSE 执行器重用 预处理语句。BATCH 执行器重用语句 和批量更新SIMPLE REUSE BATCHSIMPLEdefaultStatementTimeout设置超时时间, 它决定驱动等待一个数 据库响应的时间。Any positive integerNot Set (null)safeRowBoundsEnabledAllows using RowBounds on nested statements.true | falseFalsemapUnderscoreToCamelCaseEnables automatic mapping from classic database column names A_COLUMN to camel case classic Java property names aColumn.true | falseFalselocalCacheScopeMyBatis 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 | STATEMENTSESSIONjdbcTypeForNullSpecifies 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 OTHEROTHERlazyLoadTriggerMethodsSpecifies which Object's methods trigger a lazy loadA method name list separated by commasequals,clone,hashCode,toString

一个设置信息元素的示例,完全的配置如下所示:

<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="25000"/><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>

三、typeAliases

类型别名是为 Java 类型命名一个短的名字。 它只和 XML 配置有关, 只用来减少类完全 限定名的多余部分。例如:

1、xml方式

1>、通过为指定类指定别名

注意配置的顺序，不然会提示如下的错误：

Caused by: org.xml.sax.SAXParseException; lineNumber: 54; columnNumber: 17; 元素类型为 "configuration" 的内容必须匹配 "(properties?,settings?,typeAliases?,typeHandlers?,objectFactory?,objectWrapperFactory?,plugins?,environments?,databaseIdProvider?,mappers?)"。

可以从如上的错误调整配置的顺序。

2>、通过指定包名，让mybatis自动在指定的包中搜索，例如：

mybatis-config.xml：

<typeAliases><!--<typeAlias alias="user" type="org.mybatis.example.entity.User" />--><!-- 通过指定包名，让mybatis自动在指定的包中搜索,在所对应的映射文件中引用貌似没有大小写之分 --><package name="org.mybatis.example.entity"/></typeAliases>

UserMapper.xml：（这里的resultType为user或User都可以）

<select id="getUserById" parameterType="int" resultType="user">select * from users where id=#{id} </select>

但是建议最好将别名定为跟类名一样，这样就不容易出错。

2、注解方式：@Alias

@Alias("User")public class User {private int id;private String userName;private String passWord;public int getId() {return id;}public void setId(int id) {this.id = id;}public String getUserName() {return userName;}public void setUserName(String userName) {this.userName = userName;}public String getPassWord() {return passWord;}public void setPassWord(String passWord) {this.passWord = passWord;}}

四、typeHandlers

下面这个表格描述了默认的类型处 理器：

类型处理器Java 类型JDBC 类型BooleanTypeHandlerjava.lang.Boolean, boolean任何兼容的布尔值ByteTypeHandlerjava.lang.Byte, byte任何兼容的数字或字节类型ShortTypeHandlerjava.lang.Short, short任何兼容的数字或短整型IntegerTypeHandlerjava.lang.Integer, int任何兼容的数字和整型LongTypeHandlerjava.lang.Long, long任何兼容的数字或长整型FloatTypeHandlerjava.lang.Float, float任何兼容的数字或单精度浮点型DoubleTypeHandlerjava.lang.Double, double任何兼容的数字或双精度浮点型BigDecimalTypeHandlerjava.math.BigDecimal任何兼容的数字或十进制小数类型StringTypeHandlerjava.lang.StringCHAR 和 VARCHAR 类型ClobTypeHandlerjava.lang.StringCLOB 和 LONGVARCHAR 类型NStringTypeHandlerjava.lang.StringNVARCHAR 和 NCHAR 类型NClobTypeHandlerjava.lang.StringNCLOB 类型ByteArrayTypeHandlerbyte[]任何兼容的字节流类型BlobTypeHandlerbyte[]BLOB 和 LONGVARBINARY 类型DateTypeHandlerjava.util.DateTIMESTAMP 类型DateOnlyTypeHandlerjava.util.DateDATE 类型TimeOnlyTypeHandlerjava.util.DateTIME 类型SqlTimestampTypeHandlerjava.sql.TimestampTIMESTAMP 类型SqlDateTypeHandlerjava.sql.DateDATE 类型SqlTimeTypeHandlerjava.sql.TimeTIME 类型ObjectTypeHandlerAny其他或未指定类型EnumTypeHandlerEnumeration TypeVARCHAR-任何兼容的字符串类型, 作为代码存储(而不是索引)EnumOrdinalTypeHandlerEnumeration TypeAny compatible NUMERIC or DOUBLE, as the position is stored (not the code itself).当这些默认的类型处理器不满足你的需求时，你可以通过简单的继承org.apache.ibatis.type.BaseTypeHandler类，并选择性的将新的 TypeHandler类映射到一个JDBC type，例如：

// ExampleTypeHandler.java@MappedJdbcTypes(JdbcType.VARCHAR)public class ExampleTypeHandler extends BaseTypeHandler<String> {  @Override  public void setNonNullParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType) throws SQLException {    ps.setString(i, parameter);  }  @Override  public String getNullableResult(ResultSet rs, String columnName) throws SQLException {    return rs.getString(columnName);  }  @Override  public String getNullableResult(ResultSet rs, int columnIndex) throws SQLException {    return rs.getString(columnIndex);  }  @Override  public String getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {    return cs.getString(columnIndex);  }}

<!-- mybatis-config.xml --><typeHandlers>  <typeHandler handler="org.mybatis.example.ExampleTypeHandler"/></typeHandlers>

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

// TODO translation needed MyBatis will know the the Java type that you want to handle with this TypeHandler by introspecting its generic type, but you can override this behavior by two means:

• Adding a javaType attribute to the typeHandler element (for example: javaType="String")
• Adding a @MappedTypes annotation to your TypeHandler class specifying the list of java types to associate it with. This annotation will be ignored if the javaType attribute as also been specified.

Associated JDBC type can be specified by two means:

• Adding a jdbcType attribute to the typeHandler element (for example: jdbcType=VARCHAR).
• Adding a @MappedJdbcTypes annotation to your TypeHandler class specifying the list of JDBC types to associate it with. This annotation will be ignored if the jdbcType attribute as also been specified.

你也可以向typeAliases中那样通过设置包名来定义，如下：

<!-- mybatis-config.xml --><typeHandlers>  <package name="org.mybatis.example"/></typeHandlers>

五、objectFactory

MyBatis 每次创建结果对象新的实例时, 它使用一个 ObjectFactory 实例来完成。 如果参 数映射存在,默认的 ObjectFactory 不比使用默认构造方法或带参数的构造方法实例化目标 类做的工作多。如果你想重写默认的 ObjectFactory,你可以创建你自己的。比如:

// ExampleObjectFactory.javapublic class ExampleObjectFactory extends DefaultObjectFactory {  public Object create(Class type) {    return super.create(type);  }  public Object create(Class type, List<Class> constructorArgTypes, List<Object> constructorArgs) {    return super.create(type, constructorArgTypes, constructorArgs);  }  public void setProperties(Properties properties) {    super.setProperties(properties);  }}

<!-- mybatis-config.xml --><objectFactory type="org.mybatis.example.ExampleObjectFactory">  <property name="someProperty" value="100"/></objectFactory>

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

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

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

// ExamplePlugin.java@Intercepts({@Signature(  type= Executor.class,  method = "update",  args = {MappedStatement.class,Object.class})})public class ExamplePlugin implements Interceptor {  public Object intercept(Invocation invocation) throws Throwable {    return invocation.proceed();  }  public Object plugin(Object target) {    return Plugin.wrap(target, this);  }  public void setProperties(Properties properties) {  }}

<!-- mybatis-config.xml --><plugins>  <plugin interceptor="org.mybatis.example.ExamplePlugin">    <property name="someProperty" value="100"/>  </plugin></plugins>

NOTE 覆盖配置类

除了用插件来修改 MyBatis 核心行为之外, 你也可以完全覆盖配置类。 简单扩展它, 然后覆盖其中的任意方法,之后传递它到 sqlSessionFactoryBuilder.build(myConfig)方法 的调用。这可能会严重影响 MyBatis 的行为,所以要小心。

七、environments

MyBatis 可以配置多种环境。这会帮助你将 SQL 映射应用于多种数据库之中。例如, 你也许为开发要设置不同的配置, 测试和生产环境。 或者你可能有多种生产级数据库却共享 相同的模式,所以你会想对不同数据库使用相同的 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 元素体中包含对事 务管理和连接池的环境配置 --><environment id="development"><transactionManager type="JDBC" /><dataSource  type="POOLED"><!-- driver和url是从 config.properties属性文件中读取的--><property name="driver" value="${driver}" /><property name="url" value="${url}" /><!-- username和password是从上面设置的属性获取的--><property name="username" value="${username}" /><property name="password" value="${password}" /></dataSource></environment></environments>

注意这里的键:

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

1、transactionManager

在 MyBatis 中有两种事务管理器类型(也就是 type=”[JDBC|MANAGED]”):

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

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

NOTE 如果mybatis和spring整合，就没有必要配置任何TransactionManager .

这两种事务管理器都不需要任何属性。然而它们都是类型别名,要替换使用它们,你需 要放置将你自己的类的完全限定名或类型别名,它们引用了你对 TransactionFactory 接口的实现 类。

public interface TransactionFactory {  void setProperties(Properties props);    Transaction newTransaction(Connection conn);  Transaction newTransaction(DataSource dataSource, TransactionIsolationLevel level, boolean autoCommit);  }

任何在 XML 中配置的属性在实例化之后将会被传递给 setProperties()方法。 你的实现类 需要创建一个事务接口的实现,这个接口也很简单:

public interface Transaction {  Connection getConnection() throws SQLException;  void commit() throws SQLException;  void rollback() throws SQLException;  void close() throws SQLException;}

使用这两个接口,你可以完全自定义 MyBatis 对事务的处理。

2、dataSource

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

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

有三种内建的数据源类型(也就是 type=”???”):

UNPOOLED – 这个数据源的实现是每次被请求时简单打开和关闭连接。它有一点慢, 这是对简单应用程序的一个很好的选择, 因为它不需要及时的可用连接。 不同的数据库对这 个的表现也是不一样的, 所以对某些数据库来说配置数据源并不重要, 这个配置也是闲置的。 UNPOOLED 类型的数据源仅仅用来配置以下 5 种属性:

• driver – 这是 JDBC 驱动的 Java 类的完全限定名(如果你的驱动包含,它也不是 数据源类)。
• url – 这是数据库的 JDBC URL 地址。
• username – 登录数据库的用户名。
• password – 登录数据库的密码。
• defaultTransactionIsolationLevel – 默认的连接事务隔离级别。

作为可选项,你可以传递数据库驱动的属性。要这样做,属性的前缀是以“driver.”开 头的,例如:

• driver.encoding=UTF8

这 样 就 会 传 递 以 值 “ UTF8 ” 来 传 递 属 性 “ encoding ”, 它 是 通 过 DriverManager.getConnection(url,driverProperties)方法传递给数据库驱动。

POOLED – 这是 JDBC 连接对象的数据源连接池的实现,用来避免创建新的连接实例 时必要的初始连接和认证时间。这是一种当前 Web 应用程序用来快速响应请求很流行的方 法。

除了上述(UNPOOLED)的属性之外,还有很多属性可以用来配置 POOLED 数据源:

• poolMaximumActiveConnections – 在任意时间存在的活动(也就是正在使用)连 接的数量。默认值:10
• poolMaximumIdleConnections – 任意时间存在的空闲连接数。
• poolMaximumCheckoutTime – 在被强制返回之前,池中连接被检查的时间。默认 值:20000 毫秒(也就是 20 秒)
• poolTimeToWait – 这是给连接池一个打印日志状态机会的低层次设置,还有重新 尝试获得连接, 这些情况下往往需要很长时间 为了避免连接池没有配置时静默失 败)。默认值:20000 毫秒(也就是 20 秒)
• poolPingQuery – 发送到数据的侦测查询,用来验证连接是否正常工作,并且准备 接受请求。默认是“NO PING QUERY SET” ,这会引起许多数据库驱动连接由一 个错误信息而导致失败。
• poolPingEnabled – 这是开启或禁用侦测查询。如果开启,你必须用一个合法的 SQL 语句(最好是很快速的)设置 poolPingQuery 属性。默认值:false。
• poolPingConnectionsNotUsedFor – 这是用来配置 poolPingQuery 多次时间被用一次。 这可以被设置匹配标准的数据库连接超时时间, 来避免不必要的侦测。 默认值: 0(也就是所有连接每一时刻都被侦测-但仅仅当 poolPingEnabled 为 true 时适用)。

JNDI – 这个数据源的实现是为了使用如 Spring 或应用服务器这类的容器, 容器可以集 中或在外部配置数据源,然后放置一个 JNDI 上下文的引用。这个数据源配置只需要两个属 性:

• initial_context – 这 个 属 性 用 来 从 初 始 上 下 文 中 寻 找 环 境 ( 也 就 是 initialContext.lookup(initial——context) 。这是个可选属性,如果被忽略,那么 data_source 属性将会直接以 initialContext 为背景再次寻找。
• data_source – 这是引用数据源实例位置的上下文的路径。它会以由 initial_context 查询返回的环境为背景来查找,如果 initial_context 没有返回结果时,直接以初始 上下文为环境来查找。

和其他数据源配置相似, 它也可以通过名为 “env.” 的前缀直接向初始上下文发送属性。 比如:

• env.encoding=UTF8

在初始化之后,这就会以值“UTF8”向初始上下文的构造方法传递名为“encoding” 的属性。

八、databaseIdProvider

mybatis能根据你的数据库供应商来执行不同的语句。这种多数据库供应的支持是基于映射语句中的databaseId 属性。mybatis会加载符合当前的所有语句，包括没有databaseId 属性的和有databaseId 的。如果两者都符合，那么mybatis将会选择有databaseId 的。databaseIdProvider 在mybatis-config.xml的配置如下：

<databaseIdProvider type="VENDOR" />

VENDOR实现databaseIdProvider 设置一个databaseId 通过DatabaseMetaData#getDatabaseProductName()返回的字符串。通常，这个返回的string太长并且同样的产品不同的版本返回不同的值，那么你就需要像如下这样通过添加属性来来使它变短：

<databaseIdProvider type="VENDOR">  <property name="SQL Server" value="sqlserver"/>  <property name="DB2" value="db2"/>          <property name="Oracle" value="oracle" /></databaseIdProvider>

当属性提供了，VENDOR databaseIdProvider将会查找属性值符合在返回的数据库产品名发现的第一个键，如果没有匹配的就返回null。在这个例子中，如果getDatabaseProductName()返回"Oracle (DataDirect)" ，那么databaseId 将会被设置成oracle。

你可以通过实现org.apache.ibatis.mapping.DatabaseIdProvider接口并将其注册进mybatis-config.xml来创建自己的数据库供应：

public interface DatabaseIdProvider {  void setProperties(Properties p);    String getDatabaseId(DataSource dataSource) throws SQLException;}

九、mappers

既然 MyBatis 的行为已经由上述元素配置完了,我们现在就要定义 SQL 映射语句了。 但是, 首先我们需要告诉 MyBatis 到哪里去找到这些语句。 Java 在这方面没有提供一个很好 的方法, 所以最佳的方式是告诉 MyBatis 到哪里去找映射文件。 你可以使用相对于类路径的 资源引用,或者字符表示,或 url 引用的完全限定名(包括 file:///URLs) 。例如:

<!-- Using classpath relative resources --><mappers>  <mapper resource="org/mybatis/builder/AuthorMapper.xml"/>  <mapper resource="org/mybatis/builder/BlogMapper.xml"/>  <mapper resource="org/mybatis/builder/PostMapper.xml"/></mappers>

<!-- Using url fully qualified paths --><mappers>  <mapper url="file:///var/mappers/AuthorMapper.xml"/>  <mapper url="file:///var/mappers/BlogMapper.xml"/>  <mapper url="file:///var/mappers/PostMapper.xml"/></mappers>

<!-- Using mapper interface classes --><mappers>  <mapper class="org.mybatis.builder.AuthorMapper"/>  <mapper class="org.mybatis.builder.BlogMapper"/>  <mapper class="org.mybatis.builder.PostMapper"/></mappers>

<!-- Register all interfaces in a package as mappers --><mappers>  <package name="org.mybatis.builder"/></mappers>

这些语句简单告诉了 MyBatis 去哪里找映射文件。

以上是参照文档