在Entity Framework中使用存储过程（一）：实现存储过程的自动映射

之前给自己放了一个比较长的假期，在这期间基本上没怎么来园子逛。很多朋友的留言也没有一一回复，在这里先向大家道个歉。最近一段时间的工作任务是如何将ADO.NET Entity Framework 4.0（以下简称EF）引入到我们的开发框架，进行相应的封装、扩展，使之成为一个符合在特定场景下进行企业级快速开发的ORM。在此过程中遇到了一些挑战，也有一些心得。为了向大家分享这些心得，也为了借助大家的脑袋解决我们遇到的问题，接下来我会写一系列相关的文章。这些文章的读者适合那些对EF有基本了解的人。

第一个主题是关于在EF中使用存储过程的问题。我们知道EF不仅仅支持将一个存储过程（或者用户定义函数）转变成方法，也可以为每一个实体的映射三个Function（ADO.NET Entity Framework的术语，将存储过程和用户自定义函数统称为Function）：InsertFunction、UpdateFunction和DeleteFunction，分别用于执行添加、修改和删除操作。虽然通过VS提供的设计器，我们很容易实现存储过程的导入和映射。但是，如果模型中实体和实体属性（数据表中的列）过多，这是一项很繁琐并且容易出错的工作。这篇文章就是如何避免这种烦琐的操作，实现存储过程映射的自动化。[Source Code从这里下载]

目录
一、使用存储过程的必要性
二、实现存储过程自动匹配的必要条件
三、通过T4生成新的.edmx模型
四、看看生成出来的.emdx
五、局限性

一、使用存储过程的必要性

我们知道EF通过元数据，即概念模型（Concept Model）、存储模型（Storage Model）和概念/存储映射（C/S Mapping），和状态追踪（State Tracking）机制可以为基于模型的操作自动生成SQL。对于一些简单的项目开发，这是非常理想的，因为他们完全可以不用关注数据存储层面的东西，你可以采用一些完全不具有数据库知识的开发者。但是理想总归是理想，对于企业级开发来说，我们需要的是对数据库层面数据的操作有自己的控制。在这方面，我们可以随便举两个典型的场景：

• 逻辑删除：对于一些重要的数据，我们可能需要让它们永久保存。当我们试图“删除”这些数据的时候，我们并不是将它们从数据表中移除（物理删除），而是为这条记录作一个已经被删除的标记；
• 并发处理：为了解决相同的数据在获取和提交这段时间内被另一个用户修改或者删除，我们往往SQL层面增加并发控制的逻辑。比较典型的做法是在每一个表中添加一个VersionNo这样的字段，你可以采用TimeStamp，也可以直接采用INT或者GUID。在执行Update或者Delete的SQL中判断之前获取的VersionNo是否和当前的一致。

让解决这些问题，就不能使用EF为我们自动生成的SQL，只有通过使用我们自定义的存储过程。

二、实现存储过程自动匹配的必要条件

本篇文章提供的存储过程自动映射机制是通过代码生成的方式完成的。说白了，就是读取原来的.edmx模型文件，通过分析在存储模型中使用的数据表，导入基于该表的CUD存储过程；然后再概念/存储映射节点中添加实体和这些存储过程的映射关系。那实现这样的代码生成，需要具有如下三个固定的映射规则。

• 数据表名-存储过程名：这个映射关系帮助我们通过存储模型中的实体名找到对应CUD三个存储过程（如果实体是数据表）；
• 数据表列名-存储过程参数名：当存储过程被执行的时候，通过这个映射让概念模型实体某个属性值作为对应的参数；
• 存储过程参数名-版本：当进行参数赋值的时候，通过这个映射决定是使用Original或者Current版本。

在实际的开发过程中，这样的标准存储过程一般都是通过代码生成器生成的（在我的文章《创建代码生成器可以很简单：如何通过T4模板生成代码？[下篇]》中有过相应的实现），它们具有这样的映射关系。

