MVC實用架構設計（三）——EF-Code First（3）：使用T4模板生成相似代碼

前言

　　經過前面EF的《第一篇》與《第二篇》，我們的數據層功能已經較為完善了，但有不少代碼相似度較高，比如負責實體映射的 EntityConfiguration，負責倉儲操作的IEntityRepository與EntityRepository。而且每添加一個實體類型，就要手動去添加一套相應的代碼，也是比較累的工作。如果能有一個根據實體類型自動生成這些相似度較高的代碼的解決方案，那將會減少大量的無聊的工作。

　　VS提供的“文本模板”（俗稱T4）功能，就是一個較好的解決方案。要添加一個實體類型，只要把實體類型定義好，然后運行一下定義好的T4模板，就可以自動生成相應的類文件。

工具准備

 　　為了更好的使用 T4模板 功能，我們需要給VS安裝如下兩個插件：

• Devart T4 Editor：為VS提供智能提示功能。
• T4 Toolbox：在生成多文件時很有用。

T4代碼生成預熱

單文件生成：HelloWorld.cs

 　　下面，我們先來體驗一個最簡單的T4代碼生成功能，輸出一個最簡單的類文件。

　　首先，在 GMF.Demo.Core.Data中 添加一個名為 T4 的文件夾，用於存放生成本工程內的代碼的T4模板文件。並在其中添加一個名為 HelloWorld.tt的“文本模板”的項。

　　HelloWorld.tt定義如下：

<#@ template debug="false" hostspecific="false" language="C#" #>
<#@ assembly name="System.Core" #>
<#@ import namespace="System.Linq" #>
<#@ import namespace="System.Text" #>
<#@ import namespace="System.Collections.Generic" #>
<#@ output extension=".cs" #>
using System;

namespace GMF.Demo.Core.Data.T4
{
    public class HelloWorld
    {
        private string _word;

        public HelloWorld(string word)
        {
            _word = word;
        }
    }
}

 　　直接保存文件（T4的生成將會在保存模板，模板失去焦點等情況下自動觸發生成。），將會在模板的當前位置生成一個同名的類文件：

　　HelloWorld.cs的內容如下：

using System;

namespace GMF.Demo.Core.Data.T4
{
    public class HelloWorld
    {
        private string _word;

        public HelloWorld(string word)
        {
            _word = word;
        }
    }
}

 　　這樣，我們的HelloWorld之旅就結束了，非常簡單。

多文件生成

　　當前位置方案的方案只能生成如下所示的代碼：

　　生成的文件會與T4模板在同一目錄中，這里就不詳述了，可以參考 蔣金楠 一個簡易版的T4代碼生成"框架" 。

　　本項目的多文件需要生成到指定文件夾中，但又想對T4模板進行統一的管理，T4文件夾里放置T4模板文件，但生成的映射文件EntityConfiguration將放置到文件夾Configurations中，倉儲操作的文件IEntityRepository與EntityRepository將放置到Repositories文件夾中。且生成的代碼文件應能自動的添加到解決方案中，而不是只是在文件夾中存在。

　　要實現此需求，一個簡單的辦法就是通過 T4 Toolbox 來進行生成。想了解 T4 Toolbox 的細節，可以自己使用 ILSpy 來對 T4Toolbox.dll 文件進行反編譯來查看源代碼，如果是通過 T4 Toolbox 是通過VS的插件來安裝的，將在“C:\Users\Administrator\AppData\Local\Microsoft\VisualStudio\11.0\Extensions\dca4f0lt.jdx”文件夾中（我的機器上）。下面，我們直接進行多文件生成的演示。

　　首先，添加一個名為 HelloWorldTemplate.tt 的 T4 Toolbox 的代碼模板。

　　此模板將繼承於 T4 Toolbox 的 CSharpTemplate 類：

<#+
// <copyright file="HelloWorldTemplate.tt" company="郭明鋒@中國">
//  Copyright © 郭明鋒@中國. All Rights Reserved.
// </copyright>

public class HelloWorldTemplate : CSharpTemplate
{
    private string _className;

    public HelloWorldTemplate(string className)
    {
        _className = className;
    }

    public override string TransformText()
    {
#>
using System;

namespace GMF.Demo.Core.Data.T4
{
    public class <#=_className #>
    {
        private string _word;

        public <#=_className #>(string word)
        {
            _word = word;
        }
    }
}
<#+
        return this.GenerationEnvironment.ToString();
    }
}
#>

 　　模板類中定義了一個 className 參數，用於接收一個表示要生成的類名的值。所有生成類的代碼都以字符串的形式寫在重寫的 TransformText 方法中。

