搜索

首页  >  文章  >  后端开发  >  My Batis 的XML 映射配置文件的实例详解

My Batis 的XML 映射配置文件的实例详解

Y2J
Y2J原创
2017-04-24 09:33:292278浏览

[java] view plain copy

<span style="font-size:14px;">  My Batis 支持SQL查询，是一些高级映射在持久层的完美展示。他更多的使用简单的XML或注解用于配置和原始映射，<span style="color: rgb(54, 54, 54); font-family: &#39;Helvetica Neue&#39;, Helvetica, Arial, sans-serif; line-height: 24px; ">摒除了大量的JDBC代码、手工设置参数和结果集封装，提高了开发效率。</span></span>

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

configuration配置

environment环境变量

 transactionManager事务管理器

dataSource数据源

 properties属性

  settings设置

 typeAliases类型命名

typeHandlers类型处理器

objectFactory对象工厂

 plugins插件

 environments环境

 映射器

 下面就对各个属性配置做出详细介绍

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

                     例如：

[html] view plain copy
<properties resource="jdbc_mysql.properties" />  
[html] view plain copy
<dataSource type="POOLED">  
[html] view plain copy
<property name="driver" value="${driver}"/>  
[html] view plain copy
<property name="url" value="${url}"/>  
[html] view plain copy
<property name="username" value="${username}"/>  
[html] view plain copy
<property name="password" value="${password}"/>  
[html] view plain copy
</dataSource>

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

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

 设置参数                                               描述                                               

cacheEnabled       这个配置使全局的映射器启用或禁用缓存。

lazyLoadingEnabled  全局启用或禁用延迟加载。当禁用时，所有关联对象都会即时加载。

aggressiveLazyLoading     当启用时，有延迟加载属性的对象在被调用时将会完全加载任意属性。否则，每种属性将会按需要加载。

multipleResultSetsEnabled       允许或不允许多种结果集从一个单独的语句中返回（需要适合的驱动）。

useColumnLabel      使用列标签代替列名。不同的驱动在这方便表现不同。参考驱动文档或充分测试两种方法来决定所使用的驱动。

useGeneratedKeys     允许JDBC支持生成的键。需要适合的驱动。如果设置为true则这个设置强制生成的键被使用，尽管一些驱动拒绝兼容但仍然有效（比如Derby）。

autoMappingBehavior       指定MyBatis如何自动映射列到字段/属性。PARTIAL只会自动映射简单，没有嵌套的结果。FULL会自动映射任意复杂的结果（嵌套的或其他情况）。

defaultExecutorType   配置默认的执行器。SIMPLE执行器没有什么特别之处。REUSE执行器重用预处理语句。BATCH执行器重用语句和批量更新

defaultStatementTimeout   设置超时时间，它决定驱动等待一个数据库响应的时间。

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

<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"/>
<setting name="defaultStatementTimeout" value="25000"/>
</settings>

typeAliases

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

[html] view plain copy
<typeAliases>  
[html] view plain copy
<typeAlias alias="Author" type="domain.blog.Author"/>  
[html] view plain copy
<typeAlias alias="Blog" type="domain.blog.Blog"/>  
[html] view plain copy
<typeAlias alias="Comment" type="domain.blog.Comment"/>  
[html] view plain copy
<typeAlias alias="Post" type="domain.blog.Post"/>  
[html] view plain copy
<typeAlias alias="Section" type="domain.blog.Section"/>  
[html] view plain copy
<typeAlias alias="Tag" type="domain.blog.Tag"/>  
[html] view plain copy
</typeAliases>

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

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-任何兼容的字符串类型，作为代码存储（而不是索引）。

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

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

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

     java代码：

[javascript] view plain copy
@Intercepts({@Signature(type= Executor.class,method = "update",  
[javascript] view plain copy
args = {MappedStatement.class,Object.class})})  
[javascript] view plain copy
public class ExamplePlugin implements Interceptor {  
[javascript] view plain copy
public Object intercept(Invocation invocation) throws Throwable  
[javascript] view plain copy
{  
[javascript] view plain copy
return invocation.proceed();  
[javascript] view plain copy
}  
[javascript] view plain copy
public Object plugin(Object target) {  
[javascript] view plain copy
return Plugin.wrap(target, this);  
[javascript] view plain copy
}  
[javascript] view plain copy
public void setProperties(Properties properties) {  
[javascript] view plain copy
}  
[html] view plain copy
MapperConfig.xml  
[html] view plain copy
<plugins>  
[html] view plain copy
<plugin interceptor="org.mybatis.example.ExamplePlugin">  
[html] view plain copy
<property name="someProperty" value="100"/>  
[html] view plain copy
</plugin>  
[html] view plain copy
</plugins>  
[html] view plain copy

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

environments

[html] view plain copy
<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.user}" />  
                <property name="password" value="${jdbc.password}" />  
                                <property name="poolPingEnabled" value="true"/>  
                <property name="poolPingQuery" value="SELECT * FROM app_setup_setting WHERE name=&#39;allow_setup_unknown_app&#39;" />  
                        <property name="poolPingConnectionsNotUsedFor" value="7200000"/>   
            </dataSource>  
        </environment>  
    </environments>  
dataSsource

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

在MyBatis中有两种事务管理器类型（也就是type=”[JDBC|MANAGED]”）：
1.JDBC – 这个配置直接简单使用了JDBC的提交和回滚设置。它依赖于从数据源得到的连接来管理事务范围。
2.MANAGED – 这个配置几乎没做什么。它从来不提交或回滚一个连接。而它会让容器来管理事务的整个生命周期（比如Spring或JEE应用服务器的上下文）。默认情况下它会关闭连接。然而一些容器并不希望这样，因此如果你需要从连接中停止它，将closeConnection属性设置为false。例如：

[html] view plain copy
<transactionManager type="MANAGED">  
<property name="closeConnection" value="false"/>  
</transactionManager>

这两种事务管理器都不需要任何属性。然而它们都是类型别名，要替换使用它们，你需要放置将你自己的类的完全限定名或类型别名，它们引用了你对TransacFactory接口的实现类。
public interface TransactionFactory {
void setProperties(Properties props);
Transaction newTransaction(Connection conn, boolean autoCommit);
}
任何在XML中配置的属性在实例化之后将会被传递给setProperties()方法。你的实现类需要创建一个事务接口的实现，这个接口也很简单：

[html] view plain copy
public interface Transaction {  
Connection getConnection();  
void commit() throws SQLException;  
void rollback() throws SQLException;  
void close() throws SQLException;  
}

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

 mappers

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

[html] view plain copy
// 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/sqlmaps/AuthorMapper.xml"/>  
<mapper url="file:///var/sqlmaps/BlogMapper.xml"/>  
<mapper url="file:///var/sqlmaps/PostMapper.xml"/>  
</mappers>

以上是My Batis 的XML 映射配置文件的实例详解的详细内容。更多信息请关注PHP中文网其他相关文章！

声明：
本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系admin@php.cn
上一篇：在KVM虚拟机中的配置xml的代码详解下一篇：实例详解如何配置Web.xml

相关文章

查看更多