（PDF.NET框架实例讲解）将存储过程映射为实体类

PDF.NET数据开发框架可以将表，视图，表值函数，自定义的查询语句和存储过程映射为实体类，在上一篇《（PDF.NET框架实例讲解）将任意复杂的SQL查询映射成实体类 》已经讲解了自定义查询的实体类映射方法，今天来讲讲存储过程的映射操作。

 

1，使用代码工具，生成实体类代码

具体过程跟“上一篇”文章中的步骤1-4一样，请参见原文。

 

 

注意为了获得存储过程的表架构，需要在下图的窗口中输入类似的代码：

exec 存储过程名称 参数值1，参数值2

 

这里我们输入

 

exec GetExcellentDetails 'A',3

 

查询名称和实体类名称都输入为“InvestmentSolutionData”，在我们的Model项目下面将会生成一个文件 InvestmentSolutionData.cs

 

2，修改刚才生成的实体类文件，设置“映射为存储过程”：

 

  public partial class InvestmentSolutionData : EntityBase
  {
    public InvestmentSolutionData()
    {
            TableName = "WStModel.Entitys.InvestmentSolutionData";
            EntityMap=EntityMapType.StoredProcedure;
            //IdentityName = "标识字段名";

            //PrimaryKeys.Add("主键字段名");
         
    }
//其它属性略
}

 

也就是这一句：EntityMap=EntityMapType.StoredProcedure

 

3，修改刚才生成的实体查询配置文件 EntitySqlMap.config

修改前：

 

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <Namespace name="DemoNameSpace">
    <Map name="DemoSqlName">
      <Sql><![CDATA[ select * from table ]]></Sql>
    </Map>
  </Namespace>
  <Namespace name="WStModel.Entitys">
    <Map name="InvestmentSolutionData">
      <Sql>
        <![CDATA[
     exec GetExcellentDetails 'A',3
     ]]></Sql>
    </Map>
  </Namespace>
</configuration>

 

 修改后：

 

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <Namespace name="DemoNameSpace">
    <Map name="DemoSqlName">
      <Sql><![CDATA[ select * from table ]]></Sql>
    </Map>
  </Namespace>
  <Namespace name="WStModel.Entitys">
    <Map name="InvestmentSolutionData">
      <Sql>
        <![CDATA[
      GetExcellentDetails 
      #solution:String,String,2#,
      #yield:Int32#
]]></Sql>
    </Map>
  </Namespace>
</configuration>

因为存储过程 GetExcellentDetails  有两个参数，所以需要在这里显式的指明，参数solution 是varchar(2)类型，参数yield 是int 类型，按照SQL-MAP的语法规则（参见《PDF.NET（PWMIS数据开发框架）之SQL-MAP目标和规范 》），改写成上面的样子。（注：之所以要用该语法，是为了屏蔽具体数据库的差异） 

 

4，编写代码，使用“存储过程”实体类

使用“存储过程”实体类跟使用其它类型的实体类比较类似，但存储过程可能有参数，所以需要初始化参数值，实例代码如下所示：

 

        public IEnumerable<IInvestmentSolutionData> GetSolutionData(string solutionName,int period)
        {
            //InvestmentSolutionData 为存储过程实体类
            InvestmentSolutionData entity = new InvestmentSolutionData();
            OQL q = new OQL(entity);
            q.InitParameters = new Dictionary<string, object>();
            q.InitParameters.Add("solution", solutionName);
            q.InitParameters.Add("yield", period);
            //执行查询
            q.Select();
            List<InvestmentSolutionData> list = EntityQuery<InvestmentSolutionData>.QueryList(q);
            return list;
        }

上面的例子中，调用了OQL对象的InitParameters 属性，初始化实体类查询需要的值。

 

目前，PDF.NET的代码生成器还不能自动生成以上代码，如果要“享受自动生成代码”的过程，则需要使用框架的“SQL-MAP”技术，参见《抽象SQL（参数化）查询 》一文。不过使用本文介绍的“存储过程”实体类映射技术，在使用方式上更灵活，至少你不用单独去生成一个DAL层了。

 

注：本文所说的功能需要在PDF.NET 4.1以上支持，PDF.NET本身仅需要.net 2.0支持，框架的最新版本没有公开发布，但已经有不少用户正在项目里面使用，有关框架的详细信息请看官网介绍： http://www.pwmis.com/sqlmap