　　再定義一個T4模板文件 HelloWorldMulti.tt，用於調用 上面定義的代碼模板進行代碼文件的生成。

<#@ template debug="false" hostspecific="false" language="C#" #>
<#@ assembly name="System.Core" #>
<#@ import namespace="System.IO" #>
<#@ import namespace="System.Linq" #>
<#@ import namespace="System.Text" #>
<#@ import namespace="System.Collections.Generic" #>
<#@ include file="T4Toolbox.tt" #>
<#@ include file="HelloWorldTemplate.tt" #>
<#
    string curPath = Path.GetDirectoryName(Host.TemplateFile);
    string destPath = Path.Combine(curPath, "outPath");
    if(!Directory.Exists(destPath))
    {
        Directory.CreateDirectory(destPath);
    }
    string[] classNames = new[]{"HelloWorld1", "HelloWorld2", "HelloWorld3"};
    foreach(string className in classNames)
    {
        HelloWorldTemplate template = new HelloWorldTemplate(className);
        string fileName = string.Format(@"{0}\{1}.cs", destPath, className);
        template.Output.Encoding = Encoding.UTF8;
        template.RenderToFile(fileName);
    }
 #>

　　以上是整個T4模板的執行方，在執行方中，要引用所有需要用到的類庫文件，命名空間，包含的模板文件等。

　　最后，文件的生成是調用 T4 Toolbox 的Template基類中定義的 RenderToFile(string filename)方法來生成各個文件的，輸入的參數為生成文件的文件全名。在這里，生成將如下所示：

　　outPPath文件夾中生成了 HelloWorld1.cs、HelloWorld2.cs、HelloWorld3.cs 文件，而 HelloWorldMulti.tt 所在文件夾中也會生成一個空的 HelloWorldMulti.cs 類文件。

生成數據層實體相關相似代碼

生成准備

　　我們的生成代碼是完全依賴於業務實體的，所以，需要有一個類來對業務實體的信息進行提取封裝。

 1 namespace GMF.Component.Tools.T4
 2 {
 3     /// <summary>
 4     /// T4實體模型信息類
 5     /// </summary>
 6     public class T4ModelInfo
 7     {
 8         /// <summary>
 9         /// 獲取 模型所在模塊名稱
10         /// </summary>
11         public string ModuleName { get; private set; }
12 
13         /// <summary>
14         /// 獲取 模型名稱
15         /// </summary>
16         public string Name { get; private set; }
17 
18         /// <summary>
19         /// 獲取 模型描述
20         /// </summary>
21         public string Description { get; private set; }
22 
23         public IEnumerable<PropertyInfo> Properties { get; private set; }
24 
25         public T4ModelInfo(Type modelType)
26         {
27             var @namespace = modelType.Namespace;
28             if (@namespace == null)
29             {
30                 return;
31             }
32             var index = @namespace.LastIndexOf('.') + 1;
33             ModuleName = @namespace.Substring(index, @namespace.Length - index);
34             Name = modelType.Name;
35             var descAttributes = modelType.GetCustomAttributes(typeof(DescriptionAttribute), true);
36             Description = descAttributes.Length == 1 ? ((DescriptionAttribute)descAttributes[0]).Description : Name;
37             Properties = modelType.GetProperties();
38         }
39     }
40 }

 　　另外，通過模板生成的代碼，與我們手寫的代碼有如下幾個區別：

1. 手寫代碼可以自由定義，生成代碼是根據模板生成的，必然遵守模板定義的規范。
2. 手寫代碼的修改可以永久保存，生成代碼的修改將會在下次生成后丟失，即生成代碼不應該進行修改。

　　基於以上幾個區別，我提出如下解決方案，來解決生成代碼的修改問題

1. 通過模板生成的類應盡量定義為分部類（partial class），在需要進行修改及擴展的時候可以定義另外的同名分部類來進行修改。
2. 對於需要外部實現的功能，定義分部方法來對外提供擴展。
3. 生成代碼的類文件命名把擴展名由“.cs”更改為“generated.cs”，以區分生成代碼與手寫代碼文件。

生成實體相關相似代碼

生成實體映射配置類

　　實體映射配置類模板 EntityConfigurationTemplate.tt 定義：

<#+
// <copyright file="EntityConfigurationTemplate.tt" company="郭明鋒@中國">
//  Copyright © 郭明鋒@中國. All Rights Reserved.
// </copyright>

public class EntityConfigurationTemplate : CSharpTemplate
{
    private T4ModelInfo _model;
        