基于这三种映射关系，我定义了如下一个名为IProcedureNameConverter的接口。其中OperationKind是我自定义的一个表示CUD操作类型的枚举。

public interface IProcedureNameConverter
{
    string GetProcedureName(string tableName, OperationKind operationKind);
    string GetColumnName(string parameterName);
    DataRowVersion GetVersion(string parameterName);
}

public enum OperationKind
{
    Insert,
    Update,
    Delete
}

按照我们当前项目采用的命名规范，我定义了如下一个默认的DefaultNameConverter。它体现的是这样的映射关系，比如有个数据表明为T_USER（大写，单词之间用“_”隔开，并以T_为前缀），它对应的CUD存储过程名分别为：P_USER_I、P_USER_U和P_USER_D（大写，以代表存储过程的P_为前缀，后缀_I/U/D表示CUD操作类型，中间为去除前缀的表名）。如果列名为USER_ID，参数名为p_user_id（小写，加p_前缀）。如果需要用Original值为参数赋值，需要将p_前缀改成o_前缀（o_user_id）。

public class DefaultNameConverter: IProcedureNameConverter
{
    public string GetProcedureName(string tableName, OperationKind operationKind)
    {
        switch (operationKind)
        {
            case OperationKind.Insert:
                return string.Format("P_{0}_I", tableName.Substring(2));
            case OperationKind.Update:
                return string.Format("P_{0}_U", tableName.Substring(2));
            default:
                return string.Format("P_{0}_D", tableName.Substring(2));
        }
    }

    public string GetColumnName(string parameterName)
    {
        return parameterName.Substring(2).ToUpper();
    }

    public DataRowVersion GetVersion(string parameterName)
    {
        if(parameterName.StartsWith("o"))
        {
            return DataRowVersion.Original;
        }
        else
        {
            return DataRowVersion.Current;
        }
    }
}

三、通过T4生成新的.edmx模型

我们采用的基于T4的代码生成，了解EF的应该对T4不会感到陌生了。如果对代码生成感兴趣的话，可以看看我的文章《与VS集成的若干种代码生成解决方案[博文汇总(共8篇)]》。这里利用借助于T4 ToolBox这个开源工具箱，并采用SQL Server SMO获取存储过程信息。所有涉及到的文本转化都实现在如下一个ProcedureMappingTemplate类型中，由于内容较多，具体实现就忽略了，有兴趣的朋友可能下载源代码。ProcedureMappingTemplate具有两个构造函数的参数分别表示：源.edmx文件，服务器和数据库名，存储过程的Schema（默认为dbo）和具体的ProcedureNameConverter（默认为DefaultNameConverter）。

public class ProcedureMappingTemplate: Template
{
    public XmlDocument SourceModel { get; private set; }
    public IProcedureNameConverter ProcedureNameConverter { get; private set; }
    public Database Database { get; private set; }
    public string Schema { get; private set; }

    public ProcedureMappingTemplate(string sourceModelFile, string serverName, string databaseName);
    public ProcedureMappingTemplate(string sourceModelFile, string serverName, string databaseName,
        IProcedureNameConverter procedureNameConverter, string schema);

    protected virtual XElement GenerateStorageModelNode();
    protected virtual XElement GenerateMappingNode();
    public override string TransformText()
    {
        XElement newStorageModelNode = this.GenerateStorageModelNode();
        XElement newMappingNode = this.GenerateMappingNode();

        XmlNode storageModelNode = this.SourceModel.GetElementsByTagName("edmx:StorageModels")[0];
        storageModelNode.InnerXml = newStorageModelNode.Elements().ToArray()[0].ToString();

        XmlNode mappingNode = this.SourceModel.GetElementsByTagName("edmx:Mappings")[0];
        mappingNode.InnerXml = newMappingNode.Elements().ToArray()[0].ToString();

        this.WriteLine("<?xml version=\"1.0\" encoding=\"utf-8\"?>");
        this.Write(this.SourceModel.DocumentElement.OuterXml.Replace("xmlns=\"\"",""));
        return GenerationEnvironment.ToString();
    }
}

