ibatis 学习笔记

SqlMapConfig.xml 配置

SQL Map配置文件拥有唯一的<properties>元素，用于在配置文件中使用标准的Java属性文件（name＝value）.

两种引用方式

<properties url=”file:///c:/config/my.properties” />

<properties resource=" examples/sqlmap/maps/SqlMapConfigExample.properties " />

<setting>元素用于配置和优化SqlMapClient实例的各选项。<setting>元素本身及其所有的属性都是可选的。下表列出了<setting>元素支持的属性及其功能:

maxRequests:同时执行SQL语句的最大线程数。大于这个值的线程将阻塞直到另一个线程执行完成。不同的DBMS有不同的限制值，但任何数据库都有这些限制。通常这个值应该至少是maxTransactions（参见以下）的10倍，并且总是大于maxSessions和maxTranactions。减小这个参数值通常能提高性能。
例如：maxRequests=“256”
缺省值：512


maxSessions:同一时间内活动的最大session数。一个session可以是代码请求的显式session，也可以是当线程使用SqlMapClient实例（即执行一条语句）自动获得的session。它应该总是大于或等于maxTransactions并小于maxRequests。减小这个参数值通常能减少内存使用。
例如：maxSessions=“64”
缺省值：128

maxTransactions:同时进入SqlMapClient.startTransaction()的最大线程数。大于这个值的线程将阻塞直到另一个线程退出。不同的DBMS有不同的限制值，但任何数据库都有这些限制。这个参数值应该总是小于或等于maxSessions并总是远远小于maxRequests。减小这个参数值通常能提高性能。
例如：maxTransactions=“16”
缺省值：32

cacheModelsEnabled:全局性地启用或禁用SqlMapClient的所有缓存model。调试程序时使用。
例如：cacheModelsEnabled=“true”
缺省值：true（启用）

lazyLoadingEnabled:全局性地启用或禁用SqlMapClient的所有延迟加载。调试程序时使用。
例子：lazyLoadingEnabled=“true”
缺省值：true（启用）

enhancementEnabled:全局性地启用或禁用运行时字节码增强，以优化访问Java Bean属性的性能，同时优化延迟加载的性能。
例子：enhancementEnabled=“true”
缺省值：false（禁用）

useStatementNamespaces:如果启用本属性，必须使用全限定名来引用mapped statement。Mapped statement的全限定名由sql-map的名称和mapped-statement的名称合成。例如：queryForObject(“sqlMapName.statementName”);
例如：useStatementNamespaces=“false”
缺省值：false（禁用）

<sqlMap>元素
<sqlMap>元素用于包括SQL Map映射文件和其他的SQL Map配置文件。
<!-- CLASSPATH RESOURCES -->
<sqlMap resource="com/ibatis/examples/sql/Customer.xml" />
<!-- URL RESOURCES -->
<sqlMap url="file:///c:/config/Customer.xml " />

SQL Map XML映射文件
复杂版本

<sqlMap id=”Product”>
<cacheModel id=”productCache” type=”LRU”>
<flushInterval hours=”24”/>
<property name=”size” value=”1000” />
</cacheModel>
<typeAlias alias=”product” type=”com.ibatis.example.Product” />
<parameterMap id=”productParam” class=”product”>
<parameter property=”id”/>
</parameterMap>
<resultMap id=”productResult” class=”product”>
<result property=”id” column=”PRD_ID”/>
<result property=”description” column=”PRD_DESCRIPTION”/>
</resultMap>
<select id=”getProduct” parameterMap=”productParam” resultMap=”productResult” cacheModel=”product-cache”>
select * from PRODUCT where PRD_ID = ?
</select>
</sqlMap>

简单版本

<sqlMap id=”Product”>
<select id=”getProduct” parameterClass=” com.ibatis.example.Product”
resultClass=”com.ibatis.example.Product”>
select
PRD_ID as id,
PRD_DESCRIPTION as description
from PRODUCT
where PRD_ID = #id#
</select>
</sqlMap>

