模块配置包括：
(1)Type Alias节点
定义了本映射文件中的别名，以避免过长变量值的反复书写，此例中通过typeAlias节点为类“IBatisNetDemo.Domain.Person”定义了一个别名“Person”,这样在本配置文件中的其他部分，需要引用“IBatisNetDemo.Domain.Person”类时，只需以其别名替代即可。
(2)cacheModel节点
定义了本映射文件中使用的Cache机制：
| <cacheModel id="person-cache" implementation="MEMORY" > <flushInterval hours="24"/> <flushOnExecute statement="UpdateAccountViaInlineParameters"/> <flushOnExecute statement="UpdateAccountViaParameterMap"/> <property name="Type" value="Weak"/> </cacheModel> |
这里声明了一个名为“person-cache”的cacheModel,之后可以在Statement声明中对其进行引用：
| <select id="SelectAllPerson" resultMap="SelectAllResult" cacheModel=" person-cache"> select PER_ID, PER_FIRST_NAME, PER_LAST_NAME, PER_BIRTH_DATE, PER_WEIGHT_KG, PER_HEIGHT_M from PERSON </select> |
这表明对通过id为SelAllPerson的“Select Statement”获取的数据，使用CacheModel “person-cache”进行缓存。之后如果程序再次用此Satement进行数据查询。即直接从缓存中读取数据，而不需再去数据库查询。
CacheModel主要有几个配置点：
| 参数 | 描述 |
| flushInterval | 设定缓存有效期，如果超过此设定值，则将此CacheModel缓存清空 |
| CacheSize | 本Cachemodel中最大的数据对象数量 |
| flushOnExecute | 指定执行特定的Statement时，将缓存清空。如UpdatePerson操作将更新数据库中用户信息，这将导致缓存中的数据对象与数据库中的实际数据发生偏差，因此必须将缓存清空以避免脏数据的出现。 |
(3)resultMaps节点
resultMaps实现dotnet实体到数据库字段的映射配置：
| <resultMap id="SelectAllResult" class="Person"> <result property="Id" column="PER_ID" /> <result property="FirstName" column="PER_FIRST_NAME" /> <result property="LastName" column="PER_LAST_NAME" /> <result property="BirthDate" column="PER_BIRTH_DATE" /> <result property="WeightInKilograms" column="PER_WEIGHT_KG" /> <result property="HeightInMeters" column="PER_HEIGHT_M" /> </resultMap> |
(4)Statement配置：
⑴ ID
指定了操作ID，之后我们可以在代码中通过指定操作id 来执行此节点所定义的操作，如：
SqlMap.Update("UpdatePerson", person);
ID设定使得在一个配置文件中定义两个同名节点成为可能（两个update节点，以不同id区分）
⑵ parameterClass
指定了操作所需的参数类型，此例中update 操作以IBatisNetDemo.Domain.Person类型的对象作为参数，目标是将提供的Person实例更新到数据库。
parameterClass="Person"中，user为“IBatisNetDemo.Domain.Person”
类的别名，别名可通过typeAlias节点指定，如示例配置文件中的：
<typeAlias alias="Person" type="IBatisNetDemo.Domain.Person,IBatisNetDemo" />
⑶ <![CDATA[……]]>
通过<![CDATA[……]]>节点，可以避免SQL 中与XML 规范相冲突的字符对XML映射文件的合法性造成影响。
⑷ 执行更新操作的SQL，这里的SQL 即实际数据库支持的SQL 语句，将由IBatisNet填入参数后交给数据库执行。
⑸ SQL中所需的用户名参数，“# FirstName #”在运行期会由传入的Person对象的FirstName属性填充。
⑹ SQL 中所需的用户性别参数“# LastName #”，将在运行期由传入的user 对象的LastName属性填充。
⑺ SQL中所需的条件参数“#id#”，将在运行期由传入的Person对象的Person属性填充。
对于这个示例，IBatisNet在运行期会读取id 为“UpdatePerson”的update节点的SQL定义，并调用指定的user对象的对应getter方法获取属性值，并用此属性值，对SQL中的参数进行填充后提交数据库执行。
Statement配置包含了数个与Sql Statement相关的节点，<statement>元素是一个通用的能够包容任意类型sql的元素。我们可以用更多细节的元素。
这些细节元素提供更好的错误检查以及一些更多的功能。（例如，一个插入函数能够返回数据库自动生成的key）。以下表格总结了声明类型元素以及他们的特性和属性。
| Statement Element | Attributes | Child Elements | Methods |
| <statement> |
id parameterClass resultClass parameterMap resultMap cacheModel xmlResultName (Java only) |
All dynamic elements |
insert update delete All query methods |
| <insert> |
id parameterClass parameterMap |
All dynamic elements <selectKey> <generate> (.NET only) |
insert update delete |
| <update> |
id parameterClass parameterMap |
All dynamic elements <generate> (.NET only) |
insert update delete |
| <delete> |
id parameterClass parameterMap |
All dynamic elements <generate> (.NET only) |
insert update delete |
| <select> |
id parameterClass resultClass parameterMap resultMap cacheModel |
All dynamic elements <generate> (.NET only) |
All query methods |
| <procedure> |
id parameterClass resultClass parameterMap resultMap xmlResultName (Java only) |
All dynamic elements |
insert update delete All query methods |
其中，statement最为通用，它可以代替其余的所有节点。除statement之外的节点对应于SQL中的同名操作（procedure对应存储过程）。使用Statement定义所有操作，缺乏直观性，建议在开发中根据操作目的，各自选用对应的节点名加以说明。一方面，使得配置文件更加直观，另一方面，也可以借助xsd对i节点声明进行更有针对性的检查，以避免配置上的失误。
| <statement id=”statementName” [parameterMap=”nameOfParameterMap”] [parameterClass=”some.class.Name”] [resultMap=”nameOfResultMap”] [resultClass=”some.class.Name”] [cacheModel=”nameOfCache”] > select * from PRODUCT where PRD_ID = [?|#propertyName#] order by [$simpleDynamic$]
</statement> |
其中“[ ]”包围的部分为可能出现的配置项，各参数说明见下表。具体的使用方法参见IBatisNet官方文档。
| 参数 | 描述 |
| parameterMap | 参数映射，需结合parameterMap节点对映射关系加以定义，对于存储过程之外的statement而言，建议使用parameterClass作为参数配置方式，一方面避免了参数映射配置工作，另一方面其性能表现更加出色 |
| parameterClass | 参数类。指定了参数类型的完整类名（包括命名空间），可以通过别名避免每次书写冗长的类名 |
| resultMap | 结果映射，需结合resultMap节点对映射关系加以定义 |
| resultClass | 结果类。指定了结果类型的完整类名（包括命名空间），可以通过别名避免每次书写冗长的类名 |
| cacheModel | Statement对应的Cache模块 |
一般而言，对于insert、update、delete、select语句，优先采用parameterClass和resultClass.。paremeterMap使用较少，而ResultMap则大多用于存储过程处理和查询。存储过程相对而言比较封闭（很多情况下需要调用现有的存储过程），其参数名和返回的数据字段命名往往不符合dotnet编程的命名规范）。使用resultMap建立字段名同Dotnet对象的属性之间的映射关系就非常有效。另一方面，由于通过ResultMap指定了字段名和字段类型，ibatisnet无需再通过ado.net来动态获取字段信息，在一定程度上也提升了性能。
1. DomSqlMapBuilder
DomSqlMapBuilder，其作用是根据配置文件创建SqlMap实例。可以通过这个组件从Stream, Uri, FileInfo, or XmlDocument instance 来读取sqlMap.config文件。
2. SqlMap
SqlMapper是IBatisnet的核心组件，提供数据库操作的基础平台。所有的操作均通过SqlMapper实例完成。SqlMapper可通过DomSqlMapBuilder创建。
这个例子中我们可以将所有的配置文件按照嵌入资源文件方式存放，从程序集去加载sqlmap.config文件。也可以直接以文件方式加载sqlmap.config。
| /// <summary> /// IsqlMapper实例 /// </summary> /// <returns></returns> public static ISqlMapper sqlMap ; private string fileName = "sqlMap.Config"; public BaseSqlMapDao() { //从程序集资源中加载 //Assembly assembly = Assembly.Load("IBatisNetDemo"); //Stream stream = assembly.GetManifestResourceStream("IBatisNetDemo.sqlmap.config"); //DomSqlMapBuilder builder = new DomSqlMapBuilder(); //sqlMap = builder.Configure(stream);
//从文件加载创建实例 DomSqlMapBuilder builder = new DomSqlMapBuilder(); sqlMap = builder.Configure(fileName); } |
SqlMap是线程安全的，也就是说，在一个应用中，可以共享一个SqlMap实例。
SqlMap提供了众多数据操作方法，下面是一些常用方法的示例，具体说明文档参见
ibatis net doc,或者ibatisnet的官方开发手册。
3. SqlMap基本操作示例
例1：数据写入操作（insert、update、delete）
| SqlMap.BeginTransaction(); Person person = new Person(); Person.FirstName = “li”; Person.LastName = “tianping”; int Id = (int) SqlMap.Insert("InsertPerson", person); SqlMap.CommitTransaction(); |
例2：数据查询：
| Int Id = 1; Person person = SqlMap.QueryForObject<Person>("", Id); return person; |
例3：执行批量查询（Select）
| IList<Person> list = null; list = SqlMap.QueryForList<Person>("SelectAllPerson", null); return list; |
例4：查询指定范围内的数据（Select）
| IList<Person> list = null; list = SqlMap.QueryForList<Person>("SelectAllPerson", null, 0, 40); return list; |
例5：结合RowDelegate进行查询：
| public void RowHandler(object obj, IList list) { Product product = (Product) object; product.Quantity = 10000; } SqlMapper.RowDelegate handler = new SqlMapper.RowDelegate(this.RowHandler); IList list = sqlMap.QueryWithRowDelegate("getProductList", null, handler); |
4. 存储过程操作
下面特别说明一下ibatisnet对Stored Procedures的处理，iBatis数据映射把存储过程当成另外一种声明元素。示例演示了一个基于存储过程的简单数据映射。
|
<!-- Microsot SQL Server --> <procedure id="SwapEmailAddresses" parameterMap="swap-params"> ps_swap_email_address </procedure> ... <parameterMap id="swap-params"> <parameter property="email1" column="First_Email" /> <parameter property="email2" column="Second_Email" /> </parameterMap>
<!-- Oracle with MS OracleClient provider --> <procedure id="InsertCategory" parameterMap="insert-params"> prc_InsertCategory </procedure> ... <parameterMap id="insert-params"> <parameter property="Name" column="p_Category_Name"/> <parameter property="GuidString" column="p_Category_Guid" dbType="VarChar"/> <parameter property="Id" column="p_Category_Id" dbType="Int32" type="Int"/> </parameterMap>
<!-- Oracle with ODP.NET10gprovider --> <statement id="InsertAccount" parameterMap="insert-params"> prc_InsertAccount </statement> ... <parameterMap id="insert-params"> <parameter property="Id" dbType="Int32"/> <parameter property="FirstName" dbType="VarChar2" size="32"/> <parameter property="LastName" dbType="VarChar2" size="32"/> <parameter property="EmailAddress" dbType="VarChar2" size="128"/> </parameterMap>
|
示例是调用存储过程swapEmailAddress的时候将会在数据库表的列和两个email地址之间交换数据，参数对象亦同。参数对象仅在属性被设置成INOUT或者OUT的时候才会被修改。否则，他们将不会被修改。当然，不可变得参数对象是不会被修改的，比如string.
.Net中，parameterMap属性是必须的。DBType，参数方向，大小由框架自动发现的。（使用CommandBuilder实现的）。
580
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