在使用过程中，你只需要在tt模板中创建这个ProcedureMappingTemplate对象，调用Render方法即可。

<#@ template  debug="true" hostSpecific="true" #>
<#@ output extension=".edmx" #>
<#@ assembly name="Microsoft.SqlServer.ConnectionInfo" #>
<#@ assembly name="Microsoft.SqlServer.Smo" #>
<#@ assembly name="Microsoft.SqlServer.Management.Sdk.Sfc" #>
<#@ assembly name="$(TargetDir)Artech.ProcedureMapping.dll" #>
<#@ import namespace="Artech.ProcedureMapping" #>
<#@ include file="T4Toolbox.tt" #>
<#
new ProcedureMappingTemplate(this.Host.ResolvePath("UserModel.edmx"),".","EFExtensions").Render();
#>

四、看看生成出来的.emdx

通过上面创建的TT模板（你指定的数据库中一定要存在具有相应映射关系的存储过程），新的.edmx模型文件会作为该tt文件的依赖文件被生成出来。而这个新生成的.edmx具有存储过程映射信息。具体来说，下面是原始的.edmx文件（只保留元数据节点）。

<?xml version="1.0" encoding="utf-8"?>
<edmx:Edmx Version="2.0" xmlns:edmx="http://schemas.microsoft.com/ado/2008/10/edmx">
  <!-- EF Runtime content -->
  <edmx:Runtime>
    <!-- SSDL content -->
    <edmx:StorageModels>
      <Schema Namespace="Artech.UserModel.Store" Alias="Self" Provider="System.Data.SqlClient" ProviderManifestToken="2008" xmlns:store="http://schemas.microsoft.com/ado/2007/12/edm/EntityStoreSchemaGenerator" xmlns="http://schemas.microsoft.com/ado/2009/02/edm/ssdl">
        <EntityContainer Name="ArtechUserModelStoreContainer">
          <EntitySet Name="T_USER" EntityType="Artech.UserModel.Store.T_USER" store:Type="Tables" Schema="dbo" />
        </EntityContainer>
        <EntityType Name="T_USER">
          <Key>
            <PropertyRef Name="USER_ID" />
          </Key>
          <Property Name="USER_ID" Type="varchar" Nullable="false" MaxLength="50" />
          <Property Name="USER_NAME" Type="nvarchar" Nullable="false" MaxLength="50" />
        </EntityType>
      </Schema>
    </edmx:StorageModels>
    <!-- CSDL content -->
    <edmx:ConceptualModels>
      <Schema Namespace="Artech.UserModel" Alias="Self" xmlns:annotation="http://schemas.microsoft.com/ado/2009/02/edm/annotation" xmlns="http://schemas.microsoft.com/ado/2008/09/edm">
        <EntityContainer Name="EFExtensionsEntities" annotation:LazyLoadingEnabled="true">
          <EntitySet Name="Users" EntityType="Artech.UserModel.User" />
        </EntityContainer>
        <EntityType Name="User">
          <Key>
            <PropertyRef Name="ID" />
          </Key>
          <Property Name="ID" Type="String" Nullable="false" MaxLength="50" Unicode="false" FixedLength="false" />
          <Property Name="Name" Type="String" Nullable="false" MaxLength="50" Unicode="true" FixedLength="false" />
        </EntityType>
      </Schema>
    </edmx:ConceptualModels>
    <!-- C-S mapping content -->
    <edmx:Mappings>
      <Mapping Space="C-S" xmlns="http://schemas.microsoft.com/ado/2008/09/mapping/cs">
        <EntityContainerMapping StorageEntityContainer="ArtechUserModelStoreContainer" CdmEntityContainer="EFExtensionsEntities">
          <EntitySetMapping Name="Users">
            <EntityTypeMapping TypeName="Artech.UserModel.User">
              <MappingFragment StoreEntitySet="T_USER">
                <ScalarProperty Name="ID" ColumnName="USER_ID" />
                <ScalarProperty Name="Name" ColumnName="USER_NAME" />
              </MappingFragment>
            </EntityTypeMapping>
          </EntitySetMapping>
        </EntityContainerMapping>
      </Mapping>
    </edmx:Mappings>
  </edmx:Runtime>