注意！SQL Map的名称是全局性的，在所有的SQL Map文件中名称必须是唯一的。

Mapped Statement的结构如下所示：

<statement id=”statementName”
[parameterClass=”some.class.Name”]
[resultClass=”some.class.Name”]
[parameterMap=”nameOfParameterMap”]
[resultMap=”nameOfResultMap”]
[cacheModel=”nameOfCache”]
>
select * from PRODUCT where PRD_ID = [?|#propertyName#]
order by [$simpleDynamic$]
</statement>

SQL Map通过<procedure>元素支持存储过程。下面的例子说明如何使用具有输出参数的存储过程。

<parameterMap id="swapParameters" class="map" >
<parameter property="email1" jdbcType="VARCHAR" javaType="java.lang.String" mode="INOUT"/>
<parameter property="email2" jdbcType="VARCHAR" javaType="java.lang.String" mode="INOUT"/>
</parameterMap>
<procedure id="swapEmailAddresses" parameterMap="swapParameters" >
{call swap_email_address (?, ?)}
</procedure>

parameterClass
parameterClass属性的值是Java类的全限定名（即包括类的包名）。parameterClass属性是可选的，但强烈建议使用。它的目的是限制输入参数的类型为指定的Java类，并优化框架的性能。如果您使用parameterMap，则没有必要使用parameterClass属性。例如，如果要只允许Java类“examples.domain.Product”作为输入参数，可以这样作：
<statement id=”statementName” parameterClass=” examples.domain.Product”>
insert into PRODUCT values (#id#, #description#, #price#)
</statement>
重要提示：虽然2.0向后兼容，但强烈建议使用parameterClass（除非没必要）。通过提供parameterClass，您可以获得更好的性能，因为如果框架事先知道这个类，就可以优化自身的性能。
如果不指定parameterClass参数，任何带有合适属性（get/set方法）的Java Bean都可以作为输入参数。


<parameterMap>的例子

<parameterMap id=”insert-product-param” class=”com.domain.Product”>
<parameter property=”id” jdbcType=”NUMERIC” javaType=”int” nullValue=”-9999999”/>
<parameter property=”description” jdbcType=”VARCHAR” nullValue=”NO_ENTRY”/>
</parameterMap>
<statement id=”insertProduct” parameterMap=”insert-product-param”>
insert into PRODUCT (PRD_ID, PRD_DESCRIPTION) values (?,?);
</statement>

注意！Parameter Map的名称（name）局部的，只在定义它的SQL Map XML文件中有效。不过，加上SQL Map的名称（即在<sqlMap>根元素中的名称）作为前缀，您可以在另一个SQL Map XML文件中引用它。例如，要在另一个文件中引用以上的parameterMap，可以使用名称“Product.insert-product-param”。


，任何没有指定parameterMap的Mapped Statement都会被解析成inline parameter（内嵌参数）。用上面的例子（即Product）来说，就是：

<statement id=”insertProduct” parameterClass=”com.domain.Product”>
insert into PRODUCT (PRD_ID, PRD_DESCRIPTION)
values (#id#, #description#);
</statement>

在内嵌参数中指定数据类型可以用下面的语法：

<statement id=”insertProduct” parameterClass=”com.domain.Product”>
insert into PRODUCT (PRD_ID, PRD_DESCRIPTION)
values (#id:NUMERIC#, #description:VARCHAR#);
</statement>

在内嵌参数中指定数据类型和NULL的替代值可以用这样的语法：

<statement id=”insertProduct” parameterClass=”com.domain.Product”>
insert into PRODUCT (PRD_ID, PRD_DESCRIPTION)
values (#id:NUMERIC:-999999#, #description:VARCHAR:NO_ENTRY#);
</statement>

注意！在内嵌参数中，要指定NULL的替代值，必须要先指定数据类型。
注意！如需要在查询时也使用NULL替代值，必须同时在resultMap中定义（如下说明）。
注意！如果您需要指定很多的数据类型和NULL替代值，可以使用外部的parameterMap元素，这样会使代码更清晰。