    public EntityConfigurationTemplate(T4ModelInfo model)
    {
        _model = model;
    }

    /// <summary>
    /// 獲取 生成的文件名，根據模型名定義
    /// </summary>
    public string FileName
    {
        get
        { 
            return string.Format("{0}Configuration.generated.cs", _model.Name);
        }
    }

    public override string TransformText()
    {
#>
//------------------------------------------------------------------------------
// <auto-generated>
//     此代碼由工具生成。
//     對此文件的更改可能會導致不正確的行為，並且如果
//     重新生成代碼，這些更改將會丟失。
//        如存在本生成代碼外的新需求，請在相同命名空間下創建同名分部類實現 <#= _model.Name #>ConfigurationAppend 分部方法。
// </auto-generated>
//
// <copyright file="<#= _model.Name #>Configuration.generated.cs">
//        Copyright(c)2013 GMFCN.All rights reserved.
//        CLR版本：4.0.30319.239
//        開發組織：郭明鋒@中國
//        公司網站：http://www.gmfcn.net
//        所屬工程：GMF.Demo.Core.Data
//        生成時間：<#= DateTime.Now.ToString("yyyy-MM-dd HH:mm") #>
// </copyright>
//------------------------------------------------------------------------------

using System;
using System.Data.Entity.ModelConfiguration;
using System.Data.Entity.ModelConfiguration.Configuration;

using GMF.Component.Data;
using GMF.Demo.Core.Models;


namespace GMF.Demo.Core.Data.Configurations
{
    /// <summary>
    /// 實體類-數據表映射——<#= _model.Description #>
    /// </summary>    
    internal partial class <#= _model.Name #>Configuration : EntityTypeConfiguration<<#= _model.Name #>>, IEntityMapper
    {
        /// <summary>
        /// 實體類-數據表映射構造函數——<#= _model.Description #>
        /// </summary>
        public <#= _model.Name #>Configuration()
        {
            <#= _model.Name #>ConfigurationAppend();
        }
        
        /// <summary>
        /// 額外的數據映射
        /// </summary>
        partial void <#= _model.Name #>ConfigurationAppend();
        
        /// <summary>
        /// 將當前實體映射對象注冊到當前數據訪問上下文實體映射配置注冊器中
        /// </summary>
        /// <param name="configurations">實體映射配置注冊器</param>
        public void RegistTo(ConfigurationRegistrar configurations)
        {
            configurations.Add(this);
        }
    }
}
<#+
        return this.GenerationEnvironment.ToString();
    }
}
#>

 　　生成模板調用方 EntityCodeScript.tt 定義

<#@ template language="C#" debug="True" #>
<#@ output extension="cs" #>
<#@ Assembly Name="System.Core" #>
<#@ Assembly Name="$(SolutionDir)\GMF.Component.Tools\bin\Debug\GMF.Component.Tools.dll" #>
<#@ import namespace="System.IO" #>
<#@ Import Namespace="System.Linq" #>
<#@ Import Namespace="System.Text" #>
<#@ import namespace="System.Reflection" #>
<#@ Import Namespace="System.Collections.Generic" #>
<#@ Import Namespace="GMF.Component.Tools" #>
<#@ Import Namespace="GMF.Component.Tools.T4" #>
<#@ include file="T4Toolbox.tt" #>
<#@ include file="Include\EntityConfigurationTemplate.tt" #>
<#
    string currentPath = Path.GetDirectoryName(Host.TemplateFile);
    string projectPath =currentPath.Substring(0, currentPath.IndexOf(@"\T4"));
    string solutionPath = currentPath.Substring(0, currentPath.IndexOf(@"\GMF.Demo.Core.Data"));

    string modelFile= Path.Combine(solutionPath, @"GMF.Demo.Core.Models\bin\Debug\GMF.Demo.Core.Models.dll");
    byte[] fileData= File.ReadAllBytes(modelFile);
    Assembly assembly = Assembly.Load(fileData);
    IEnumerable<Type> modelTypes = assembly.GetTypes().Where(m => typeof(Entity).IsAssignableFrom(m) && !m.IsAbstract);
    foreach(Type modelType in modelTypes)
    {
        T4ModelInfo model = new T4ModelInfo(modelType);
        //實體映射類
        EntityConfigurationTemplate config = new EntityConfigurationTemplate(model);
        string path = string.Format(@"{0}\Configurations", projectPath);
        config.Output.Encoding = Encoding.UTF8;
        config.RenderToFile(Path.Combine(path, config.FileName));
    }
#>