</edmx:Edmx>

这是新生成的.edmx文件中的XML。

<?xml version="1.0" encoding="utf-8"?>
<edmx:Edmx Version="2.0" xmlns:edmx="http://schemas.microsoft.com/ado/2008/10/edmx">
  <!-- EF Runtime content -->
  <edmx:Runtime>
    <!-- SSDL content -->
    <edmx:StorageModels>
      <Schema Namespace="Artech.UserModel.Store" Alias="Self" Provider="System.Data.SqlClient" ProviderManifestToken="2008" xmlns:store="http://schemas.microsoft.com/ado/2007/12/edm/EntityStoreSchemaGenerator" xmlns="http://schemas.microsoft.com/ado/2009/02/edm/ssdl">
        <EntityContainer Name="ArtechUserModelStoreContainer">
          <EntitySet Name="T_USER" EntityType="Artech.UserModel.Store.T_USER" store:Type="Tables" Schema="dbo" />
        </EntityContainer>
        <EntityType Name="T_USER">
          <Key>
            <PropertyRef Name="USER_ID" />
          </Key>
          <Property Name="USER_ID" Type="varchar" Nullable="false" MaxLength="50" />
          <Property Name="USER_NAME" Type="nvarchar" Nullable="false" MaxLength="50" />
        </EntityType>
        <Function Name="P_USER_I" Aggregate="false" BuiltIn="false" NiladicFunction="false" IsComposable="false" ParameterTypeSemantics="AllowImplicitConversion" Schema="dbo" >
          <Parameter Name="p_user_id" Type="varchar" Mode="In" />
          <Parameter Name="p_user_name" Type="nvarchar" Mode="In" />
        </Function>
        <Function Name="P_USER_U" Aggregate="false" BuiltIn="false" NiladicFunction="false" IsComposable="false" ParameterTypeSemantics="AllowImplicitConversion" Schema="dbo" >
          <Parameter Name="o_user_id" Type="varchar" Mode="In" />
          <Parameter Name="p_user_name" Type="nvarchar" Mode="In" />
        </Function>
        <Function Name="P_USER_D" Aggregate="false" BuiltIn="false" NiladicFunction="false" IsComposable="false" ParameterTypeSemantics="AllowImplicitConversion" Schema="dbo" >
          <Parameter Name="o_user_id" Type="varchar" Mode="In" />
        </Function>
      </Schema>
    </edmx:StorageModels>
    <!-- CSDL content -->
    <edmx:ConceptualModels>
      <Schema Namespace="Artech.UserModel" Alias="Self" xmlns:annotation="http://schemas.microsoft.com/ado/2009/02/edm/annotation" xmlns="http://schemas.microsoft.com/ado/2008/09/edm">
        <EntityContainer Name="EFExtensionsEntities" annotation:LazyLoadingEnabled="true">
          <EntitySet Name="Users" EntityType="Artech.UserModel.User" />
        </EntityContainer>
        <EntityType Name="User">
          <Key>
            <PropertyRef Name="ID" />
          </Key>
          <Property Name="ID" Type="String" Nullable="false" MaxLength="50" Unicode="false" FixedLength="false" />
          <Property Name="Name" Type="String" Nullable="false" MaxLength="50" Unicode="true" FixedLength="false" />
        </EntityType>
      </Schema>
    </edmx:ConceptualModels>
    <!-- C-S mapping content -->
    <edmx:Mappings>
      <Mapping Space="C-S" xmlns="http://schemas.microsoft.com/ado/2008/09/mapping/cs">
        <EntityContainerMapping StorageEntityContainer="ArtechUserModelStoreContainer" CdmEntityContainer="EFExtensionsEntities">
          <EntitySetMapping Name="Users">
            <EntityTypeMapping TypeName="Artech.UserModel.User">
              <MappingFragment StoreEntitySet="T_USER">
                <ScalarProperty Name="ID" ColumnName="USER_ID" />
                <ScalarProperty Name="Name" ColumnName="USER_NAME" />
              </MappingFragment>
            </EntityTypeMapping>
            <EntityTypeMapping TypeName="Artech.UserModel.User" >
              <ModificationFunctionMapping>
                <InsertFunction FunctionName="Artech.UserModel.Store.P_USER_I">
                  <ScalarProperty Name="ID" ParameterName="p_user_id" />
                  <ScalarProperty Name="Name" ParameterName="p_user_name" />
                </InsertFunction>
                <UpdateFunction FunctionName="Artech.UserModel.Store.P_USER_U">
                  <ScalarProperty Name="ID" ParameterName="o_user_id" Version="Original" />
                  <ScalarProperty Name="Name" ParameterName="p_user_name" Version="Current" />
                </UpdateFunction>
                <DeleteFunction FunctionName="Artech.UserModel.Store.P_USER_D">
                  <ScalarProperty Name="ID" ParameterName="o_user_id" />
                </DeleteFunction>
              </ModificationFunctionMapping>
            </EntityTypeMapping>
          </EntitySetMapping>
        </EntityContainerMapping>
      </Mapping>
    </edmx:Mappings>
  </edmx:Runtime>
