一. 介绍
平常做企业级应用,需求变化是经常的事,而很多基础代码重复也是很让人头疼的问题。所以很多人会使用一些ORM框架来增强项目的可维护性、可扩展性。IBatis.Net就是一个比较易用的ORM框架,使用起来较为方便、灵活。IBatis.Net是从Ibatis的Java版本移植过来的.NET版本。iBATIS作为一种独特的Data Mapper,使用SQL映射的方式将对象持久化至关系型数据库。简单的理解就是它将我们在数据访问层实现的C#逻辑代码,变为通过关系数据库与对象的映射,将SQL逻辑放到外部的XML配置文件中,以方便以后的维护。
这个框架有两个主要的组成部分,一个是SQL Maps,另一个是Data Access Objects。Sql Maps是这个框架的核心部分,通过使用Sql Maps你可以显著的节约数据库操作的代码量。SQL Maps使用一个简单的XML文件来实现从实体到SQL statements的映射。使用DAO,封装了对数据的访问,你可以动态配置你的应用程序来访问不同的实体存储机制。隐藏持久性层实现的细节,Data Access Objects允许你通过一个简单接口的来操作数据。
二. 准备工作
下面先让我们来动手实践一下,看看如何使用和调用IbatisNet。
1. 下载IbatisNet软件包: http://ibatis.apache.org/dotnetdownloads.cgi
iBATIS.NET Downloads
|
|
官方网站还提供了一个示例项目:NPetShop Example Application
2. 建立测试数据库,并在数据库中创建一个Person 表:
字段
|
类型
|
大小
|
PER_ID
|
int
|
4
|
PER_FIRST_NAME
|
nvarchar
|
40
|
PER_LAST_NAME
|
nvarchar
|
40
|
PER_BIRTH_DATE
|
DateTime
|
8
|
PER_WEIGHT_KG
|
float
|
8
|
PER_HEIGHT_M
|
float
|
8
|
三. 开发步骤
1. 逻辑结构
2. 建立项目
打开VS.NET,新建一个“ASP.NET Web应用程序”项目。
3. 添加引用
在项目中添加下面dll的引用:
IBatisNet.Common.dll
IBatisNet.DataMapper.dll
IBatisNet.DataAccess.dll
4. 在项目中,添加配置文件 SqlMap.config
该文件为IBatis.net默认的配置文件,不能缺少,当然可以不必是Sql.config,但是如果改为其他的名字的话需要在前台代码中说明,请参考下面的内容providers.config:该文件必须存在,并且不能改变它的文件名,该文件描述了如何连接数据库,无须配置
结合上面示例中的IbatisNet配置文件,下面对配置文件中各节点的说明:
<?xml version="1.0" encoding="utf-8"?>
<sqlMapConfig xmlns="http://ibatis.apache.org/dataMapper"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" >
<!-- 常量属性,通过单独文件properties.config加载-->
<properties resource="properties.config"/>
<!-- 常量属性,通过程序集资源中 加载
<properties embedded="database.config, IBatisNetDemo"/>-->
<settings>
<setting useStatementNamespaces="${useStatementNamespaces}"/>
<setting cacheModelsEnabled="true"/>
<setting validateSqlMap="false"/>
</settings>
<!-- 数据驱动提供类配置文件的路径和文件名 -->
<providers resource="providers.config"/>
<!-- 设置数据库连接信息 -->
<database>
<provider name="${provider}"/>
<dataSource name="IBatisNetTest" connectionString="${connectionString}"/>
</database>
<!-- 指定项目内映射的文件的位置-->
<sqlMaps>
<!-- 从程序集中
<sqlMap embedded="${root}Person.xml,${assembly}" />-->
<!-- 从文件中-->
<sqlMap resource="@Maps/Person.xml" />
</sqlMaps>
</sqlMapConfig>
|
详细说明:
(1) properties节点
可以根据需要配置一些常量属性。如果这些属性有很多的话可以单独写一个文件里面,再通过resource(或url, embedded分别是引用url和编译在程序中的资源文件)属性引用进来。
properties 节点参数
参数
|
描述
|
resource
|
指定the properties文件从application的根目录进行加载
resource="properties.config"
|
url
|
指定the properties文件从文件的绝对路径进行加载
url="c:\Web\MyApp\Resources\properties.config"
或者
url="file://c:\Web\MyApp\Resources\properties.config"
|
embedded
|
指定文件可以作为程序集的资源文件进行加载'
embedded=" database.config, IBatisNetDemo”
|
上面例子中properties.config文件的配置如下:
<?xml version="1.0" encoding="utf-8" ?>
<settings>
<!—应用程序和配置属性设置-->
<add key="provider" value="sqlServer2.0" />
<add key="connectionString" value="server=127.0.0.1;database=TVSystem;uid=sa;pwd=1" />
<add key="root" value="IBatisNetTest.Maps." />
<add key="assembly" value="IBatisNetTest" />
<add key="userid" value="sa" />
<add key="password" value="" />
<add key="database" value="Northwind" />
<add key="datasource" value="localhost" />
<add key="selectKey" value="select @@IDENTITY as value" />
<add key="directory" value="Maps" />
<add key="useStatementNamespaces" value="false" />
</settings>
|
下面解释一下这个文件的节点参数
properties.config节点参数
参数
|
描述
|
key
|
定义key (variable) 名字
key="username"
|
value
|
定义DataMapper 中使用的 key的值
value="mydbuser"
|
(2) setting节点
Setting节点参数
参数
|
描述
|
cacheModelsEnabled
|
是否启用sqlMap上的缓存机制
Example: cacheModelsEnabled=”true”
Default: true (enabled)
|
useStatementNamespaces
|
是否使用Satement命名空间,这里的命名空间指的是映射文件中sqlMap节点的namespace属性,如上例中针对Person表的映射文件sqlMap节点
<sqlMap namespace="Person" xmlns="http://ibatis.apache.org/mapping"
xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance> 这里,指定了此sqlMap节点下定义的操作均丛属于“Person”命名空间在useStatementNamespaces=”true”的情况下,Statement调用需追加命名空间,如:sqlMap.Update(“Person.UpdatePerson”,person);否则直接通过Statement名称调用即可,如sqlMap.Update(“UpdatePerson”,person);但请注意此时需要保证所有映射文件中,statement定义无重名
Example: useStatementNamespaces=”false”
Default: false (disabled)
|
validateSqlMap
|
是配置要不要启示SqlMapConfig.xsd schema验证映射文件.
Example: validateSqlMap=”false”
Default: false (disabled)
|
(3) provider节点
配置数据驱动提供类配置文件的路径和文件名,通过resource(或url, embedded分别是引用url和编译在程序中的资源文件)属性引用进来,参数的含义同properties。
ADO.NET是通过数据访问提供程序(Provider)访问数据库。IBatisNet使用的是插件式结构来使用这些数据库提供程序,每一个Provider对应于providers.config文件中定义的一个provider项。1.3版本的Provider.config文件中定义了已经实现的16个provider,通过设置这个文件中的几个参数来决定使用哪个数据库提供程序。
· sqlServer1.0 - Microsoft SQL Server 7.0/2000 provider available with .NET Framework 1.0
· sqlServer1.1 -Microsoft SQL Server 7.0/2000 provider available with .NET Framework 1.1
· sqlServer2.0 - Microsoft SQL server 7.0/2000/2005 provider available with .NET Framework 2.0
· OleDb1.1 - OleDb provider available with .NET Framework 1.1
· Odbc1.1 - Odbc provider available with .NET Framework 1.1
· oracle9.2 - Oracle provider V9.2.0.401
· oracle10.1 - Oracle provider V10.1.0.301
· oracleClient1.0 - MS Oracle provider V1.0.5 available with .NET Framework 1.1
· ByteFx - ByteFx MySQL provider V0.7.6.15073
· MySql - MySQL provider V1.0.4.20163
· SQLite3 - SQLite.NET provider V0.21.1869.3794
· Firebird1.7 - Firebird SQL .NET provider V1.7.0.33200
· PostgreSql0.7 - Npgsql provider V0.7.0.0
· PostgreSql0.7.1 - Npgsql provider V0.7.1.0
· iDb2.10 - IBM DB2 iSeries provider V10.0.0.0
· Informix -- informix NET Provider, 2.81.0.0
提供程序要求安装相关类库,每一个provider 元素都有"enabled" 属性来控制是否启用这个providers. 一个provider 可以通过 “default“属性标识为默认的提供程序。
(4) database节点
数据库的信息,包括使用哪些数据库驱动和数据连接字符串的配置。
Database节点参数
参数
|
描述
|
provider
|
数据库访问所使用的provider.config文件定义的provider
|
dataSource
|
特定的数据库连接字符串
|
(5) typeHandler节点
定义数据库类型到dotnet数据类型的处理,不同的数据库都有一些特殊的数据库字段类型需要特殊处理,就可以通过这个功能实现。比如说Blob字段在不同的数据库中处理不一样。大家可以去看看Ibatisnet源代码就清楚这个功能的实现原理,对于我们的设计会有很大的启发
(6) sqlMaps节点
sqlMap节点指定了映射文件的位置,配置中可以出现多个sqlMap节点,以指定项目内所包含的所有映射文件。
5. 创建实体类
定义Person的实体类,该对象类将与数据库进行映射。
[Serializable]
public class Person
{
private int id;
private string firstName;
private string lastName;
private DateTime? birthDate;
private double? weightInKilograms;
private double? heightInMeters;
public Person() { }
public int Id
{
get { return id; }
set { id = value; }
}
public string FirstName
{
get { return firstName; }
set { firstName = value; }
}
public string LastName
{
get { return lastName; }
set { lastName = value; }
}
public DateTime? BirthDate
{
get { return birthDate; }
set { birthDate = value; }
}
public double? WeightInKilograms
{
get { return weightInKilograms; }
set { weightInKilograms = value; }
}
public double? HeightInMeters
{
get { return heightInMeters; }
set { heightInMeters = value; }
}
}
|
6. 添加Person的映射文件Person.xml
相对于Nhibernate等ORM实现来说,IBatisnet的映射配置更为直接,下面是配置文件内容:
<?xml version="1.0" encoding="utf-8" ?>
<sqlMap namespace="Person" xmlns="http://ibatis.apache.org/mapping"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" >
<!--模块配置-->
<alias>
<typeAlias alias="Person" type="IBatisNetLib.Person,IBatisNetLib" />
</alias>
<resultMaps>
<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>
</resultMaps>
<!--statement配置-->
<statements>
<select id="Exists" resultClass="int" parameterclass="int">
select count(1) from PERSON
where PER_ID = #value#
</select>
<insert id="InsertPerson" parameterclass="Person" >
<selectKey property="Id" type="post" resultClass="int">
${selectKey}
</selectKey>
insert into Person
( PER_FIRST_NAME,
PER_LAST_NAME,
PER_BIRTH_DATE,
PER_WEIGHT_KG,
PER_HEIGHT_M)values(#FirstName#,#LastName#,#BirthDate#, #WeightInKilograms#, #HeightInMeters#)
</insert>
<update id="UpdatePerson"
parameterclass="Person">
<![CDATA[ update Person set
PER_FIRST_NAME =#FirstName#,
PER_LAST_NAME =#LastName#,
PER_BIRTH_DATE =#BirthDate#,
PER_WEIGHT_KG=#WeightInKilograms#,
PER_HEIGHT_M=#HeightInMeters#
where
PER_ID = #Id# ]]>
</update>
<delete id="DeletePerson" parameterclass="Person">
delete from Person where PER_ID = #Id#
</delete>
<select id="SelectAllPerson" resultMap="SelectAllResult">
Select *
from PERSON
</select>
<select id="SelectByPersonId" resultMap="SelectAllResult" resultClass="Person" parameterClass="int">
select
PER_ID,
PER_FIRST_NAME,
PER_LAST_NAME,
PER_BIRTH_DATE,
PER_WEIGHT_KG,
PER_HEIGHT_M
from PERSON
where PER_ID = #value#
</select>
</statements>
</sqlMap>
|
可以看到,映射文件主要分为两个部分:模块配置 和 Statement配置。
模块配置包括:
(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 来执行此节点所定义的操作,如:
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来动态获取字段信息,在一定程度上也提升了性能。
IBatisNet开发使用小结 之二
本文示例项目源码下载
动软代码生成器新增对IBatisNet的代码生成插件