专注于.NET平台的Web开发。

微软轻量级“代码生成器”—Repository Factory使用（下）

上一篇 / 下一篇  2007-12-06 23:16:52 / 个人分类：Software Factory

查看( 111 ) / 评论( 1 ) / 评分( 1 / 0 )

概述

Repository Factory是微软模式与实践小组发布的一个开发指南包，它把之前的Web Service Software Factory（WSSF）集成的Data Access Guidance Package分离出来，形成了一个单独的开发指南包。引用Johnny Halife的话说：“它不是一个对象-关系映射（Object-Relational Mapping，ORM）工具，它的目的是作为一个轻量级的代码生成器，以自动化完成绝大部分生成领域模型对象，并将之持久化到数据库的任务代码。”本文为微软轻量级“代码生成器”—Repository Factory使用下篇。

生成Data Repository 类

接上篇，生成存储过程脚本之后，我们执行脚本，在数据库中生成相应的存储过程。接下来就可以生成Data Repository类了。

Step1：选择Create Data Repository Classes

TerryLee_RF_016

Step2：仍然是指定数据库连接

TerryLee_RF_017

Step3：指定作为数据访问层的项目

TerryLee_RF_018

Step4：指定要生成代码的实体

TerryLee_RF_019

Step5：指定实体和存储过程之间的映射

TerryLee_RF_020

在这一步还可以指定存储过程参数和业务实体属性之间的映射关系

TerryLee_RF_021

Step6：生成代码：

生成Data Repository代码，生成的代码包括Repository接口和实现，分别针对每种操作生成一个工厂类。

生成的IDimCustomerRepository类：

public interfaceIDimCustomerRepository{List<DimCustomer> GetAllFromDimCustomer();voidAdd(DimCustomerdimCustomer);voidRemove(System.Int32customerKey);voidSave(DimCustomerdimCustomer);

}

生成的DimCustomerRepository类：

public classDimCustomerRepository:Repository<DimCustomer>,IDimCustomerRepository{publicDimCustomerRepository(stringdatabaseName)
        :base(databaseName)
    {
    }publicDimCustomerRepository()
        :base()
    {
    }publicList<DimCustomer> GetAllFromDimCustomer()
    {ISelectionFactory<NullableIdentity> selectionFactory =newGetAllFromDimCustomerSelectionFactory();try{NullableIdentitynullableIdentity =newNullableIdentity();return base.Find(selectionFactory,newGetAllFromDimCustomerFactory(), nullableIdentity);
        }catch(SqlExceptionex)
        {
            HandleSqlException(ex, selectionFactory);
        }return newList<DimCustomer>();
    }public voidAdd(DimCustomerdimCustomer)
    {DimCustomerInsertFactoryinsertFactory =newDimCustomerInsertFactory();try{base.Add(insertFactory, dimCustomer);
        }catch(SqlExceptionex)
        {
            HandleSqlException(ex, insertFactory);
        }
    }public voidRemove(System.Int32customerKey)
    {IDeleteFactory<System.Int32> deleteFactory =newDimCustomerDeleteFactory();try{base.Remove(deleteFactory, customerKey);
        }catch(SqlExceptionex)
        {
            HandleSqlException(ex, deleteFactory);
        }
    }public voidSave(DimCustomerdimCustomer)
    {DimCustomerUpdateFactoryupdateFactory =newDimCustomerUpdateFactory();try{base.Save(updateFactory, dimCustomer);
        }catch(SqlExceptionex)
        {
            HandleSqlException(ex, updateFactory);
        }
    }private voidHandleSqlException(SqlExceptionex,IDbToBusinessEntityNameMappermapper)
    {if(ex.Number ==ErrorCodes.SqlUserRaisedError)
        {switch(ex.State)
            {caseErrorCodes.ValidationError:string[] messageParts = ex.Errors[0].Message.Split(':');throw newRepositoryValidationException(
                        mapper.MapDbParameterToBusinessEntityProperty(messageParts[0]),
                        messageParts[1], ex);caseErrorCodes.ConcurrencyViolationError:throw newConcurrencyViolationException(ex.Message, ex);

            }
        }throw newRepositoryFailureException(ex);
    }
}

DimCustomerInsertFactory类：