</edmx:Edmx>

顺便来看看.edmx中的数据表T_USER（只具有两个字段USER_ID和USER_NAME）和对应CUD存储过程的SQL。

CREATE TABLE [dbo].[T_USER]
(
    [USER_ID]   VARCHAR(50) PRIMARY KEY,
    [USER_NAME] NVARCHAR(50) NOT NULL
)
GO

CREATE PROCEDURE [dbo].[P_USER_I]
@p_user_id        VARCHAR(50),
@p_user_name    NVARCHAR(50)

AS
BEGIN
    INSERT T_USER(USER_ID, USER_NAME)
    VALUES(@p_user_id,@p_user_name)
END
GO

CREATE PROCEDURE [dbo].[P_USER_U]
@o_user_id        VARCHAR(50),
@p_user_name    NVARCHAR(50)

AS
BEGIN
    UPDATE T_USER
    SET USER_NAME = @p_user_name
    WHERE USER_ID = @o_user_id
END
GO
CREATE PROCEDURE [dbo].[P_USER_D]
@o_user_id    VARCHAR(50)

AS
BEGIN
    DELETE T_USER
    WHERE USER_ID = @o_user_id
END

五、局限性

EF最大的好处就是实现了概念模型和存储模型的分离。你可以为概念实体和存储实体起不同的名称，还可以将一个概念实体映射到多个存储实体，反之亦然。还可以建立概念实体的之间的继承关系。而我们这里提供的存储过程的自动映射机制，却依赖于我们预定义的标准存储过程。换句话说，我们的存储过程是完全依赖与存储模型的，而最终我们需要建立概念模型与存储过程之间的映射，当然会出现问题。

所以这种依赖于标准存储过程的映射机制基本上只能适用于概念模型与存储模型结构一致的情况。但是我相信在真正的开发中，很多人还是采用基于数据库生成.edmx模型的开发发生。如果你不对概念模型的结构（比如拆分、继承）作调整，你可以直接采用本文提供的自动映射机制。如果你需要对概念模型的结构作局部调整，由于我们生成的还是.edmx文件，你可以直接在这上面作调整。

总之一句话，如果你的概念模型和存储模型的结构相差不大，这样的自动存储过程映射机制才有意义。

在Entity Framework中使用存储过程（一）：实现存储过程的自动映射
在Entity Framework中使用存储过程（二）：具有继承关系实体的存储过程如何定义？
在Entity Framework中使用存储过程（三）：逻辑删除的实现与自增长列值返回
在Entity Framework中使用存储过程（四）：如何为Delete存储过程参数赋上Current值？
在Entity Framework中使用存储过程（五）：如何通过存储过程维护多对多关系？