　　調用方通過反射從業務實體程序集 GMF.Demo.Core.Models.dll 中獲取所有基類為 Entity 的並且不是抽象類的實體類型信息，再調用模板逐個生成實體配置類文件。

　　例如，生成的登錄記錄信息（LoginLog）的映射文件 LoginLogConfiguration.generated.cs 如下：

//------------------------------------------------------------------------------
// <auto-generated>
//     此代碼由工具生成。
//     對此文件的更改可能會導致不正確的行為，並且如果
//     重新生成代碼，這些更改將會丟失。
//        如存在本生成代碼外的新需求，請在相同命名空間下創建同名分部類實現 LoginLogConfigurationAppend 分部方法。
// </auto-generated>
//
// <copyright file="LoginLogConfiguration.generated.cs">
//        Copyright(c)2013 GMFCN.All rights reserved.
//        CLR版本：4.0.30319.239
//        開發組織：郭明鋒@中國
//        公司網站：http://www.gmfcn.net
//        所屬工程：GMF.Demo.Core.Data
//        生成時間：2013-06-16 17:45
// </copyright>
//------------------------------------------------------------------------------

using System;
using System.Data.Entity.ModelConfiguration;
using System.Data.Entity.ModelConfiguration.Configuration;

using GMF.Component.Data;
using GMF.Demo.Core.Models;


namespace GMF.Demo.Core.Data.Configurations
{
    /// <summary>
    /// 實體類-數據表映射——登錄記錄信息
    /// </summary>    
    internal partial class LoginLogConfiguration : EntityTypeConfiguration<LoginLog>, IEntityMapper
    {
        /// <summary>
        /// 實體類-數據表映射構造函數——登錄記錄信息
        /// </summary>
        public LoginLogConfiguration()
        {
            LoginLogConfigurationAppend();
        }
        
        /// <summary>
        /// 額外的數據映射
        /// </summary>
        partial void LoginLogConfigurationAppend();
        
        /// <summary>
        /// 將當前實體映射對象注冊到當前數據訪問上下文實體映射配置注冊器中
        /// </summary>
        /// <param name="configurations">實體映射配置注冊器</param>
        public void RegistTo(ConfigurationRegistrar configurations)
        {
            configurations.Add(this);
        }
    }
}

　　要配置登錄信息與用戶信息的 N:1 關系，只需要添加一個分部類 LoginLogConfiguration，並實現分類方法 LoginLogConfigurationAppend 即可。

namespace GMF.Demo.Core.Data.Configurations
{
    partial class LoginLogConfiguration
    {
        partial void LoginLogConfigurationAppend()
        {
            HasRequired(m => m.Member).WithMany(n => n.LoginLogs);
        }
    }
}

生成實體倉儲接口

　　實體映射配置類模板 EntityConfigurationTemplate.tt 定義：

<#+
// <copyright file="IEntityRepositoryTemplate.tt" company="郭明鋒@中國">
//  Copyright © 郭明鋒@中國. All Rights Reserved.
// </copyright>

public class IEntityRepositoryTemplate : CSharpTemplate
{
    private T4ModelInfo _model;
        
    public IEntityRepositoryTemplate(T4ModelInfo model)
    {
        _model = model;
    }

    /// <summary>
    /// 獲取 生成的文件名，根據模型名定義
    /// </summary>
    public string FileName
    {
        get
        { 
            return string.Format("I{0}Repository.generated.cs", _model.Name);
        }
    }

    public override string TransformText()
    {
#>
//------------------------------------------------------------------------------
// <auto-generated>
//     此代碼由工具生成。
//     對此文件的更改可能會導致不正確的行為，並且如果
//     重新生成代碼，這些更改將會丟失。
//       如存在本生成代碼外的新需求，請在相同命名空間下創建同名分部類進行實現。
// </auto-generated>
//
// <copyright file="I<#= _model.Name #>Repository.generated.cs">
//        Copyright(c)2013 GMFCN.All rights reserved.
//        CLR版本：4.0.30319.239
//        開發組織：郭明鋒@中國
//        公司網站：http://www.gmfcn.net
//        所屬工程：GMF.Demo.Core.Data
//        生成時間：<#= DateTime.Now.ToString("yyyy-MM-dd HH:mm") #>
// </copyright>
//------------------------------------------------------------------------------

using System;

using GMF.Component.Data;
using GMF.Demo.Core.Models;


namespace GMF.Demo.Core.Data.Repositories
{
    /// <summary>
    ///   數據訪問層接口——<#= _model.Description #>
    /// </summary>
    public partial interface I<#= _model.Name #>Repository : IRepository<<#= _model.Name #>>
    { }
}

<#+
        return this.GenerationEnvironment.ToString();
    }
}
#>

 　　相應的，在調用方 EntityCodeScript.tt 中添加模板調用代碼（如下 11-15 行所示）：

    foreach(Type modelType in modelTypes)
    {
        T4ModelInfo model = new T4ModelInfo(modelType);

        //實體映射類
        EntityConfigurationTemplate config = new EntityConfigurationTemplate(model);
        string path = string.Format(@"{0}\Configurations", projectPath);
        config.Output.Encoding = Encoding.UTF8;
        config.RenderToFile(Path.Combine(path, config.FileName));

        //實體倉儲操作接口
        IEntityRepositoryTemplate irep= new IEntityRepositoryTemplate(model);
        path = string.Format(@"{0}\Repositories", projectPath);
        irep.Output.Encoding = Encoding.UTF8;
        irep.RenderToFile(Path.Combine(path, irep.FileName));
    }

 

