EF架構~為EF DbContext生成的實體添加注釋（T4模板應用）

回到目錄

相關文章系列

第八回　　EF架構~將數據庫注釋添加導入到模型實體類中

第二十一回  EF架構~為EF DbContext生成的實體添加注釋（T4模板應用）

第二十二回  EF架構~為EF DbContext生成的實體添加注釋（T5模板應用）

使用EF架構時，你的實體生成方案有多種，entity object,poco,dbcontext等等，對於entity object方案生成的實體，我們感覺很臃腫，當然它的功能很強在，但有時在查看類實體時，有些麻煩，因為所有實體都在一個類文件中，有點像linq to sql，而它的類格局也與dbml有些雷同，當然這不是今天的重點，今天主要說的是當EDMX文件添加注釋后，如何把注釋同時添加到dbcontext實體上。

方案：修改dbcontext的T4模版

實現：找到以下代碼塊

先為類加注釋

string summary=string.Empty;
foreach (var entity in ItemCollection.GetItems<EntityType>().OrderBy(e => e.Name))
{
    fileManager.StartNewFile(entity.Name + ".cs");
    BeginNamespace(namespaceName, code);
    if(entity.Documentation !=null && entity.Documentation.Summary!=null)
       summary=entity.Documentation.Summary;
     else
        summary=entity.Name;
 #>
/// <summary>
/// <#=summary#>
/// </summary>

 

再為類中的屬性加注釋

void WriteProperty(CodeGenerationTools code, EdmProperty edmProperty)
{}

將原來的代碼刪除，替換成如下代碼

void WriteProperty(CodeGenerationTools code, EdmProperty edmProperty)
{
    if (edmProperty.Documentation != null && edmProperty.Documentation.Summary != null)
    { 
        WriteProperty(Accessibility.ForProperty(edmProperty),
                      code.Escape(edmProperty.Documentation.Summary),
                      code.Escape(edmProperty.TypeUsage),
                      code.Escape(edmProperty),
                      code.SpaceAfter(Accessibility.ForGetter(edmProperty)),
                      code.SpaceAfter(Accessibility.ForSetter(edmProperty)));
    }
    else
    {
        WriteProperty(Accessibility.ForProperty(edmProperty),
                      code.Escape(edmProperty.Name),
                      code.Escape(edmProperty.TypeUsage),
                      code.Escape(edmProperty),
                      code.SpaceAfter(Accessibility.ForGetter(edmProperty)),
                      code.SpaceAfter(Accessibility.ForSetter(edmProperty)));
    }
}

void WriteNavigationProperty(CodeGenerationTools code, NavigationProperty navigationProperty)
{
    var endType = code.Escape(navigationProperty.ToEndMember.GetEntityType());
 if (navigationProperty.Documentation != null && navigationProperty.Documentation.Summary != null)
    { 
    WriteProperty(PropertyVirtualModifier(Accessibility.ForProperty(navigationProperty)),
                  code.Escape(navigationProperty.Documentation.Summary),
                  navigationProperty.ToEndMember.RelationshipMultiplicity == RelationshipMultiplicity.Many ? ("ICollection<" + endType + ">") : endType,
                  code.Escape(navigationProperty),
                  code.SpaceAfter(Accessibility.ForGetter(navigationProperty)),
                  code.SpaceAfter(Accessibility.ForSetter(navigationProperty)));
    }
    else
    {
      WriteProperty(PropertyVirtualModifier(Accessibility.ForProperty(navigationProperty)),
                  code.Escape(navigationProperty.Name),
                  navigationProperty.ToEndMember.RelationshipMultiplicity == RelationshipMultiplicity.Many ? ("ICollection<" + endType + ">") : endType,
                  code.Escape(navigationProperty),
                  code.SpaceAfter(Accessibility.ForGetter(navigationProperty)),
                  code.SpaceAfter(Accessibility.ForSetter(navigationProperty)));
    }
}

void WriteProperty(string accessibility, string summary, string type, string name, string getterAccessibility, string setterAccessibility)
{
#>
    /// <summary>
    /// <#=summary#>
    /// </summary>
    <#=accessibility#> <#=type#> <#=name#> { <#=getterAccessibility#>get; <#=setterAccessibility#>set; }
<#+
}

 

保存后，它會將結果輸出到與TT文件同時的cs文件中，如果模板出現錯誤，也會將錯誤信息輸出到CS文件中，如果成功，就會有如何內容：

//------------------------------------------------------------------------------
// <auto-generated>
//    This code was generated from a template.
//
//    Manual changes to this file may cause unexpected behavior in your application.
//    Manual changes to this file will be overwritten if the code is regenerated.
// </auto-generated>
//------------------------------------------------------------------------------

using System;
using System.Collections.Generic;

而且，你的模型注釋信息會被同時添加到實體上，呵呵。

 回到目錄