PWMIS DataAccess Framework For .NET

PWMIS DataAccess Framework  For .NET (PDF.NET)

PWMIS 数据处理框架：在公司做了一年多的关于.NET 架构方面的研究后，最近作 www.Pwmis.cn 网站的架构设计，考虑到以后可能需要网站支持SqlServer或者其它数据库，想到了DAAB，同时结合在公司一直用的类似IBatis 架构的SqlMap以后，觉得有必要综合这两个技术架构的优点，利用DAAB 3.1 强大灵活的数据访问功能和IBatisNet强大的SqlMap技术架构，推出一个轻量级的数据处理架构，由此命名该架构为

PWMIS DataAccess Framework For .NET (PDF.NET)

下面先介绍架构的核心思想 SqlMap：

顾名思义，就是数据库查询映射，将程序中所有需要用到的Sql语句，包括直接Sql语句，存储过程语句，放到一个单独的配置文件里面，实现数据库查询和程序的分离，降低程序耦合度，有利于程序维护。如果需要改变数据库，那么基本上可以不作修改或者少量修改就可以了。

我们先来看一段示例的配置文件，

<?xml version="1.0" encoding="utf-8" ?>
<!-- PWMIS SqlMap Ver 1.0.1 ,2006.11.7,http://www.pwmis.cn/SqlMap/ -->
<SqlMap>
 <!--Type:支持的数据库类型 -->
 <Script Type="Access" Version="2000,2002,2003">
  <CommandClass Name="UserManager" Class="DataAcess.UserManager">
   <Update CommandName="UpdateLoginTimes" CommandType="Text" Method="ChangeEnginState"><![CDATA[
   UPDATE Tb_Common_Login SET LoginTimes = #LoginTimes:Int32# WHERE (LoginUserID = #LoginUserID:String,String,32#  # %Condintion% # )
   ]]></Update>
   <Select CommandName="GetLoginInfo" CommandType="Text" Method="GetLoginInfo"><![CDATA[
   SELECT * FROM Tb_Common_Login WHERE (LoginUserName = # LoginUserName:String,String,50 #)
   ]]></Select>
  </CommandClass>
 </Script>
 <Script Type="SqlServer" Version="2000,2005">
<CommandClass Name="UserManager" Class="DataAcess.UserManager">
   <Update CommandName="UpdateLoginTimes" CommandType="Text" Method="ChangeEnginState"><![CDATA[
   UPDATE Tb_Common_Login SET LoginTimes = #LoginTimes:Int32# WHERE (LoginUserID = #LoginUserID:String,String,32#  # %Condintion% # )
   ]]></Update>
   <Select CommandName="GetLoginInfo" CommandType="Text" Method="GetLoginInfo"><![CDATA[
   SELECT * FROM Tb_Common_Login WHERE (LoginUserName = # LoginUserName:String,String,50 #)
   ]]></Select>
  </CommandClass>
<SqlMap>

一、配置节说明：

1，<Script Type="Access" Version="2000,2002,2003">
表示下面的内容描述的是Access数据库的信息，version 说明了该种数据库的当前使用的版本；Type="SqlServer" 表示使用的是SqlServer数据库；

2， <CommandClass Name="UserManager" Class="DataAcess.UserManager">
该节说明了命名对应的“类”名称和实际所在程序集位置；

3，<Update CommandName="UpdateLoginTimes" CommandType="Text" Method="ChangeEnginState">
说明了当前数据访问类型为"Update"方式，命名名称为UpdateLoginTimes，类型为"Text"，实现该操作的命令成员为ChangeEnginState。该成员就是类中的一个方法。

4，  UPDATE Tb_Common_Login SET LoginTimes = #LoginTimes:Int32# WHERE (LoginUserID = #LoginUserID:String,String,32#  # %Condintion% # )
该部分内容放在 <![CDATA[   ]]>标记中间，主要是为了在中间书写Sql语句中的">" /"<" 等XML不允许的标记。
#LoginTimes:Int32#
表示一个参数，参数名称为 LoginTimes，后面是一个冒号，后面的Int32 表示的是System.Type 类型，比如Int32,Int64,String 等类型；

实际上，PDF.NET的参数定义可以是下面的表示方式:

#ParaName[:System.Type[,System.DbType[,Size[,ParameterDirection]]]]#

"[  ]" 表示可选的内容；

ParaName：查询语句中对应的参数名，如果名称前缀有 @@ 标记，表示该参数是一个替换参数，将忽略后面的定义；
     System.Type：可选，符合CSL规范的类型（CLT）名称；
     System.DbType：可选，符合DbType 的枚举，如 AnsiString 等；
     Size：可选，表示参数长度；
     ParameterDirection：可选，表示参数的输入输出类型的枚举值
     { 常用CLT:Byte,Int16,Int32,Int64,Single,Double,Boolean,Char,Decimal,String
       [关于通用类型系统(CLT):ms-help://MS.VSCC.2003/MS.MSDNQTR.2003FEB.2052/cpguide/html/cpconthecommontypesystem.htm ]
       [DbType 枚举：ms-help://MS.VSCC.2003/MS.MSDNQTR.2003FEB.2052/cpref/html/frlrfSystemDataDbTypeClassTopic.htm ]
     }
   如果 ParameterClass 表示一个参数类，那么ParaName 将对应于SqlMap参数类中的属性

# %Condintion% #

表示一个执行参数“替换”的语句，它不是真正的命名参数，仅仅表示一个需要在运行时用字符串替换的“位置标记”。

二、应用程序映射：

根据上面的SqlMap脚本映射定义，我们可以写一个自动代码工具生成下面的代码：

'使用该程序前请先引用程序集：PWMIS.SqlMapper，并且下面定义的名称空间前缀不要使用ＰＷＭＩＳ

NameSpace MyDAL.SqlServerDAL.DataAcess.DataAcess

'/// <summary>

'/// 文件名：UserManager.vb

'/// 类　名：UserManager

'/// 版　本：1.0

'/// 创建时间：2006-11-28 9:19:44

'/// 用途描述：UserManager

'/// 其它信息：该文件由 PDF.NET Code Maker 自动生成，修改前请先备份！

'/// </summary>

Public Class UserManager

    Inherits PWMIS.SqlMapper.DBMapper

     Sub New()

        Mapper.CommandClassName = "UserManager"

    End Sub

     '/// <summary>

    '/// Function ChangeEnginState:

    '/// </summary>

    '/// <param name="LoginTimes"></param>

    '/// <param name="LoginUserID"></param>

    '/// <returns></returns>

    Function ChangeEnginState(ByVal LoginTimes As Int32 , ByVal LoginUserID As String , ByVal Condintion AS String  ) As Int32

        With Mapper

            '获取命令信息

            .GetCommandInfo("UpdateLoginTimes")

            '参数赋值，推荐使用该种方式；

            .DataParameters(0).Value = LoginTimes

            .DataParameters(1).Value = LoginUserID

            '参数赋值，使用命名方式；

            '.SetParameterValue("@LoginTimes", LoginTimes)

            '.SetParameterValue("@LoginUserID", LoginUserID)

            '执行参数替换

            .SetParameterValue("Condintion", Condintion, SqlMapper.enumParamType.ReplacedText)

            '执行查询

            Return CurrentDataBase.DAO.ExecuteNonQuery(CurrentDataBase.ConnectionString, .CommandType, .CommandText, .DataParameters)

        End With

    End Function

 

    '/// <summary>

    '/// Function GetLoginInfo:

    '/// </summary>

    '/// <param name="LoginUserName"></param>

    '/// <returns></returns>

    Function GetLoginInfo(ByVal LoginUserName As String  ) As DataSet

        With Mapper

            '获取命令信息

            .GetCommandInfo("GetLoginInfo")

            '参数赋值，推荐使用该种方式；

            .DataParameters(0).Value = LoginUserName

            '参数赋值，使用命名方式；

            '.SetParameterValue("@LoginUserName", LoginUserName)

            '执行参数替换

            '执行查询

            Return CurrentDataBase.DAO.ExecuteDataset(CurrentDataBase.ConnectionString, .CommandType, .CommandText, .DataParameters)

        End With

    End Function

 End Class

 End NameSpace

 

看到了吗？名称空间，类，类中的成员，都一一根我们的配置文件相映射了，SqlMap.config 文件已经提供了足够的信息支持代码自动生成工具生成以上代码。下面对上面的代码简单做一个解释：

1，PWMIS.SqlMapper.DBMapper： Class UserManager 的基类，主要包装了数据库访问对象 PWMIS.SqlMapper.DataBase 和 SqlMap对象 PWMIS.SqlMapper.SqlMapper;

2，  Mapper.CommandClassName = "UserManager"
说明当前类对应的配置节申明的命名类名是 "UserManager"；

3， Function UpdateLoginTimes(ByVal LoginTimes As Integer, ByVal LoginUserID As String, ByVal R_Condintion As String) As Integer
参数LoginTimes 和 LoginUserID 的名称和类型是根据配置节信息自动推导出来的，参数 R_Condintion 表示一个替换参数，SqlMap 1.1命名规范规定 "R_" 打头的参数表示一个替换参数；

4，参数赋值方式：有直接赋值方式和命名赋值方式，命名赋值方式需要查找参数名，所以不是推荐的方式。注意在参数赋值前需要先执行 Mapper.GetCommandInfo 命令，分析参数信息；

5，CurrentDataBase.DAO：有多种执行数据库命令的方法，它就是一个DAAB中的Adohelper对象，了解它的人都知道它的灵活和强大之处，这里不再详细说明。

三、代码生成器配置说明：

打开文件 PDFCodeMaker.exe.config，注意下面的配置节：

　

 <add key="CodeTemplatePath" value="..\"></add>
代码模版目录

 <add key="SqlMapConfigFile" value="..\..\TestDAOApp\SqlMap.config"></add>
SqlMap 配置文件名

 <add key="OutPutPath" value="..\AutoCodeFile"></add>
输出代码目录

 <add key="RootNameSpace" value="MyDAL"></add>
生成代码中的自定义根命名空间

 <add key="ReWrite" value="False"></add>
是否允许覆盖以前生成的代码，如果不允许，那么将在输出目录中按照 数据库类型\日期 的目录方式保存

　

今天先到这里，感兴趣的朋友 请在论坛发帖。

bluedoctor 2006.11.12 (Http://www.pwmis.cn/sqlMap/)

完整的演示程序（PDF.NET DEMO）下载：点击下载

PDF.NET DEMO 文件包文件列表说明：
--------------------------------------
bin\PDFCodeMaker.exe 代码生成器
bin\SqlMapBuilder.exe 配置文件管理器
bin\TestDAOApp.exe PDF.NET演示程序
bin\PDFCodeMaker.exe.config 代码生成器配置文件
bin\TestDAOApp.exe.config 演示程序配置文件
\SqlMap.config SQL MAP配置文件
\TestAPP.mdb 演示程序数据库
\VBCodeTemplate.txt VB.NET 代码模板
\使用说明.txt 演示程序说明

--------------------------------------
http://www.pwmis.cn/SqlMap/
2006.11.27