　　生成的登錄記錄信息倉儲操作接口 ILoginLogRepository.generated.cs：

//------------------------------------------------------------------------------
// <auto-generated>
//     此代碼由工具生成。
//     對此文件的更改可能會導致不正確的行為，並且如果
//     重新生成代碼，這些更改將會丟失。
//       如存在本生成代碼外的新需求，請在相同命名空間下創建同名分部類進行實現。
// </auto-generated>
//
// <copyright file="ILoginLogRepository.generated.cs">
//        Copyright(c)2013 GMFCN.All rights reserved.
//        CLR版本：4.0.30319.239
//        開發組織：郭明鋒@中國
//        公司網站：http://www.gmfcn.net
//        所屬工程：GMF.Demo.Core.Data
//        生成時間：2013-06-16 17:56
// </copyright>
//------------------------------------------------------------------------------

using System;

using GMF.Component.Data;
using GMF.Demo.Core.Models;


namespace GMF.Demo.Core.Data.Repositories
{
    /// <summary>
    ///   數據訪問層接口——登錄記錄信息
    /// </summary>
    public partial interface ILoginLogRepository : IRepository<LoginLog>
    { }
}

　　如果 IRepository<T> 中定義的倉儲操作不滿足登錄記錄倉儲操作的需求，只需要添加一個相應的分部接口，在其中進行需求的定義即可。這里當前沒有額外的需求，就不需要額外定義了。

生成實體倉儲實現

　　實體倉儲操作的實現與倉儲操作接口類似，這里略過。

　　完成生成后，代碼結構如下所示：

　　如果添加了或者刪除了一個實體，只需要重新運行一下調用模板 EntityCodeScript.tt 即可重新生成新的代碼。

源碼獲取

　　為了讓大家能第一時間獲取到本架構的最新代碼，也為了方便我對代碼的管理，本系列的源碼已加入微軟的開源項目網站 http://www.codeplex.com，地址為：

　　https://gmframework.codeplex.com/

　　可以通過下列途徑獲取到最新代碼：

• 如果你是本項目的參與者，可以通過VS自帶的團隊TFS直接連接到 https://tfs.codeplex.com:443/tfs/TFS17 獲取最新代碼
• 如果你安裝有SVN客戶端（親測TortoiseSVN 1.6.7可用），可以連接到 https://gmframework.svn.codeplex.com/svn 獲取最新代碼
• 如果以上條件都不滿足，你可以進入頁面 https://gmframework.codeplex.com/SourceControl/latest 查看最新代碼，也可以點擊頁面上的 Download 鏈接進行壓縮包的下載，你還可以點擊頁面上的 History 鏈接獲取到歷史版本的源代碼

• 如果你想和大家一起學習MVC，學習EF，歡迎加入Q群：5008599（群發言僅限技術討論，拒絕閑聊，拒絕醬油，拒絕廣告）
• 如果你想與我共同來完成這個開源項目，可以隨時聯系我。

系列導航

1. MVC實用架構設計（〇）——總體設計
2. MVC實用架構設計（一）——項目結構搭建
3. MVC實用架構設計（二）——使用MEF應用IOC
4. MVC實用架構設計（三）——EF-Code First(1)：Repository，UnitOfWork，DbContext
5. MVC實用架構設計（三）——EF-Code First(2)：實體映射、數據遷移，重構
6. MVC實用架構設計（三）——EF-Code First(3)：使用T4模板生成相似代碼
7. MVC實用架構設計（三）——EF-Code First(4)：數據查詢
8. MVC實用架構設計（三）——EF-Code First(5)：二級緩存
9. MVC實體架構設計（三）——EF-Code First(6)：數據更新
10. 未完待續。。。