internal classDimCustomerInsertFactory:IDbToBusinessEntityNameMapper,IInsertFactory<DimCustomer>
{/// <summary>
    ///Creates the DimCustomerInsertFactory to build an insert statement for///the given DimCustomer object./// </summary>
    /// <param name="DimCustomer">New DimCustomer to insert into the database.</param>publicDimCustomerInsertFactory()
    {
    }#regionIInsertFactory<DimCustomer> MemberspublicDbCommandConstructInsertCommand(Databasedb,DimCustomerdimCustomer)
    {DbCommandcommand = db.GetStoredProcCommand("dbo.InsertDimCustomer");if(dimCustomer.AddressLine1 !=null)
        {
            db.AddInParameter(command,"addressLine1",DbType.String, dimCustomer.AddressLine1);
        }if(dimCustomer.AddressLine2 !=null)
        {
            db.AddInParameter(command,"addressLine2",DbType.String, dimCustomer.AddressLine2);
        }if(dimCustomer.BirthDate !=null)
        {
            db.AddInParameter(command,"birthDate",DbType.DateTime, dimCustomer.BirthDate);
        }if(dimCustomer.CommuteDistance !=null)
        {
            db.AddInParameter(command,"commuteDistance",DbType.String, dimCustomer.CommuteDistance);
        }if(dimCustomer.CustomerAlternateKey !=null)
        {
            db.AddInParameter(command,"customerAlternateKey",DbType.String, dimCustomer.CustomerAlternateKey);
        }
        db.AddOutParameter(command,"customerKey",DbType.Int32, 4);if(dimCustomer.DateFirstPurchase !=null)
        {
            db.AddInParameter(command,"dateFirstPurchase",DbType.DateTime, dimCustomer.DateFirstPurchase);
        }if(dimCustomer.EmailAddress !=null)
        {
            db.AddInParameter(command,"emailAddress",DbType.String, dimCustomer.EmailAddress);
        }if(dimCustomer.EnglishEducation !=null)
        {
            db.AddInParameter(command,"englishEducation",DbType.String, dimCustomer.EnglishEducation);
        }if(dimCustomer.EnglishOccupation !=null)
        {
            db.AddInParameter(command,"englishOccupation",DbType.String, dimCustomer.EnglishOccupation);
        }if(dimCustomer.FirstName !=null)
        {
            db.AddInParameter(command,"firstName",DbType.String, dimCustomer.FirstName);
        }if(dimCustomer.FrenchEducation !=null)
        {
            db.AddInParameter(command,"frenchEducation",DbType.String, dimCustomer.FrenchEducation);
        }if(dimCustomer.FrenchOccupation !=null)
        {
            db.AddInParameter(command,"frenchOccupation",DbType.String, dimCustomer.FrenchOccupation);
        }if(dimCustomer.Gender !=null)
        {
            db.AddInParameter(command,"gender",DbType.String, dimCustomer.Gender);
        }if(dimCustomer.GeographyKey !=null)
        {
            db.AddInParameter(command,"geographyKey",DbType.Int32, dimCustomer.GeographyKey);
        }if(dimCustomer.HouseOwnerFlag !=null)
        {
            db.AddInParameter(command,"houseOwnerFlag",DbType.String, dimCustomer.HouseOwnerFlag);
        }if(dimCustomer.LastName !=null)
        {
            db.AddInParameter(command,"lastName",DbType.String, dimCustomer.LastName);
        }if(dimCustomer.MaritalStatus !=null)
        {
            db.AddInParameter(command,"maritalStatus",DbType.String, dimCustomer.MaritalStatus);
        }if(dimCustomer.MiddleName !=null)
        {
            db.AddInParameter(command,"middleName",DbType.String, dimCustomer.MiddleName);
        }if(dimCustomer.NameStyle. !=null)
        {
            db.AddInParameter(command,"nameStyle",DbType.Boolean, dimCustomer.NameStyle);
        }if(dimCustomer.NumberCarsOwned !=null)
        {
            db.AddInParameter(command,"numberCarsOwned",DbType.Byte, dimCustomer.NumberCarsOwned);
        }if(dimCustomer.NumberChildrenAtHome !=null)
        {
            db.AddInParameter(command,"numberChildrenAtHome",DbType.Byte, dimCustomer.NumberChildrenAtHome);
        }
//......
returncommand;
    }public voidSetNewID(Databasedb,DbCommandcommand,DimCustomerdimCustomer)
    {
        System.Int32id1 = (System.Int32)(db.GetParameterValue(command,"customerKey"));
        dimCustomer.CustomerKey = id1;

    }#endregion

    #regionIDbToBusinessEntityNameMapper Memberspublic stringMapDbParameterToBusinessEntityProperty(stringdbParameter)
    {switch(dbParameter)
        {case"addressLine1":return"AddressLine1";case"addressLine2":return"AddressLine2";case"birthDate":return"BirthDate";case"commuteDistance":return"CommuteDistance";case"customerAlternateKey":return"CustomerAlternateKey";case"dateFirstPurchase":return"DateFirstPurchase";case"emailAddress":return"EmailAddress";//......
default:throw newRepositoryInvalidParameterException(dbParameter);
        }
    }#endregion}

并且会在配置文件中，自动配置Repository接口和实现之间的关系：

<?xmlversion="1.0"encoding="utf-8"?>
<configuration>
  <configSections>
    <sectionname="repositoryFactory"type="Microsoft.Practices.Repository.Configuration.RepositoryFactorySection, Microsoft.Practices.Repository, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"/>
  </configSections>
  <connectionStrings>
    <addname="RFConnectionString"connectionString="Data Source=Esint-lhj\Sql2005;Initial Catalog=AdventureWorksDW;Persist Security Info=True;User ID=sa;Password=sql2005"providerName="System.Data.SqlClient"/>
  </connectionStrings>
  <repositoryFactory>
    <repositories>
      <addinterfaceType="RepositoryFactoryDemo2.IDimEmployeeRepository, RepositoryFactoryDemo2"repositoryType="RepositoryFactoryDemo2.DimEmployeeRepositoryArtifacts.DimEmployeeRepository, RepositoryFactoryDemo2"/>
      <addinterfaceType="RepositoryFactoryDemo2.IDimCustomerRepository, RepositoryFactoryDemo2"repositoryType="RepositoryFactoryDemo2.DimCustomerRepositoryArtifacts.DimCustomerRepository, RepositoryFactoryDemo2"/>
    </repositories>
  </repositoryFactory>
</configuration>

使用生成的代码

如下示例代码所示：

classProgram{static voidMain(string[] args)
    {IDimEmployeeRepositoryrepository =RepositoryFactory.Create<IDimEmployeeRepository>();List<DimEmployee> employees = repository.GetAllFromDimEmployee();
    }
}

自定义生成代码的风格

如果上面生成的代码风格，并不适合您现在所在团队的编码规范，譬如说您习惯于以“_”开头来命名业务实体中的私有字段。在Repository Factory中可以自定义生成代码的风格，因为Repository Factory中的代码生成也是基于模板引擎的，您可以通过修改模板来完成自定义生成代码的风格。打开<安装目录>\Microsoft Patterns & Practices\Data Access Guidance Package Setup\Templates，就可以看到生成代码所使用的模板了。模板编写说明：

1.以<#@ Template Language="C#" #>开头来指定一个模板

2.通过Assembly来添加对程序集的引用

<#@ Assembly Name="System.dll" #>

3.通过Import来导入命名空间

<#@ Import Namespace="System.Data" #>

4.通过Property来指定输入的参数

<#@ Property Processor="PropertyProcessor" Name="Entities"#>

5.通过include来引入外部的文件

<#@ include file="Templates\T4\Common\NamingHelper.t4" #>

6.完全使用C#语言来编写代码，是不是也可以通过<#@ Template Language="C#" #>来指定使用VB.NET编写，我没做过尝试:)

<# foreach(Property property in entity.Properties)
3v,Y(s+bef+DV#Ik0{
+p([:?p@'Ef*o0#>
w%pikF Zl&P0        private <#= (property.IsNullable && property.Type.IsValueType) ? "Nullable<" + property.Type.ToString() + ">" : property.Type.ToString() #> <#= GetFieldName(property.Name) #>;       ITPUB个人空间4xM8D)XE:T;QU
        public <#= (property.IsNullable && property.Type.IsValueType) ? "Nullable<" + property.Type.ToString() + ">" : property.Type.ToString() #> <#= property.Name #>
6H\e%zA1m_P ]0        {ITPUB个人空间x-tj;M K A
            get { return this.<#= GetFieldName(property.Name) #>; }
Y\%rG!gk0<#
&P!X.L1}2pk|eM3y8c0if(!property.ReadOnly)ITPUB个人空间n&N.c|af9p
{
/LF_3Tr }Y0#>
8{7Ue5H!t5sW0            set { this.<#= GetFieldName(property.Name) #> = value; }
Y1[u]}'NsD0<#
2m u_%_2D S.gk)e0}
4[B,BO$c#D$q&t"Tg0#>ITPUB个人空间Xe\|4_#oJ
  }

譬如，想在生成的业务实体私有字段前都加上下划线“_”，可以打开NamingHelper.t4文件，修改其中的GetFieldName方法如下：

private string GetFieldName(string type)ITPUB个人空间WBIZV r-J
{ITPUB个人空间p~ HKTcr
    return "_" + NamingHelper.GetFieldName(type);ITPUB个人空间~J/VJTi#n3KF~
}

这时再使用Repository Factory时可以看到生成的代码如下，私有字段命名前都加上“_”：

privateSystem.String_classField;publicSystem.StringClass
{get{return this._classField; }set{this._classField =value; }
}privateSystem.String_colorField;publicSystem.StringColor
{get{return this._colorField; }set{this._colorField =value; }
}

结束语

通过Repository Factory我们可以很方便的生成自己的数据访问层，减少重复的体力劳动，并且支持灵活的自定义功能。

祝大家编程愉快:)

参考：微软轻量级“代码生成器”—Repository Factory使用（上）


全部脚印 不留脚印 留下脚印:

导入论坛 引用链接 收藏 分享给好友 推荐到圈子 管理 举报

TAG: client factory software web 代码生成

引用 删除 Guest   /   2008-02-27 22:43:58
评 1 分
 

评分：0

我来说两句

显示全部

:loveliness: :handshake :victory: :funk: :time: :kiss: :call: :hug: :lol :'( :Q :L ;P :$ :P :o :@ :D :( :)

Open Toolbar