XML映射配置文件

最新推荐文章于 2024-12-11 16:45:59 发布

Mr_Bang_Lu

最新推荐文章于 2024-12-11 16:45:59 发布

阅读量643

点赞数

CC 4.0 BY-SA版权

分类专栏： mybatis

本文链接：https://blog.youkuaiyun.com/qq_21336789/article/details/52945759

mybatis 专栏收录该内容

6 篇文章

订阅专栏

本文详细介绍了MyBatis XML配置文件的各个部分，包括configuration、properties、settings、typeAliases、objectFactory、plugins、environments等。properties元素用于外部化配置属性，支持属性替换。settings部分调整MyBatis运行时行为，如cacheEnabled、lazyLoadingEnabled等。typeAliases简化了Java类型名称。typeHandlers处理Java类型与JDBC类型的转换。objectFactory定制对象创建。plugins允许拦截并自定义执行过程。environments配置数据库环境，包括transactionManager和dataSource。同时讲解了数据源类型和事务管理器的不同配置选项。

MyBatis 的 XML 配置文件包含了影响 MyBatis 行为甚深的设置和属性信息。XML 文档的高层级结构如下：

configuration 配置

properties 属性

settings 设置

typeAliases 类型命名

typeHandlers 类型处理器

objectFactory 对象工厂

plugins 插件

environments 环境

environment 环境变量

transactionManager 事务管理器

dataSource 数据源

映射器

properties：

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

</properties>

其中的属性就可以在整个配置文件中使用，使用可替换的属性来实现动态配置。比如：

</dataSource>

这个例子中的 username 和 password 将会由 properties 元素中设置的值来替换。driver 和url 属性将会从包含进来的 config.properties 文件中的值来替换。

这里提供很多配置的选项。

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

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

// ... or ...

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

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

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

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

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

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

Settings：

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

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

</settings>

typeAliases：

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

</typeAliases>

使用这个配置，“Blog”可以任意用来替代“domain.blog.Blog”所使用的地方。

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

typeHandlers：

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

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

你可以重写类型处理器或创建你自己的类型处理器来处理不支持的或非标准的类型。要这样做的话，简单实现 TypeHandler 接口（org.mybatis.type），然后映射新的类型处理

器类到Java 类型，还有可选的一个 JDBC 类型。例如：

// ExampleTypeHandler.java

public class ExampleTypeHandler implements TypeHandler {

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

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

}

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

return rs.getString(columnName);

}

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

return cs.getString(columnIndex);

}

// MapperConfig.xml

</typeHandlers>

使用这样的类型处理器将会覆盖已经存在的处理 Java 的 String 类型属性和 VARCHAR参数及结果的类型处理器。要注意 MyBatis 不会审视数据库元信息来决定使用哪种类型，

所以你必须在参数和结果映射中指定那是 VARCHAR 类型的字段，来绑定到正确的类型处理器上。这是因为 MyBatis 直到语句被执行都不知道数据类型的这个现实导致的。

objectFactory：

MyBatis 每次创建结果对象新的实例时，它使用一个 ObjectFactory 实例来完成。如果参数映射存在，默认的 ObjectFactory 不比使用默认构造方法或带参数的构造方法实例化目

标类做的工作多。如果你想重写默认的 ObjectFactory，你可以创建你自己的。比如：

// ExampleObjectFactory.java

public 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);

}

// MapperConfig.xml

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

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

// 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) {

}

// MapperConfig.xml

</plugin>

</plugins>

上面的插件将会拦截在 Executor 实例中所有的“update”方法调用，它也是负责低层次映射语句执行的内部对象。

environments：

要记得一个很重要的问题：你可以配置多种环境，但你只能为每个 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);

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

</transactionManager>

</dataSource>

</environment>

</environments>

注意这里的关键部分：

默认的环境 ID（比如：default=”development”）。

每个 environment 元素定义的环境 ID（比如：id=”development”）。

事务管理器的配置（比如：type=”JDBC”）。

数据源的配置（比如：type=”POOLED”）。

transactionManager：

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

1.JDBC – 这个配置直接简单使用了 JDBC 的提交和回滚设置。它依赖于从数据源得到的连接来管理事务范围。

2.MANAGED – 这个配置几乎没做什么。它从来不提交或回滚一个连接。而它会让容器来管理事务的整个生命周期（比如 Spring 或 JEE 应用服务器的上下文）。默认情况下它会

关闭连接。然而一些容器并不希望这样，因此如果你需要从连接中停止它，将 closeConnection 属性设置为 false。例如：

</transactionManager>

dataSsource：

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

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

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 时适用）。

mappers：

既然 MyBatis 的行为已经由上述元素配置完了，我们现在就要定义 SQL 映射语句了。但是，首先我们需要告诉 MyBatis 到哪里去找到这些语句。Java 在这方面没有提供一个很

好的方法，所以最佳的方式是告诉 MyBatis 到哪里去找映射文件。你可以使用相对于类路径的资源引用，或者字符表示，或 url 引用的完全限定名（包括 file:///URLs）。例如：

// 使用相对于类路径的资源

</mappers>

// 使用完全限定路径

</mappers>